From 90a45792309bcc2baec854738a7167fecd352054 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 27 Feb 2026 12:53:59 +0100 Subject: [PATCH] docs(install): Add missing notes for Docker Compose installation (#10192) Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Pepe Fagoaga --- README.md | 18 +++++++----------- .../installation/prowler-app.mdx | 6 ++++++ 2 files changed, 13 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 9e5be11c53..3d1589f6cd 100644 --- a/README.md +++ b/README.md @@ -148,21 +148,17 @@ Prowler App offers flexible installation methods tailored to various environment **Commands** ``` console -curl -LO https://raw.githubusercontent.com/prowler-cloud/prowler/refs/heads/master/docker-compose.yml -curl -LO https://raw.githubusercontent.com/prowler-cloud/prowler/refs/heads/master/.env +VERSION=$(curl -s https://api.github.com/repos/prowler-cloud/prowler/releases/latest | jq -r .tag_name) +curl -sLO "https://raw.githubusercontent.com/prowler-cloud/prowler/refs/tags/${VERSION}/docker-compose.yml" +# Environment variables can be customized in the .env file. Using default values in production environments is not recommended. +curl -sLO "https://raw.githubusercontent.com/prowler-cloud/prowler/refs/tags/${VERSION}/.env" docker compose up -d ``` -> Containers are built for `linux/amd64`. +> [!WARNING] +> 🔒 For a secure setup, the API auto-generates a unique key pair, `DJANGO_TOKEN_SIGNING_KEY` and `DJANGO_TOKEN_VERIFYING_KEY`, and stores it in `~/.config/prowler-api` (non-container) or the bound Docker volume in `_data/api` (container). Never commit or reuse static/default keys. To rotate keys, delete the stored key files and restart the API. -### Configuring Your Workstation for Prowler App - -If your workstation's architecture is incompatible, you can resolve this by: - -- **Setting the environment variable**: `DOCKER_DEFAULT_PLATFORM=linux/amd64` -- **Using the following flag in your Docker command**: `--platform linux/amd64` - -> Once configured, access the Prowler App at http://localhost:3000. Sign up using your email and password to get started. +Once configured, access the Prowler App at http://localhost:3000. Sign up using your email and password to get started. ### Common Issues with Docker Pull Installation diff --git a/docs/getting-started/installation/prowler-app.mdx b/docs/getting-started/installation/prowler-app.mdx index 8b5382f156..a4eb883438 100644 --- a/docs/getting-started/installation/prowler-app.mdx +++ b/docs/getting-started/installation/prowler-app.mdx @@ -23,9 +23,15 @@ Refer to the [Prowler App Tutorial](/user-guide/tutorials/prowler-app) for detai ```bash VERSION=$(curl -s https://api.github.com/repos/prowler-cloud/prowler/releases/latest | jq -r .tag_name) curl -sLO "https://raw.githubusercontent.com/prowler-cloud/prowler/refs/tags/${VERSION}/docker-compose.yml" + # Environment variables can be customized in the .env file. Using default values in production environments is not recommended. curl -sLO "https://raw.githubusercontent.com/prowler-cloud/prowler/refs/tags/${VERSION}/.env" docker compose up -d ``` + + + For a secure setup, the API auto-generates a unique key pair, `DJANGO_TOKEN_SIGNING_KEY` and `DJANGO_TOKEN_VERIFYING_KEY`, and stores it in `~/.config/prowler-api` (non-container) or the bound Docker volume in `_data/api` (container). Never commit or reuse static/default keys. To rotate keys, delete the stored key files and restart the API. + + _Requirements_: