From f73d13dd77a736e97e6cce75b3fae89a42544307 Mon Sep 17 00:00:00 2001 From: Laura Hausmann Date: Wed, 6 Sep 2023 18:23:41 +0200 Subject: [PATCH] Move docker-compose example file to docs/examples --- .gitignore | 2 +- docs/docker-compose-install.md | 4 ++-- .../examples/docker-compose.yml | 0 3 files changed, 3 insertions(+), 3 deletions(-) rename docker-compose.yml.example => docs/examples/docker-compose.yml (100%) diff --git a/.gitignore b/.gitignore index 77b6c8073..e86b4a6c9 100644 --- a/.gitignore +++ b/.gitignore @@ -30,7 +30,7 @@ coverage # docker configs /dev/docker-compose.yml -docker-compose.yml +/docker-compose.yml # misskey built diff --git a/docs/docker-compose-install.md b/docs/docker-compose-install.md index bb126494f..28d2f902a 100644 --- a/docs/docker-compose-install.md +++ b/docs/docker-compose-install.md @@ -6,11 +6,11 @@ This guide is based on `docker compose`/Docker Compose v2, but `docker-compose`/ ### Getting needed files -Run `git clone https://iceshrimp.dev/iceshrimp/iceshrimp`, but if you are not planning on building your own image, just grabbing `.config` and `docker-compose.yml.example` from the repo will suffice. +Run `git clone https://iceshrimp.dev/iceshrimp/iceshrimp`, but if you are not planning on building your own image, just grabbing `.config` and `docs/examples/docker-compose.yml` from the repo will suffice. ### docker-compose.yml -First, run `cp docker-compose.yml.example docker-compose.yml`, and edit `docker-compose.yml` if +First, run `cp docs/examples/docker-compose.yml docker-compose.yml`, and edit `docker-compose.yml` if - you want to build the image yourself or choose a [different tag](https://iceshrimp.dev/iceshrimp/-/packages/container/iceshrimp/versions), and/or - you want a search engine for better search performance and/or a cache server for better antenna handling. diff --git a/docker-compose.yml.example b/docs/examples/docker-compose.yml similarity index 100% rename from docker-compose.yml.example rename to docs/examples/docker-compose.yml