Skip to content

Commit

Permalink
Docs: clean up docker install docs
Browse files Browse the repository at this point in the history
- 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]>
  • Loading branch information
lpanni committed Feb 4, 2025
1 parent f63d9c2 commit 54b41b1
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 16 deletions.
15 changes: 12 additions & 3 deletions docs/dev-osx-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -427,12 +427,21 @@ Note: Augur will run on port 5000 by default (you probably need to change that i
## Stopping your Augur Instance
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.

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

### Possible Apple Silicon Prerequisites:
```bash
brew install libpq
echo 'export LDFLAGS="-L/opt/homebrew/opt/libpq/lib"' >> ~/.zshrc
echo 'export CPPFLAGS="-I/opt/homebrew/opt/libpq/include"' >> ~/.zshrc
```

_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._
18 changes: 5 additions & 13 deletions docs/new-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -370,24 +370,16 @@ Note: Augur will run on port 5000 by default (you probably need to change that i
## Stopping your Augur Instance
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.

### Docker
## Docker
*Note: `sudo` is not necessary on OSX or Windows

1. Make sure docker, and docker compose are both installed
2. Modify the `environment.txt` file in the root of the repository to include your GitHub and GitLab API keys.
3. If you are already running postgresql on your server you have two choices:
- Change the port mappings in the `docker-compose.yml` file to match ports for Postgresql not currently in use.
- Change to variables in `environment.txt` to include the correct values for your local, non-docker-container database.
4. `sudo docker build -t augur-new -f docker/backend/Dockerfile .` OSX:
- Change the variables in `environment.txt` to include the correct values for your local, non-docker-container database.
4. `sudo docker build -t augur-new -f docker/backend/Dockerfile .`
5. `sudo docker compose --env-file ./environment.txt --file docker-compose.yml up` to run the database in a Docker Container or
`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.
`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.


#### Possible Apple Silicon Prerequisites:
```bash
brew install libpq
echo 'export LDFLAGS="-L/opt/homebrew/opt/libpq/lib"' >> ~/.zshrc
echo 'export CPPFLAGS="-I/opt/homebrew/opt/libpq/include"' >> ~/.zshrc
```

_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._
_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 comments on commit 54b41b1

Please sign in to comment.