Skip to content

Commit 54b41b1

Browse files
committed
Docs: clean up docker install docs
- move apple silicon specifics from ubuntu to OSX section - fix docker compose commands - adjust heading level for Docker section Signed-off-by: Panni, Lukas <[email protected]>
1 parent f63d9c2 commit 54b41b1

File tree

2 files changed

+17
-16
lines changed

2 files changed

+17
-16
lines changed

docs/dev-osx-install.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -427,12 +427,21 @@ Note: Augur will run on port 5000 by default (you probably need to change that i
427427
## Stopping your Augur Instance
428428
You can stop augur with `augur backend stop`, followed by `augur backend kill`. We recommend waiting 5 minutes between commands so Augur can shutdown more gently. There is no issue with data integrity if you issue them seconds apart, its just that stopping is nicer than killing.
429429

430-
### Docker
430+
## Docker
431431
1. Make sure docker, and docker compose are both installed
432432
2. Modify the `environment.txt` file in the root of the repository to include your GitHub and GitLab API keys.
433433
3. If you are already running postgresql on your server you have two choices:
434434
- Change the port mappings in the `docker-compose.yml` file to match ports for Postgresql not currently in use.
435-
- Change to variables in `environment.txt` to include the correct values for your local, non-docker-container database.
435+
- Change the variables in `environment.txt` to include the correct values for your local, non-docker-container database.
436436
4. `sudo docker build -t augur-new -f docker/backend/Dockerfile .`
437437
5. `sudo docker compose --env-file ./environment.txt --file docker-compose.yml up` to run the database in a Docker Container or
438-
`sudo docker compose --env-file ./environment.txt --file docker-compose.yml up` to connect to an already running database.
438+
`sudo docker compose --env-file ./environment.txt --file docker-compose-externalDB.yml up` to connect to an already running database.
439+
440+
### Possible Apple Silicon Prerequisites:
441+
```bash
442+
brew install libpq
443+
echo 'export LDFLAGS="-L/opt/homebrew/opt/libpq/lib"' >> ~/.zshrc
444+
echo 'export CPPFLAGS="-I/opt/homebrew/opt/libpq/include"' >> ~/.zshrc
445+
```
446+
447+
_Note: `AUGUR\_DB` and `RABBIT\_*` variables are optional when using the default docker-comopse.yml. `docker-compose-externalDB` does require `AUGUR\_DB` set to a postgresql installation._

docs/new-install.md

+5-13
Original file line numberDiff line numberDiff line change
@@ -370,24 +370,16 @@ Note: Augur will run on port 5000 by default (you probably need to change that i
370370
## Stopping your Augur Instance
371371
You can stop augur with `augur backend stop`, followed by `augur backend kill`. We recommend waiting 5 minutes between commands so Augur can shutdown more gently. There is no issue with data integrity if you issue them seconds apart, its just that stopping is nicer than killing.
372372

373-
### Docker
373+
## Docker
374374
*Note: `sudo` is not necessary on OSX or Windows
375375

376376
1. Make sure docker, and docker compose are both installed
377377
2. Modify the `environment.txt` file in the root of the repository to include your GitHub and GitLab API keys.
378378
3. If you are already running postgresql on your server you have two choices:
379379
- Change the port mappings in the `docker-compose.yml` file to match ports for Postgresql not currently in use.
380-
- Change to variables in `environment.txt` to include the correct values for your local, non-docker-container database.
381-
4. `sudo docker build -t augur-new -f docker/backend/Dockerfile .` OSX:
380+
- Change the variables in `environment.txt` to include the correct values for your local, non-docker-container database.
381+
4. `sudo docker build -t augur-new -f docker/backend/Dockerfile .`
382382
5. `sudo docker compose --env-file ./environment.txt --file docker-compose.yml up` to run the database in a Docker Container or
383-
`sudo docker compose --env-file ./environment.txt --file docker-compose.yml up` to connect to an already running database. *Note*: Environment file would be modified to point to an already running database.
383+
`sudo docker compose --env-file ./environment.txt --file docker-compose-externalDB.yml up` to connect to an already running database. *Note*: Environment file would be modified to point to an already running database.
384384

385-
386-
#### Possible Apple Silicon Prerequisites:
387-
```bash
388-
brew install libpq
389-
echo 'export LDFLAGS="-L/opt/homebrew/opt/libpq/lib"' >> ~/.zshrc
390-
echo 'export CPPFLAGS="-I/opt/homebrew/opt/libpq/include"' >> ~/.zshrc
391-
```
392-
393-
_Note: `AUGUR\_DB` and `RABBIT\_*` variables are optional when using the default docker-comopse.yml. `docker-compose-externalDB` does require `AUGUR\_DB` set to a postgresql installation._
385+
_Note: `AUGUR\_DB` and `RABBIT\_*` variables are optional when using the default docker-comopse.yml. `docker-compose-externalDB` does require `AUGUR\_DB` set to a postgresql installation._

0 commit comments

Comments
 (0)