Skip to content

Commit 6ec6af7

Browse files
Update readme (#518)
1 parent 539365b commit 6ec6af7

File tree

2 files changed

+18
-4
lines changed

2 files changed

+18
-4
lines changed

Diff for: README.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,11 @@ StepSecurity Harden-Runner addresses this gap by providing security monitoring t
2626
- [Why Choose Harden-Runner](#why-choose-harden-runner)
2727
- [Features and Capabilities](#features)
2828
- [Case Studies and Trusted Projects](#trusted-by-and-case-studies)
29+
- [Environment Compatibility Matrix](#environment-compatibility-matrix)
2930
- [How It Works](docs/how-it-works.md)
3031
- [Known Limitations](docs/limitations.md)
3132
- [Join the Discussions](#discussions)
33+
- [Official Documentation](https://docs.stepsecurity.io/harden-runner)
3234

3335
---
3436

@@ -43,7 +45,7 @@ Learn how Harden-Runner works through the video below, which shows how it detect
4345
---
4446
## Getting Started
4547

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).
4749

4850
### **Step 1: Add Harden-Runner to Your Workflow**
4951

@@ -57,7 +59,7 @@ To integrate Harden-Runner, follow these steps:
5759
with:
5860
egress-policy: audit
5961

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)
6163
<details>
6264
<summary>Click to view the full Getting Started Guide</summary>
6365

@@ -146,6 +148,18 @@ Harden-Runner is trusted by over 5000 leading open-source projects and enterpris
146148

147149
---
148150

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 |
156+
|------------------|---------------|--------------------------|-------------------|
157+
| 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+
149163
## How It Works
150164

151165
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).

Diff for: docs/limitations.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@
99

1010
* Since ARC Harden Runner uses eBPF, only Linux jobs are supported. Windows and MacOS jobs are not supported.
1111

12-
### Self-Hosted VM Runners (e.g. on EC2)
12+
### Self-Hosted VM (e.g. on EC2) and Bare-metal Runners
1313

14-
* Only Ubuntu VM is supported. Windows and MacOS jobs are not supported.
14+
* Only Linux jobs are supported. Windows and MacOS jobs are not supported.

0 commit comments

Comments
 (0)