Move docker-compose example file to docs/examples

This commit is contained in:
Laura Hausmann 2023-09-06 18:23:41 +02:00
parent b0bf1bfdf5
commit f73d13dd77
No known key found for this signature in database
GPG Key ID: D044E84C5BE01605
3 changed files with 3 additions and 3 deletions

2
.gitignore vendored
View File

@ -30,7 +30,7 @@ coverage
# docker configs # docker configs
/dev/docker-compose.yml /dev/docker-compose.yml
docker-compose.yml /docker-compose.yml
# misskey # misskey
built built

View File

@ -6,11 +6,11 @@ This guide is based on `docker compose`/Docker Compose v2, but `docker-compose`/
### Getting needed files ### 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 ### 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 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. - you want a search engine for better search performance and/or a cache server for better antenna handling.