Skip to content

Commit

Permalink
Document new directives
Browse files Browse the repository at this point in the history
  • Loading branch information
TheTeaCat committed Jan 15, 2025
1 parent 8dd0e03 commit 3d776e6
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@ You can then configure it using the following directives:
| `firetail_api_token` | `http` | Your API token from the FireTail platform | `PS-02-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` |
| `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` |
| `firetail_enable` | `location` | Use this in every location block for which you want FireTail to be enabled. | This directive takes no arguments. |
| `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` |
| `firetail_allow_undefined_routes` | `http` | If set to `on`, requests to routes not defined in your OpenAPI specification will not be blocked. | `on`, `off` (default) |
| `firetail_redact_request_bodies` | `http` | If set to `on`, request bodies will be redacted in your logs. | `on`, `off` (default) |
| `firetail_redact_response_bodies` | `http` | If set to `on`, response bodies will be redacted in your logs. | `on`, `off` (default) |

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

Expand Down
4 changes: 3 additions & 1 deletion dev/nginx.conf
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ http {
# You should use lua-nginx-module to pull the API token in from an environment variable here
firetail_api_token "YOUR-API-TOKEN";
firetail_url "https://api.logging.eu-west-1.prod.firetail.app/logs/bulk";
firetail_allow_undefined_routes "true";
firetail_allow_undefined_routes on;
firetail_redact_request_bodies off;
firetail_redact_response_bodies off;

server {
listen 80;
Expand Down

0 comments on commit 3d776e6

Please sign in to comment.