Skip to content

docker compose: Make it crystal clear that all the GitHub/GitLab user/keys must be set #3300

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
sgoggins merged 1 commit into from
Oct 9, 2025
Merged

docker compose: Make it crystal clear that all the GitHub/GitLab user/keys must be set #3300

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/source/docker/docker-compose.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ This section of the documentation details how to use Augur's Docker Compose conf

.. 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.
Copy link
Contributor

@MoralCode MoralCode Oct 9, 2025

Choose a reason for hiding this comment

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

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?)

Don't specify AUGUR_DB if you want the docker database to be used.

Example .env:
Expand Down
2 changes: 1 addition & 1 deletion docs/source/docker/getting-started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ the following resources (or more):
- 10 GB RAM

Clone the Augur repository and create a .env file in the top level directory
with the following fields:
with the following fields (don't remove any variable, keep placeholder values if you don't need some of them):

.. code:: python

Expand Down
2 changes: 1 addition & 1 deletion docs/source/docker/quick-start.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Before you get off to such a quick start, go ahead and

git checkout main

4. Create a .env file in the top level directory with the following fields:
4. Create a .env file in the top level directory with the following fields (don't remove any variable, keep placeholder values if you don't need some of them):

.. code:: python

Expand Down
4 changes: 2 additions & 2 deletions docs/source/getting-started/using-docker.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ the following resources (or more).
1. Clone the Augur repository https://github.com/chaoss/augur


2. Create a .env file in the top level directory with the following fields:
2. Create a ``.env`` file in the top level directory with the following fields (don't remove any variable, keep placeholder values if you don't need some of them):

.. code:: python

Expand All @@ -35,7 +35,7 @@ or

podman compose up --build

And augur should be up and running! Over time, you may decide that you want to download and run newer releases of Augur. It is critical that your `.env` file remains configured to use the same database name and password; though you can change the password if you understand how to connect to a database running inside a Docker container on your computer.
And augur should be up and running! Over time, you may decide that you want to download and run newer releases of Augur. It is critical that your ``.env`` file remains configured to use the same database name and password; though you can change the password if you understand how to connect to a database running inside a Docker container on your computer.

Rebuilding Augur in Docker
----------------------------
Expand Down
Loading