From 2c100f9a888a5824030a01f56dd08f7cfe52265d Mon Sep 17 00:00:00 2001 From: "Sean P. Goggins" Date: Wed, 25 Jun 2025 11:37:27 -0600 Subject: [PATCH] updated for demo Signed-off-by: Sean P. Goggins --- docs/source/getting-started/using-docker.rst | 56 +++++++++++++++++++- 1 file changed, 55 insertions(+), 1 deletion(-) diff --git a/docs/source/getting-started/using-docker.rst b/docs/source/getting-started/using-docker.rst index f7a22a8a0b..ce4e84032f 100644 --- a/docs/source/getting-started/using-docker.rst +++ b/docs/source/getting-started/using-docker.rst @@ -35,4 +35,58 @@ or podman compose up --build -And augur should be up and running! \ No newline at end of file +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 + +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 \ No newline at end of file