Skip to content

Commit 236daea

Browse files
docs: reorder config sections - custom config before env vars
Custom configuration file is the primary method, environment variables are a convenience layer for simple deployments.
1 parent 5bba64d commit 236daea

File tree

1 file changed

+21
-19
lines changed

1 file changed

+21
-19
lines changed

docker/README.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -26,26 +26,9 @@ docker run -d \
2626

2727
## Configuration
2828

29-
### Environment Variables
30-
31-
The Docker image uses a configuration file optimized for containers with extensive environment variable support:
32-
33-
| Variable | Default | Description |
34-
|----------|---------|-------------|
35-
| `CROWDSEC_KEY` | **required** | API key for CrowdSec LAPI |
36-
| `CROWDSEC_URL` | `http://crowdsec:8080/` | CrowdSec LAPI URL |
37-
| `LOG_MODE` | `stdout` | Log output: `stdout` or `file` |
38-
| `LOG_LEVEL` | `info` | Log level: `trace`, `debug`, `info`, `warn`, `error` |
39-
| `UPDATE_FREQUENCY` | `10s` | How often to poll LAPI for decisions |
40-
| `INSECURE_SKIP_VERIFY` | `false` | Skip TLS verification for LAPI |
41-
| `LISTEN_TCP` | `0.0.0.0:9000` | TCP listener address |
42-
| `PROMETHEUS_ENABLED` | `true` | Enable Prometheus metrics |
43-
| `PROMETHEUS_ADDR` | `0.0.0.0` | Prometheus listen address |
44-
| `PROMETHEUS_PORT` | `6060` | Prometheus listen port |
45-
46-
**Note:** Default values are set in the Docker image. Only `CROWDSEC_KEY` must be provided.
29+
### Custom Configuration File
4730

48-
### Custom Configuration
31+
Mount your own configuration file for full control:
4932

5033
```bash
5134
docker run -d \
@@ -65,6 +48,25 @@ docker run -d \
6548
crowdsecurity/spoa-bouncer -c /config.yaml
6649
```
6750

51+
### Environment Variables
52+
53+
For simple deployments, the default configuration supports environment variables:
54+
55+
| Variable | Default | Description |
56+
|----------|---------|-------------|
57+
| `CROWDSEC_KEY` | **required** | API key for CrowdSec LAPI |
58+
| `CROWDSEC_URL` | `http://crowdsec:8080/` | CrowdSec LAPI URL |
59+
| `LOG_MODE` | `stdout` | Log output: `stdout` or `file` |
60+
| `LOG_LEVEL` | `info` | Log level: `trace`, `debug`, `info`, `warn`, `error` |
61+
| `UPDATE_FREQUENCY` | `10s` | How often to poll LAPI for decisions |
62+
| `INSECURE_SKIP_VERIFY` | `false` | Skip TLS verification for LAPI |
63+
| `LISTEN_TCP` | `0.0.0.0:9000` | TCP listener address |
64+
| `PROMETHEUS_ENABLED` | `true` | Enable Prometheus metrics |
65+
| `PROMETHEUS_ADDR` | `0.0.0.0` | Prometheus listen address |
66+
| `PROMETHEUS_PORT` | `6060` | Prometheus listen port |
67+
68+
**Note:** Default values are set in the Docker image. Only `CROWDSEC_KEY` must be provided.
69+
6870
### Unix Socket (Recommended for Same-Host HAProxy)
6971

7072
```bash

0 commit comments

Comments
 (0)