You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -43,7 +45,7 @@ Learn how Harden-Runner works through the video below, which shows how it detect
43
45
---
44
46
## Getting Started
45
47
46
-
This guide walks you through the steps to set up and use Harden-Runner in your CI/CD workflows.
48
+
This guide walks you through the steps to set up and use Harden-Runner in your CI/CD workflows. For more details, refer to the [official documentation](https://docs.stepsecurity.io/harden-runner).
47
49
48
50
### **Step 1: Add Harden-Runner to Your Workflow**
49
51
@@ -57,7 +59,7 @@ To integrate Harden-Runner, follow these steps:
57
59
with:
58
60
egress-policy: audit
59
61
60
-
**Tip**: Automate this step by pasting your workflow into the [StepSecurity online tool](https://app.stepsecurity.io/secureworkflow)
62
+
**Tip**: Automate this step by pasting your workflow into the [StepSecurity online tool](https://app.stepsecurity.io/secure-workflow)
61
63
<details>
62
64
<summary>Click to view the full Getting Started Guide</summary>
63
65
@@ -146,6 +148,18 @@ Harden-Runner is trusted by over 5000 leading open-source projects and enterpris
146
148
147
149
---
148
150
151
+
## Environment Compatibility Matrix
152
+
153
+
Harden-Runner is designed to work seamlessly across a variety of runner environments, providing consistent security insights and protections regardless of where your workflows execute. For self-hosted runners, audit mode is deployed directly to the runner infrastructure without requiring any changes to your existing workflows. For more details, refer to the [official documentation](https://docs.stepsecurity.io/harden-runner).
154
+
155
+
| Environment Type | Compatibility | Audit Mode Deployment | Workflow Changes for Audit Mode |
| GitHub-hosted runners | ✅ Full support | Add Harden-Runner Action to workflow | Yes |
158
+
| Self-hosted VM runners | ✅ Full support | Include agent in runner image | No |
159
+
| Self-hosted bare-metal runners | ✅ Full support | Install agent as a service | No |
160
+
| Actions Runner Controller (ARC) | ✅ Full support | Deploy as DaemonSet | No |
161
+
| RunsOn Runners | ✅ Full support | Pre-integrated | No |
162
+
149
163
## How It Works
150
164
151
165
Want to know the technical details? Dive into the architecture of Harden-Runner and its integrations for GitHub-hosted and self-hosted runners in our [How Harden-Runner Works Documentation](docs/how-it-works.md).
0 commit comments