1
0
Fork 0
mirror of synced 2026-06-05 17:35:14 +00:00

Compare commits

...

7 commits

Author SHA1 Message Date
Varun Sharma
8500d4b4de
Merge branch 'main' into update-readme-2 2025-03-08 13:25:48 -08:00
Varun Sharma
b8927f9f8b Updates 2025-03-08 10:42:19 -08:00
Varun Sharma
76e6651ae5 Update README.md 2025-03-08 10:20:29 -08:00
Varun Sharma
8bdb08e71c Update README.md 2025-03-06 20:28:27 -08:00
Varun Sharma
e53f5ebd38 Update README.md 2025-03-02 14:54:40 -08:00
Varun Sharma
7898384a7c Update README.md 2025-03-02 14:53:14 -08:00
Varun Sharma
26016a9e85 Update README.md 2025-03-02 14:52:16 -08:00
2 changed files with 18 additions and 4 deletions

View file

@ -26,9 +26,11 @@ StepSecurity Harden-Runner addresses this gap by providing security monitoring t
- [Why Choose Harden-Runner](#why-choose-harden-runner) - [Why Choose Harden-Runner](#why-choose-harden-runner)
- [Features and Capabilities](#features) - [Features and Capabilities](#features)
- [Case Studies and Trusted Projects](#trusted-by-and-case-studies) - [Case Studies and Trusted Projects](#trusted-by-and-case-studies)
- [Environment Compatibility Matrix](#environment-compatibility-matrix)
- [How It Works](docs/how-it-works.md) - [How It Works](docs/how-it-works.md)
- [Known Limitations](docs/limitations.md) - [Known Limitations](docs/limitations.md)
- [Join the Discussions](#discussions) - [Join the Discussions](#discussions)
- [Official Documentation](https://docs.stepsecurity.io/harden-runner)
--- ---
@ -43,7 +45,7 @@ Learn how Harden-Runner works through the video below, which shows how it detect
--- ---
## Getting Started ## Getting Started
This guide walks you through the steps to set up and use Harden-Runner in your CI/CD workflows. 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).
### **Step 1: Add Harden-Runner to Your Workflow** ### **Step 1: Add Harden-Runner to Your Workflow**
@ -57,7 +59,7 @@ To integrate Harden-Runner, follow these steps:
with: with:
egress-policy: audit egress-policy: audit
**Tip**: Automate this step by pasting your workflow into the [StepSecurity online tool](https://app.stepsecurity.io/secureworkflow) **Tip**: Automate this step by pasting your workflow into the [StepSecurity online tool](https://app.stepsecurity.io/secure-workflow)
<details> <details>
<summary>Click to view the full Getting Started Guide</summary> <summary>Click to view the full Getting Started Guide</summary>
@ -146,6 +148,18 @@ Harden-Runner is trusted by over 5000 leading open-source projects and enterpris
--- ---
## Environment Compatibility Matrix
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).
| Environment Type | Compatibility | Audit Mode Deployment | Workflow Changes for Audit Mode |
|------------------|---------------|--------------------------|-------------------|
| GitHub-hosted runners | ✅ Full support | Add Harden-Runner Action to workflow | Yes |
| Self-hosted VM runners | ✅ Full support | Include agent in runner image | No |
| Self-hosted bare-metal runners | ✅ Full support | Install agent as a service | No |
| Actions Runner Controller (ARC) | ✅ Full support | Deploy as DaemonSet | No |
| RunsOn Runners | ✅ Full support | Pre-integrated | No |
## How It Works ## How It Works
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). 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).

View file

@ -9,6 +9,6 @@
* Since ARC Harden Runner uses eBPF, only Linux jobs are supported. Windows and MacOS jobs are not supported. * Since ARC Harden Runner uses eBPF, only Linux jobs are supported. Windows and MacOS jobs are not supported.
### Self-Hosted VM Runners (e.g. on EC2) ### Self-Hosted VM (e.g. on EC2) and Bare-metal Runners
* Only Ubuntu VM is supported. Windows and MacOS jobs are not supported. * Only Linux jobs are supported. Windows and MacOS jobs are not supported.