Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/configuration-guides/allowlist.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ docker run --rm -it --network api-firewall-network --network-alias api-firewall
-e APIFW_URL=<API_FIREWALL_URL> -e APIFW_SERVER_URL=<PROTECTED_APP_URL> \
-e APIFW_REQUEST_VALIDATION=<REQUEST_VALIDATION_MODE> -e APIFW_RESPONSE_VALIDATION=<RESPONSE_VALIDATION_MODE> \
-e APIFW_ALLOW_IP_FILE=/opt/ip-allowlist.txt -e APIFW_ALLOW_IP_HEADER_NAME="X-Real-IP" \
-p 8088:8088 wallarm/api-firewall:v0.8.6
-p 8088:8088 wallarm/api-firewall:v0.9.1
```

| Environment variable | Description |
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration-guides/dns-cache-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The DNS cache update feature allows you to make asynchronous DNS requests and cache results for a configured period of time. This feature could be useful when DNS load balancing is used.

!!! info "Feature availability"
This feature and corresponding variables are supported only in the [`PROXY`](installation-guides/docker-container.md) API Firewall mode.
This feature and corresponding variables are supported only in the [`PROXY`](../installation-guides/docker-container.md) API Firewall mode.

To configure the DNS cache update, use the following environment variables:

Expand Down
3 changes: 2 additions & 1 deletion docs/installation-guides/api-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Use the following command to run the API Firewall container:

```
docker run --rm -it -v <PATH_TO_SQLITE_DATABASE>:/var/lib/wallarm-api/1/wallarm_api.db \
-e APIFW_MODE=API -p 8282:8282 wallarm/api-firewall:v0.8.6
-e APIFW_MODE=API -p 8282:8282 wallarm/api-firewall:v0.9.1
```

You can pass to the container the following variables:
Expand All @@ -55,6 +55,7 @@ You can pass to the container the following variables:
| `APIFW_WRITE_TIMEOUT` | The timeout for API Firewall to return the response to the request. The default value is `5s`. | No |
| `APIFW_HEALTH_HOST` | The host of the health check service. The default value is `0.0.0.0:9667`. The liveness probe service path is `/v1/liveness` and the readiness service path is `/v1/readiness`. | No |
| `APIFW_API_MODE_DB_VERSION` | Determines the SQLite database version that the API Firewall is configured to use. Available options are:<ul><li>`0` (default) - tries to load V2 (with the `status` field) first; if unsuccessful, attempts V1. On both failures, the firewall fails to start.</li><li>`1` - recognize and process the database as V1 only.</li><li>`2` - recognize and process the database as V2 only.</li></ul> | No |
|`APIFW_API_MODE_MAX_ERRORS_IN_RESPONSE` | Limits the number of errors included in the API Firewall response for a single request validation.<br><br>The default value is `0`, which means no limit is applied.<br><br>Supported starting from version 0.9.1. | No |

## Evaluating requests against the specification

Expand Down
4 changes: 2 additions & 2 deletions docs/installation-guides/docker-container.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ networks:
services:
api-firewall:
container_name: api-firewall
image: wallarm/api-firewall:v0.8.6
image: wallarm/api-firewall:v0.9.1
restart: on-failure
volumes:
- <HOST_PATH_TO_SPEC>:<CONTAINER_PATH_TO_SPEC>
Expand Down Expand Up @@ -169,6 +169,6 @@ To start API Firewall on Docker, you can also use regular Docker commands as in
-v <HOST_PATH_TO_SPEC>:<CONTAINER_PATH_TO_SPEC> -e APIFW_API_SPECS=<PATH_TO_MOUNTED_SPEC> \
-e APIFW_URL=<API_FIREWALL_URL> -e APIFW_SERVER_URL=<PROTECTED_APP_URL> \
-e APIFW_REQUEST_VALIDATION=<REQUEST_VALIDATION_MODE> -e APIFW_RESPONSE_VALIDATION=<RESPONSE_VALIDATION_MODE> \
-p 8088:8088 wallarm/api-firewall:v0.8.6
-p 8088:8088 wallarm/api-firewall:v0.9.1
```
4. When the environment is started, test it and enable traffic on API Firewall following steps 6 and 7.
4 changes: 2 additions & 2 deletions docs/installation-guides/graphql/docker-container.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ networks:
services:
api-firewall:
container_name: api-firewall
image: wallarm/api-firewall:v0.8.6
image: wallarm/api-firewall:v0.9.1
restart: on-failure
volumes:
- <HOST_PATH_TO_SPEC>:<CONTAINER_PATH_TO_SPEC>
Expand Down Expand Up @@ -200,6 +200,6 @@ To start API Firewall on Docker, you can also use regular Docker commands as in
-e APIFW_GRAPHQL_MAX_QUERY_COMPLEXITY=<MAX_QUERY_COMPLEXITY> \
-e APIFW_GRAPHQL_MAX_QUERY_DEPTH=<MAX_QUERY_DEPTH> -e APIFW_GRAPHQL_NODE_COUNT_LIMIT=<NODE_COUNT_LIMIT> \
-e APIFW_GRAPHQL_INTROSPECTION=<ALLOW_INTROSPECTION_OR_NOT> \
-p 8088:8088 wallarm/api-firewall:v0.8.6
-p 8088:8088 wallarm/api-firewall:v0.9.1
```
4. When the environment is started, test it and enable traffic on API Firewall following steps 6 and 7.
4 changes: 2 additions & 2 deletions docs/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ This page describes new releases of Wallarm API Firewall.

## v0.9.1 (2025-04-23)

* Added the `APIFW_API_MODE_MAX_ERRORS_IN_RESPONSE` [environment variable to limit the number of returned validation errors](installation-guides/api-mode.md#running-the-api-firewall-container) in the `API` mode
* Fixed the `related_fields_details` field issues in the `API` mode
* Dependency upgrade
* Add APIFW_API_MODE_MAX_ERRORS_IN_RESPONSE param to limit the response size in API mode
* Fix related_fields_details field issue in API mode

## v0.9.0 (2025-04-04)

Expand Down