Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #31

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ Complex CI/CD environments are under increasing threat due to increase in softwa

GitHub hosted runners are a great way to run your CI/CD pipelines. However, they are not without their limitations. One of the most notable limitations is the lack of egress control. This means that any code running on a GitHub hosted runner can make requests to any external service. This can be a security risk, especially when running untrusted code.

## How to use BOLT
[![BOLT by KoalaLab](https://cdn.loom.com/sessions/thumbnails/bf53a52c9dd0421aa9db5beb682b5c34-with-play.gif)](https://www.loom.com/share/bf53a52c9dd0421aa9db5beb682b5c34 "BOLT by KoalaLab")


## Usage
You can start using Bolt by adding the `koalalab-inc/bolt` action as the first step in the jobs you want to monitor. The action will install and start the Bolt service on the runner. Checkout the configuration options and defaults [here](#Configure).

Expand Down Expand Up @@ -160,4 +164,4 @@ Once the job is over, bolt will add a egress traffic report to the job summary.
<a href="https://www.koalalab.com">View detailed analysis of this run on Koalalab!</a>
<hr>

This report was generated using this workflow file: [bolt-sample.yml](examples/bolt.yml)
This report was generated using this workflow file: [bolt-sample.yml](examples/bolt.yml)
Loading