Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fredjeck committed Apr 11, 2024
1 parent 5314d71 commit 8f536d1
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,15 @@ Jarl supports authorization check request using either HTTP (port 8000) or gRPC

# Configuration

At startup Jarl will load all the provided client authorizationf files. Client configurations are simple yaml files defining the paths the client is allowed or denied to access
At startup Jarl will load all the provided client authorizationf files located at **/var/run/jarl/configuation** which shall be provided as a mount point.

Client configurations are simple yaml files defining the paths the client is allowed or denied to access

```yaml
clientID: client # identifier found in the specified header which will be used by Jarl to map the configuration
aliases:
- client.int
- client.dev
mode: allow # allow / deny
paths: # list of paths for this client
- /pokemon/pikachu
Expand All @@ -26,8 +31,20 @@ paths: # list of paths for this client
methods: DELETE
```
## Supported environment variables
```docker
ENV PORT_GRPC=9000 # GRPC port
ENV PORT_HTTP=8000 # HTTP port
ENV AUTHZ_HEADER=x-forwarded-sub # Header element containing authorization element
```

## Modes

For a given client ID Jarl can either work in *deny* or *allow* mode :
- *deny* : will accept all the incoming connections for the specified client except the specified paths and HTTP methods
- *allow* : will deny all the incoming connections excepts for the endpoints specified in the configuration file
- *allow* : will deny all the incoming connections excepts for the endpoints specified in the configuration file

## Health check

Jarl support both standard GRPC health check and HTTP health check at the **/health** url

0 comments on commit 8f536d1

Please sign in to comment.