From da89d21332126f7c9f1467b31650fa27feb60d7d Mon Sep 17 00:00:00 2001 From: Norm Date: Sun, 6 Aug 2023 09:22:11 -0400 Subject: [PATCH] Add docker-compose.yml to gitignore The docker-compose.yml file is likely to be edited quite extensively by admins when setting up an instance. To make it easier to do upgrades down the line, it should be ignored by git. Instead we should provide the existing docker-compose.yml as a sample config and update the docs to have the user copy it over to the root directory to edit it themselves. --- .gitignore | 1 + docker-compose.yml => docker-resources/docker-compose.yml | 0 docs/docs/installation/docker_en.md | 5 +++++ docs/docs/installation/migrating_to_docker_en.md | 5 +++++ 4 files changed, 11 insertions(+) rename docker-compose.yml => docker-resources/docker-compose.yml (100%) diff --git a/.gitignore b/.gitignore index 8821d8ce1..b271fdb22 100644 --- a/.gitignore +++ b/.gitignore @@ -78,3 +78,4 @@ docs/venv # docker stuff docker-db *.iml +docker-compose.yml diff --git a/docker-compose.yml b/docker-resources/docker-compose.yml similarity index 100% rename from docker-compose.yml rename to docker-resources/docker-compose.yml diff --git a/docs/docs/installation/docker_en.md b/docs/docs/installation/docker_en.md index 52c056173..12f0b60f8 100644 --- a/docs/docs/installation/docker_en.md +++ b/docs/docs/installation/docker_en.md @@ -28,6 +28,11 @@ echo "DOCKER_USER=$(id -u):$(id -g)" >> .env This probably won't need to be changed, it's only there to set basic environment variables for the docker compose file. +Next, copy over the `docker-compose.yml` file to the main directory: +```bash +cp docker-resources/docker-compose.yml docker-compose.yml +``` + ### Building the container The container provided is a thin wrapper around akkoma's dependencies, diff --git a/docs/docs/installation/migrating_to_docker_en.md b/docs/docs/installation/migrating_to_docker_en.md index 6a67f1eee..7b8464724 100644 --- a/docs/docs/installation/migrating_to_docker_en.md +++ b/docs/docs/installation/migrating_to_docker_en.md @@ -28,6 +28,11 @@ git clone https://akkoma.dev/AkkomaGang/akkoma.git -b stable cd akkoma ``` +Copy `docker-compose.yml` over to the root directory +```bash +cp docker-resources/docker-compose.yml docker-compose.yml +``` + ### Back up your old database Change the database name as needed