Skip to content

Docs/add env variable comments#190

Closed
Fbartoli wants to merge 2 commits intosafe-global:mainfrom
Fbartoli:docs/add-env-variable-comments
Closed

Docs/add env variable comments#190
Fbartoli wants to merge 2 commits intosafe-global:mainfrom
Fbartoli:docs/add-env-variable-comments

Conversation

@Fbartoli
Copy link
Contributor

@Fbartoli Fbartoli commented Jan 4, 2026

Note

Provides clearer environment configuration across services with documented examples and local-dev defaults.

  • New .env.sample with annotated sections (RPC, ports, service versions) and example values
  • Major rewrite of container_env_files/cgw.env: extensive comments, optional feature flags, Redis/AMQP/CORS settings, Safe Config URL, and required dummy secrets/keys for local development
  • Expanded container_env_files/txs.env: detailed comments, DEBUG/log level, DB/Redis/Celery URLs, CSRF/hosts, and events queue settings
  • Updated container_env_files/ui.env: adds WalletConnect/project flags, Mixpanel tokens, local CGW URLs, ESLint disable flag, and optional wallet keys

Written by Cursor Bugbot for commit 0bf7657. This will update automatically on new commits. Configure here.

SafeFB and others added 2 commits December 17, 2025 18:03
- Add comprehensive comments to txs.env explaining all variables
- Add detailed comments to cgw.env for variables without documentation
- Document purpose, format, and production security considerations
- Update nginx.conf and ui.env with necessary configurations
@Fbartoli Fbartoli requested review from a team, Uxio0, falvaradorodriguez and moisses89 and removed request for a team January 4, 2026 11:52
@github-actions
Copy link

github-actions bot commented Jan 4, 2026

CLA Assistant Lite bot:
Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.


I have read the CLA Document and I hereby sign the CLA


1 out of 2 committers have signed the CLA.
@Fbartoli
❌ @SafeFB
SafeFB seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You can retrigger this bot by commenting recheck in this Pull Request

Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR is being reviewed by Cursor Bugbot

Details

Your team is on the Bugbot Free tier. On this plan, Bugbot will review limited PRs each billing cycle for each member of your team.

To receive Bugbot reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.

DEBUG=0

# Django debug mode - enables detailed error pages (set to 0 in production)
DEBUG=1
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Debug mode enabled contradicts production settings and comment

The DEBUG value was changed from 0 to 1, which directly contradicts the comment on line 11 that says "set to 0 in production" and conflicts with DJANGO_SETTINGS_MODULE=config.settings.production. Enabling Django debug mode exposes detailed error pages with sensitive information like stack traces, local variables, and configuration settings. This appears to be accidentally committed debug configuration that wasn't reverted before merging.

Fix in Cursor Fix in Web

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Fbartoli Please, could you review it? I agree with the Cursor comment


# Authentication & Security
# Authorization token for privileged endpoints - MUST be changed in production
AUTH_TOKEN=local_development_token
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Auth tokens between services no longer match

The AUTH_TOKEN in cgw.env was changed from your_privileged_endpoints_token to local_development_token, but the corresponding CGW_AUTH_TOKEN in cfg.env still has the value your_privileged_endpoints_token. According to the documentation, these tokens must match for the Config Service to authenticate with the Client Gateway. This mismatch will cause webhook authentication failures between services, breaking cache invalidation functionality.

Fix in Cursor Fix in Web

@Fbartoli Fbartoli closed this Mar 2, 2026
@Fbartoli Fbartoli deleted the docs/add-env-variable-comments branch March 2, 2026 10:42
@github-actions github-actions bot locked and limited conversation to collaborators Mar 2, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants