docker compose: Make it crystal clear that all the GitHub/GitLab user/keys must be set#3300
Merged
sgoggins merged 1 commit intochaoss:mainfrom Oct 9, 2025
Merged
Conversation
…/keys must be set
The non-interactive Docker compose workflow requires all the variables
`AUGUR_GIT{LA,HU}B_{USERNAME,API_KEY}` to be set even if they are going to be
unused, otherwise you get stuck waiting for [the prompt](https://github.com/chaoss/augur/blob/b0bb3b80402ee5fcd84bec7334e58a41f9f5ec8a/scripts/install/config.sh#L18-L29)
```
You entered a blank line, are you sure?
```
Signed-off-by: Mosè Giordano <m.giordano@ucl.ac.uk>
MoralCode
reviewed
Oct 9, 2025
Contributor
MoralCode
left a comment
MoralCode
left a comment
There was a problem hiding this comment.
Appreciate the docs change here - had some small feedback on it but it otherwise looks okay.
Ultimately I think this is something that we should/could also resolve via a code change, potentially as part of improvements to how keys are added/specified, config updates, etc.
Is there an issue filed for this as well so we can fix the underlying behavior?
| .. warning:: | ||
|
|
||
| Don't forget to provide your external database credentials in a file called ``.env`` file. Make sure the following environment variables are specified. | ||
| Don't forget to provide your external database credentials in a file called ``.env`` file. Make sure all the following environment variables are specified, keep placeholder values if you don't need some of them. |
Contributor
There was a problem hiding this comment.
Would it be possible to explain why the placeholders should be kept? (i.e. it will cause things not to start up if one is left unspecified?)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The non-interactive Docker compose workflow requires all the variables
AUGUR_GIT{LA,HU}B_{USERNAME,API_KEY}to be set even if they are going to be unused, otherwise you get stuck waiting for the promptSigned commits