diff options
| author | Ellie Huxtable <ellie@atuin.sh> | 2026-04-03 00:34:39 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-04-03 00:34:39 +0100 |
| commit | b7ea01b9d990dbc6f3f0fd30246b621943f8b298 (patch) | |
| tree | d78c2180310e8c25ada6eebce450f15ef2a3b021 | |
| parent | feat: Add 'atuin config' subcommand for reading and setting config values (#3... (diff) | |
| download | atuin-b7ea01b9d990dbc6f3f0fd30246b621943f8b298.zip | |
docs: remove docker-compose duplication (#3376)
It does not make sense to have two copies of it to keep in sync
The user needs to read and edit this file anyway, so prefer keeping the
docs copy
resolves #3371
## Checks
- [ ] I am happy for maintainers to push small adjustments to this PR,
to speed up the review cycle
- [ ] I have checked that there are no existing pull requests for the
same thing
| -rw-r--r-- | docker-compose.yml | 25 | ||||
| -rw-r--r-- | docs/docs/self-hosting/docker.md | 19 |
2 files changed, 10 insertions, 34 deletions
diff --git a/docker-compose.yml b/docker-compose.yml deleted file mode 100644 index 939928ab..00000000 --- a/docker-compose.yml +++ /dev/null @@ -1,25 +0,0 @@ -services: - atuin: - restart: always - image: ghcr.io/atuinsh/atuin:<LATEST TAGGED RELEASE> - command: start - volumes: - - "./config:/config" - ports: - - 8888:8888 - environment: - ATUIN_HOST: "0.0.0.0" - ATUIN_OPEN_REGISTRATION: "true" - ATUIN_DB_URI: postgres://{$ATUIN_DB_USERNAME}:${ATUIN_DB_PASSWORD}@db/${ATUIN_DB_NAME} - RUST_LOG: info,atuin_server=debug - depends_on: - - db - db: - image: postgres:14 - restart: unless-stopped - volumes: # Don't remove permanent storage for index database files! - - "./database:/var/lib/postgresql/data/" - environment: - POSTGRES_USER: ${ATUIN_DB_USERNAME} - POSTGRES_PASSWORD: ${ATUIN_DB_PASSWORD} - POSTGRES_DB: ${ATUIN_DB_NAME} diff --git a/docs/docs/self-hosting/docker.md b/docs/docs/self-hosting/docker.md index df8af41f..e6296ff1 100644 --- a/docs/docs/self-hosting/docker.md +++ b/docs/docs/self-hosting/docker.md @@ -20,15 +20,6 @@ docker run -d -v "$CONFIG:/config" ghcr.io/atuinsh/atuin:<LATEST TAGGED RELEASE> Using the already build docker image hosting your own Atuin can be done using the supplied docker-compose file. -Create a `.env` file next to [`docker-compose.yml`](https://github.com/atuinsh/atuin/raw/main/docker-compose.yml) with contents like this: - -```ini -ATUIN_DB_NAME=atuin -ATUIN_DB_USERNAME=atuin -# Choose your own secure password. Stick to [A-Za-z0-9.~_-] -ATUIN_DB_PASSWORD=really-insecure -``` - Create a `docker-compose.yml`: ```yaml @@ -59,6 +50,16 @@ services: POSTGRES_DB: ${ATUIN_DB_NAME} ``` +Create a `.env` file next to `docker-compose.yml` with contents like this: + +```ini +ATUIN_DB_NAME=atuin +ATUIN_DB_USERNAME=atuin +# Choose your own secure password. Stick to [A-Za-z0-9.~_-] +ATUIN_DB_PASSWORD=really-insecure +``` + + Start the services using `docker compose`: ```sh |