Skip to content

Commit

Permalink
Add How it works section to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lewispb committed May 7, 2024
1 parent 22d0eb8 commit 388f906
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ attack.

<img width="952" alt="Screenshot of Mission Control - Web admin UI" src="https://github.com/basecamp/mission_control-web/assets/1773614/5c75a304-820e-4151-882e-f0782211356c">

## How it works

Mission Control - Web can be configured via the admin interface to block requests whose path matched a regex pattern. If
the requested path matches any "Denied" path, it will be blocked with a 503 HTTP status code.

## Usage

You can choose to deploy Mission Control - Web admin and middleware both in the same Rails app, or two separate apps, a
Expand Down Expand Up @@ -100,4 +105,5 @@ If Redis is down (or raises any instance of Redis::BaseConnectionError), Mission
It's recommended to also consider using a resilient Redis client with a circuit-breaker. See [Semian](https://github.com/Shopify/semian).

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

0 comments on commit 388f906

Please sign in to comment.