Skip to content

Commit 5d5abc9

Browse files
committed
Doc firetail_enable directive
1 parent e41076e commit 5d5abc9

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,14 @@ To setup the Firetail NGINX Module, you will need to modify your `nginx.conf` to
2929
load_module modules/ngx_firetail_module.so;
3030
```
3131

32-
You can then configure it using the following directives, which all belong in the `http` block of your NGINX configuration:
33-
34-
| Directive | Description | Example |
35-
| --------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
36-
| `firetail_api_token` | Your API token from the FireTail platform | `PS-02-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` |
37-
| `firetail_url` | The URL of the API endpoint the FireTail NGINX module will send logs to. | `https://api.logging.eu-west-1.prod.firetail.app/logs/bulk` |
38-
| `firetail_allow_undefined_routes` | If set to `1`, `t`, `T`, `TRUE`, `true`, or `True`, requests to routes not defined in your OpenAPI specification will not be blocked. | `1`, `t`, `T`, `TRUE`, `true`, `True`, `0`, `f`, `F`, `FALSE`, `false`, `False` |
32+
You can then configure it using the following directives:
33+
34+
| Directive | Valid in | Description | Example Arguments |
35+
| --------------------------------- | ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
36+
| `firetail_api_token` | `http` | Your API token from the FireTail platform | `PS-02-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` |
37+
| `firetail_url` | `http` | The URL of the API endpoint the FireTail NGINX module will send logs to. | `https://api.logging.eu-west-1.prod.firetail.app/logs/bulk` |
38+
| `firetail_enable` | `location` | Use this in every location block for which you want FireTail to be enabled. | This directive takes no arguments. |
39+
| `firetail_allow_undefined_routes` | `http` | If set to `1`, `t`, `T`, `TRUE`, `true`, or `True`, requests to routes not defined in your OpenAPI specification will not be blocked. | `1`, `t`, `T`, `TRUE`, `true`, `True`, `0`, `f`, `F`, `FALSE`, `false`, `False` |
3940

4041
See [dev/nginx.conf](./dev/nginx.conf) for an example of these in use.
4142

0 commit comments

Comments
 (0)