Use the Allure Report Storage service with Docker or Docker Compose.
- Learn more about Allure Report at https://allurereport.org
- 📚 Documentation – discover official documentation for Allure Report
- ❓ Questions and Support – get help from the team and community
- 📢 Official annoucements – be in touch with the latest updates
- 💬 General Discussion – engage in casual conversations, share insights and ideas with the community
- Docker
- Docker Compose
-
Add the required env vars directly in
compose.yaml(or override them there); the compose file already defines defaults forACCESS_TOKENandSECRET. -
ACCESS_TOKENis the bootstrap bearer token forPOST /api/token. -
SECRETis the signing secret for generated access tokens. -
Start the service:
docker compose up --build
Use STORAGE_BACKEND=s3 env variable if you want to use S3 storage instead of file system with:
STORAGE_BACKEND=s3
S3_BUCKET=allure-report-storage
S3_REGION=us-east-1
S3_ENDPOINT=http://localhost:9000
S3_ACCESS_KEY_ID=minioadmin
S3_SECRET_ACCESS_KEY=minioadmin
S3_FORCE_PATH_STYLE=trueRequired vars: S3_BUCKET, S3_REGION, S3_ENDPOINT, S3_ACCESS_KEY_ID, S3_SECRET_ACCESS_KEY, S3_FORCE_PATH_STYLE.
If S3_ACCESS_KEY_ID / S3_SECRET_ACCESS_KEY are not set, the AWS SDK default credential provider chain is used.
Optional vars: S3_PREFIX, S3_REPORTS_PREFIX, S3_ASSETS_PREFIX, S3_SESSION_TOKEN.
For Cloudflare R2, use S3_REGION=auto, S3_ENDPOINT=https://<cloudflare-account-id>.r2.cloudflarestorage.com, and S3_FORCE_PATH_STYLE=false.
Bucket-specific R2 endpoints are normalized internally.
Automated retention can delete old reports to reduce disk or S3 storage costs. It is disabled by default and enabled only when at least one env var is set:
REPORT_RETENTION_MAX_REPORTS_PER_BRANCH=20
REPORT_RETENTION_MAX_REPORT_AGE_DAYS=30REPORT_RETENTION_MAX_REPORTS_PER_BRANCH: keep newest completed reports per branch up to this positive integer limit, delete older ones.REPORT_RETENTION_MAX_REPORT_AGE_DAYS: delete reports older than this positive number of days. The newest completed report per branch is always preserved.
Both strategies can be enabled together. The Docker service runs retention after report completion and on an hourly background sweep. Retention does not change public history download limits or manual delete behavior.
curl http://localhost:3000/api/ping