diff --git a/.dockerignore b/.dockerignore index 21a5da869..5a009f2af 100644 --- a/.dockerignore +++ b/.dockerignore @@ -18,7 +18,7 @@ config/logs/* config/*.json dist Dockerfile* -docker-compose.yml +compose.yaml docs LICENSE node_modules diff --git a/.gitattributes b/.gitattributes index eb5d2314f..d9863caf6 100644 --- a/.gitattributes +++ b/.gitattributes @@ -40,7 +40,7 @@ docs export-ignore .all-contributorsrc export-ignore .editorconfig export-ignore Dockerfile.local export-ignore -docker-compose.yml export-ignore +compose.yaml export-ignore stylelint.config.js export-ignore public/os_logo_filled.png export-ignore diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c5f768c29..32d0ac06b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -52,7 +52,7 @@ All help is welcome and greatly appreciated! If you would like to contribute to pnpm dev ``` - - Alternatively, you can use [Docker](https://www.docker.com/) with `docker-compose up -d`. This method does not require installing NodeJS or Yarn on your machine directly. + - Alternatively, you can use [Docker](https://www.docker.com/) with `docker compose up -d`. This method does not require installing NodeJS or Yarn on your machine directly. 5. Create your patch and test your changes. diff --git a/docker-compose.yml b/compose.yaml similarity index 93% rename from docker-compose.yml rename to compose.yaml index 91b76e1e4..94705357f 100644 --- a/docker-compose.yml +++ b/compose.yaml @@ -1,4 +1,3 @@ -version: '3' services: jellyseerr: build: diff --git a/docs/extending-jellyseerr/reverse-proxy.mdx b/docs/extending-jellyseerr/reverse-proxy.mdx index 1ac365454..c78ae9154 100644 --- a/docs/extending-jellyseerr/reverse-proxy.mdx +++ b/docs/extending-jellyseerr/reverse-proxy.mdx @@ -190,7 +190,7 @@ Caddy will automatically obtain and renew SSL certificates for your domain. ## Traefik (v2) -Add the following labels to the Jellyseerr service in your `docker-compose.yml` file: +Add the following labels to the Jellyseerr service in your `compose.yaml` file: ```yaml labels: diff --git a/docs/getting-started/docker.mdx b/docs/getting-started/docker.mdx index 3d8d690ce..5e710735c 100644 --- a/docs/getting-started/docker.mdx +++ b/docs/getting-started/docker.mdx @@ -71,7 +71,7 @@ You could also use [diun](https://github.com/crazy-max/diun) to receive notifica For details on how to use Docker Compose, please [review the official Compose documentation](https://docs.docker.com/compose/reference/). #### Installation: -Define the `jellyseerr` service in your `docker-compose.yml` as follows: +Define the `jellyseerr` service in your `compose.yaml` as follows: ```yaml --- services: @@ -94,17 +94,17 @@ If you are using emby, make sure to set the `JELLYFIN_TYPE` environment variable Then, start all services defined in the Compose file: ```bash -docker-compose up -d +docker compose up -d ``` #### Updating: Pull the latest image: ```bash -docker-compose pull jellyseerr +docker compose pull jellyseerr ``` Then, restart all services defined in the Compose file: ```bash -docker-compose up -d +docker compose up -d ``` :::tip You may alternatively use a third-party mechanism like [dockge](https://github.com/louislam/dockge) to manage your docker compose files.