[doc-wallarm-mode]: ../../../admin-en/configure-parameters-en.md#wallarm_mode[doc-config-params]: ../../../admin-en/configure-parameters-en.md[waf-mode-instr]: ../../../admin-en/configure-wallarm-mode.md[logging-instr]: ../../../admin-en/configure-logging.md[proxy-balancer-instr]: ../../../admin-en/using-proxy-or-balancer-en.md[process-time-limit-instr]: ../../../admin-en/configure-parameters-en.md#wallarm_process_time_limit[allocating-memory-guide]: ../../../admin-en/configuration-guides/allocate-resources-for-node.md[nginx-waf-directives]: ../../../admin-en/configure-parameters-en.md[graylist-docs]: ../../../user-guides/ip-lists/overview.md[filtration-modes-docs]: ../../../admin-en/configure-wallarm-mode.md[application-configuration]: ../../../user-guides/settings/applications.md[ptrav-attack-docs]: ../../../attacks-vulns-list.md#path-traversal[attacks-in-ui-image]: ../../../images/admin-guides/test-attacks-quickstart.png[versioning-policy]: ../../../updating-migrating/versioning-policy.md#version-list[node-status-docs]: ../../../admin-en/configure-statistics-service.md[node-token]: ../../../quickstart.md#deploy-the-wallarm-filtering-node[api-token]: ../../../user-guides/settings/api-tokens.md[wallarm-token-types]: ../../../user-guides/nodes/nodes.md#api-and-node-tokens-for-node-creation[platform]: ../../supported-deployment-options.md[oob-advantages-limitations]: ../overview.md#limitations[web-server-mirroring-examples]: overview.md#configuration-examples-for-traffic-mirroring[memory-instr]: ../../../admin-en/configuration-guides/allocate-resources-for-node.md[ip-lists-docs]: ../../../user-guides/ip-lists/overview.md[aws-ecs-docs]: ../../cloud-platforms/aws/docker-container.md[gcp-gce-docs]: ../../cloud-platforms/gcp/docker-container.md[azure-container-docs]: ../../cloud-platforms/azure/docker-container.md[alibaba-ecs-docs]: ../../cloud-platforms/alibaba-cloud/docker-container.md[api-policy-enf-docs]: ../../../api-specification-enforcement/overview.md[link-wallarm-health-check]: ../../../admin-en/uat-checklist-en.md# DockerイメージからWallarm OOBをデプロイするこの記事では、[Wallarm OOB](overview.md)を[NGINXベースのDockerイメージ](https://hub.docker.com/r/wallarm/node)を使用してデプロイする手順を案内します。ここで説明するソリューションは、Webサーバまたはプロキシサーバからミラーされたトラフィックの解析を目的としております。
## ユースケースAmong all supported [Wallarm deployment options][platform], NGINX-based Docker image is recommended for Wallarm deployment in these **use cases**:
*If your organization utilizes Docker-based infrastructure, Wallarm Docker image is the ideal choice. It integrates effortlessly into your existing setup, whether you are employing a microservice architecture running on AWS ECS, Alibaba ECS, or other similar services. This solution also applies to those using virtual machines seeking a more streamlined management through Docker containers.
*If you require fine-grained control over each container, the Docker image excels. It affords a greater level of resource isolation than typically possible with traditional VM-based deployments.
For more information on running Wallarm's NGINX-based Docker image on popular public cloud container orchestration services, refer to our guides: [AWS ECS][aws-ecs-docs], [GCP GCE][gcp-gce-docs], [Azure Container Instances][azure-container-docs], [Alibaba ECS][alibaba-ecs-docs].
## 動作要件*[Docker](https://docs.docker.com/engine/install/) installed on your host system
*Access to `https://hub.docker.com/r/wallarm/node` to download the Docker image. Please ensure the access is not blocked by a firewall
*Access to the account with the **Administrator** role in Wallarm Console in the [US Cloud](https://us1.my.wallarm.com/) or [EU Cloud](https://my.wallarm.com/)
*Access to `https://us1.api.wallarm.com` if working with US Wallarm Cloud or to `https://api.wallarm.com` if working with EU Wallarm Cloud. Please ensure the access is not blocked by a firewall
*Access to the IP addresses below for downloading updates to attack detection rules and [API specifications][api-policy-enf-docs], as well as retrieving precise IPs for your [allowlisted, denylisted, or graylisted][ip-lists-docs] countries, regions, or data centers
=== "US Cloud"
``` 34.96.64.17 34.110.183.149 35.235.66.155 34.102.90.100 34.94.156.115 35.235.115.105 ``` === "EU Cloud"
``` 34.160.38.183 34.144.227.90 34.90.110.226 ```## 1. トラフィックミラーリングの設定Configure your environment to mirror incoming traffic to an instance with the Wallarm node you are deploying. For configuration details, we recommend to refer to documentation on the solution you are going to use to produce the traffic mirror (web server, proxy server, etc.).
Inside the [link][web-server-mirroring-examples], you will find the example configuration for NGINX, Traefik, Envoy.
## 2. ミラーリングされたトラフィック解析等のための設定ファイルを用意するWallarmノードがミラーリングされたトラフィックを解析できるように、別途ファイルに追加設定を行い、Dockerコンテナにマウントする必要があります。変更が必要なデフォルトの設定ファイルは、Dockerイメージ内の`/etc/nginx/sites-enabled/default`に配置されております。
このファイル内で、ミラーリングされたトラフィックを処理するためのWallarmノードの設定およびその他必要な設定を指定する必要があります。以下の手順に従ってください。
1. 以下の内容で`default`という名前のローカルNGINX設定ファイルを作成します。
``` server { listen 80 default_server; listen [::]:80 default_server ipv6only=on; #listen 443 ssl; server_name localhost; #ssl_certificate cert.pem; #ssl_certificate_key cert.key; root /usr/share/nginx/html; index index.html index.htm; wallarm_force server_addr $http_x_server_addr; wallarm_force server_port $http_x_server_port; # Change 222.222.222.22 to the address of the mirroring server set_real_ip_from 222.222.222.22; real_ip_header X-Forwarded-For; real_ip_recursive on; wallarm_force response_status 0; wallarm_force response_time 0; wallarm_force response_size 0; wallarm_mode monitoring; location / { proxy_pass http://example.com; include proxy_params; } } ```*`set_real_ip_from`および`real_ip_header`ディレクティブは、Wallarm Consoleが[攻撃者のIPアドレスを表示][proxy-balancer-instr]するために必要です。
*`wallarm_force_response_*`ディレクティブは、ミラーされたトラフィックから受け取ったコピー以外の全リクエストの解析を無効にするために必要です。
*`wallarm_mode`ディレクティブはトラフィック解析の[モード][waf-mode-instr]です。悪意のあるリクエストを遮断できないため、Wallarmが受け入れる唯一のモードはmonitoringです。インライン展開の場合、安全ブロッキングおよびブロッキングモードも存在しますが、`wallarm_mode`ディレクティブにmonitoring以外の値を設定しても、ノードはトラフィックの監視を続け、悪意のあるトラフィックのみを記録します（offに設定した場合を除く）。
1. その他必要なWallarmディレクティブを指定します。[Wallarm設定パラメーター](../../../admin-en/configure-parameters-en.md)のドキュメントや[設定ユースケース](#configuring-the-use-cases)を参照して、利用に適した設定を確認してください。
1. 必要に応じて、他のNGINX設定を変更して動作をカスタマイズしてください。サポートが必要な場合は、[NGINXドキュメント](https://nginx.org/en/docs/beginners_guide.html)をご参照ください。
以下のコンテナディレクトリに他のファイルをマウントすることも可能です。
*`/etc/nginx/conf.d` — 共通の設定
*`/etc/nginx/sites-enabled` — 仮想ホストの設定
*`/opt/wallarm/usr/share/nginx/html` — 静的ファイル
## 3. Cloudへのノード接続用トークンを取得する[該当タイプのWallarmトークン][wallarm-token-types]を取得します。
=== "API token"
1. Wallarm Console → **Settings** → **API tokens**を[US Cloud](https://us1.my.wallarm.com/settings/api-tokens)または[EU Cloud](https://my.wallarm.com/settings/api-tokens)で開きます。
1.`Deploy`ソースロールを持つAPI tokenを見つけるか作成します。
1. このトークンをコピーします。
=== "Node token"
1. Wallarm Console → **Nodes**を[US Cloud](https://us1.my.wallarm.com/nodes)または[EU Cloud](https://my.wallarm.com/nodes)で開きます。
1. 以下のいずれかを実行します:
***Wallarm node**タイプのノードを作成し、生成されたトークンをコピーします。
*既存のノードグループを利用 – ノードのメニュー → **Copy token**でトークンをコピーします。
## 4. ノード付きのDockerコンテナを実行する先ほど作成した設定ファイルを[マウント](https://docs.docker.com/storage/volumes/)して、ノード付きのDockerコンテナを実行します。
=== "US Cloud"
```bashdockerrun-d-eWALLARM_API_TOKEN='XXXXXXX'-eWALLARM_LABELS='group=<GROUP>'-eWALLARM_API_HOST='us1.api.wallarm.com'-v/configs/default:/etc/nginx/sites-enabled/default-p80:80wallarm/node:5.3.0
```=== "EU Cloud"
```bashdockerrun-d-eWALLARM_API_TOKEN='XXXXXXX'-eWALLARM_LABELS='group=<GROUP>'-v/configs/default:/etc/nginx/sites-enabled/default-p80:80wallarm/node:5.3.0
```以下の環境変数をコンテナに渡す必要があります:
Environment variable | Description| Required
--- | ---- | ----
`WALLARM_API_TOKEN` | Wallarm node or API token. | Yes
`WALLARM_API_HOST` | Wallarm API server:<ul><li>`us1.api.wallarm.com` for the US Cloud</li><li>`api.wallarm.com` for the EU Cloud</li></ul>By default: `api.wallarm.com`. | No
`WALLARM_LABELS` | <p>Available starting from node 4.6. Works only if `WALLARM_API_TOKEN` is set to [API token][api-token] with the `Deploy` role. Sets the `group` label for node instance grouping, for example:</p> <p>`WALLARM_LABELS="group=<GROUP>"`</p> <p>...will place node instance into the `<GROUP>` instance group (existing, or, if does not exist, it will be created).</p> | Yes (for API tokens)
`SLAB_ALLOC_ARENA` (`TARANTOOL_MEMORY_GB` [NGINX Node 5.x and earlier][what-is-new-wstore]) | [Amount of memory][allocating-memory-guide] allocated to wstore. The value can be a float (a dot <code>.</code> is a decimal separator). By default: 1.0 (1 gygabyte). | No
`WALLARM_APID_ONLY` (5.3.7 and higher) | In this mode, attacks detected in your traffic are blocked locally by the node (if [enabled][filtration-modes]) but not exported to Wallarm Cloud. Meanwhile, [API Discovery][api-discovery-docs] and some other features remain fully functional, detecting your API inventory and uploading it to the Cloud for visualization. This mode is for those who want to review their API inventory and identify sensitive data first, and plan controlled attack data export accordingly. However, disabling attack export is rare, as Wallarm securely processes attack data and provides [sensitive attack data masking][sensitive-data-rule] if needed. [More details][apid-only-mode-details]<br>By default: `false`. | No
## 5. Wallarmノードの動作確認1. Send the request with test [Path Traversal][ptrav-attack-docs] attack to a protected resource address:
``` curl http://localhost/etc/passwd ``` If traffic is configured to be proxied to `example.com`, include the `-H "Host: example.com"` header in the request.
1. Open Wallarm Console → **Attacks** section in the [US Cloud](https://us1.my.wallarm.com/search) or [EU Cloud](https://my.wallarm.com/search) and make sure the attack is displayed in the list.
![Attacks in the interface][attacks-in-ui-image]
1. Optionally, [test][link-wallarm-health-check] other aspects of the node functioning.
## ログ設定ログはデフォルトで有効になっております。ログディレクトリは以下の通りです:
*`/var/log/nginx` — NGINXログ
*`/opt/wallarm/var/log/wallarm` — [Wallarmノードのログ][logging-instr]
## 設定ユースケースの設定Dockerコンテナにマウントされた設定ファイルは、[利用可能なディレクティブ](../../../admin-en/configure-parameters-en.md)に基づくフィルタリングノードの設定を記述する必要があります。以下は、よく使用されるフィルタリングノードの設定オプションの例です:
*[Allocating resources for Wallarm nodes][memory-instr]
*[Logging Wallarm node variables][logging-instr]
*[Using the balancer of the proxy server behind the filtering node][proxy-balancer-instr]
*[Limiting the single request processing time in the directive `wallarm_process_time_limit`][process-time-limit-instr]
*[Limiting the server reply waiting time in the NGINX directive `proxy_read_timeout`](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_read_timeout)
*[Limiting the maximum request size in the NGINX directive `client_max_body_size`](https://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size)