Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
utibeabasi6 committed Oct 18, 2024
1 parent f35d409 commit 18858a6
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,18 @@

Aegis is designed to be simple and highly configurable. Once running, you can define custom rules for rate limiting, request filtering, and traffic monitoring.

### Installation

Install the latest version of Aegis by running the following command
```shell
cargo install aegis-waf
```

Start aegis by running
```shell
aegis --config-file /path/to/your/config.yaml
```

### Example Config
```yaml
upstream: "http://localhost:8000"
Expand All @@ -56,13 +68,13 @@ rules:
statements:
- inspect:
Header:
key: "custom"
key: "hello"
negate_statement: false
match_type: "Contains"
match_string: "hello"
match_string: "world"
```

This rule only allows requests which have a header named `custom` set to `hello`. For a description of the various fields, please refer to this [document](./documentation/config.md).
This rule only allows requests which have a header named `hello` set to `world`. For a description of the various fields, please refer to this [document](./documentation/config.md).

## Contributing

Expand Down

0 comments on commit 18858a6

Please sign in to comment.