Skip to content

Document the environment variable pass-through prefix option introduced by #382 #395

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
reivilibre merged 2 commits into from
Jun 16, 2022
Merged

Document the environment variable pass-through prefix option introduced by #382 #395

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
735ca88
Document the env prefix option introduced by #382
reivilibre Jun 14, 2022
d252ebf
Move doc to 'Running' section
reivilibre Jun 16, 2022
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
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ options will work, so to just run 1 named test and include a timeout for the tes
$ COMPLEMENT_BASE_IMAGE=complement-dendrite:latest go test -timeout 30s -run '^(TestOutboundFederationSend)$' -v ./tests/...
```

If you need to pass environment variables to the image under test, you can:
1. define a pass-through prefix with e.g. `COMPLEMENT_SHARE_ENV_PREFIX=PASS_`; then
2. prefix the desired environment variables with that prefix; e.g. `PASS_SYNAPSE_COMPLEMENT_USE_WORKERS=true`.


### Potential conflict with firewall software

The homeserver in the test image needs to be able to make requests to the mock
Expand Down