Skip to content

Updated the Docker documentation for CHAOSSCON #3197

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
Jun 25, 2025
Merged

Updated the Docker documentation for CHAOSSCON #3197

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
56 changes: 55 additions & 1 deletion docs/source/getting-started/using-docker.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,58 @@ or

podman compose up --build

And augur should be up and running!
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
----------------------------
We do not recommend running the augur database in a Docker container in production, though for light installations (~ < 2,000 repos) it is OK as long as you understand that your data exists inside of a Docker container, and you will **need to back that up** if you want to avoid data loss.

You can identify the physical location of your Docker database file system using these commands:

.. code:: shell

docker volume ls
docker volume inspect <volume_name>

For example:

.. code:: shell

➜ augur-demo git:(docker-docs-patch-12) ✗ docker volume inspect augur-demo_augurpostgres
[
{
"CreatedAt": "2025-06-25T16:19:20Z",
"Driver": "local",
"Labels": {
"com.docker.compose.config-hash": "5aae21cec561d5da3e9a0b92ccab7470394b21cf473803bd85055c4589535355",
"com.docker.compose.project": "augur-demo",
"com.docker.compose.version": "2.37.1",
"com.docker.compose.volume": "augurpostgres"
},
"Mountpoint": "/var/lib/docker/volumes/augur-demo_augurpostgres/_data",
"Name": "augur-demo_augurpostgres",
"Options": null,
"Scope": "local"
}
]

To rebuild a fresh Augur database in Docker, follow these steps:

1. **Stop the running containers** (if any):

.. code:: shell

docker compose down

2. **Remove the existing database volumes and containers** to clear all data:

.. code:: shell

docker system prune -af
docker volume prune -af

3. **Rebuild and start the containers**:

.. code:: shell

docker compose up --build
Loading