From 189bd37e716e026b0f247c2e98e74852b26c7ba7 Mon Sep 17 00:00:00 2001 From: bo0tzz Date: Sat, 28 Jan 2023 04:26:15 +0100 Subject: [PATCH] docs: Update links to deployment files (#1405) --- docs/docs/install/docker-compose.md | 8 ++++---- docs/docs/install/portainer.md | 4 ++-- docs/docs/install/script.md | 2 +- docs/docs/install/unraid.md | 4 ++-- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/docs/install/docker-compose.md b/docs/docs/install/docker-compose.md index 1241cec421..b32cf9919a 100644 --- a/docs/docs/install/docker-compose.md +++ b/docs/docs/install/docker-compose.md @@ -13,11 +13,11 @@ Download [`docker-compose.yml`][compose-file] [`example.env`][env-file]. From a directory of your choice (e.g. `./immich-app`) run the following commands: ```bash title="Get docker-compose.yml file" -wget https://raw.githubusercontent.com/immich-app/immich/main/docker/docker-compose.yml +wget https://github.com/immich-app/immich/releases/latest/download/docker-compose.yml ``` ```bash title="Get .env file" -wget -O .env https://raw.githubusercontent.com/immich-app/immich/main/docker/example.env +wget -O .env https://github.com/immich-app/immich/releases/latest/download/example.env ``` ### Step 2 - Populate the .env file with custom values @@ -116,6 +116,6 @@ docker-compose pull && docker-compose up -d # Or `docker compose` Immich is currently under heavy development, which means you can expect breaking changes and bugs. Therefore, we recommend reading the release notes prior to updating and to take special care when using automated tools like [Watchtower][watchtower]. ::: -[compose-file]: https://raw.githubusercontent.com/immich-app/immich/main/docker/docker-compose.yml -[env-file]: https://raw.githubusercontent.com/immich-app/immich/main/docker/example.env +[compose-file]: https://github.com/immich-app/immich/releases/latest/download/docker-compose.yml +[env-file]: https://github.com/immich-app/immich/releases/latest/download/example.env [watchtower]: https://containrrr.dev/watchtower/ diff --git a/docs/docs/install/portainer.md b/docs/docs/install/portainer.md index 09c5917f3d..1d9b9b4fce 100644 --- a/docs/docs/install/portainer.md +++ b/docs/docs/install/portainer.md @@ -9,7 +9,7 @@ Install Immich using Portainer's Stack feature. 1. Go to "**Stacks**" in the left sidebar. 2. Click on "**Add stack**". 3. Give the stack a name (i.e. Immich), and select "**Web Editor**" as the build method. -4. Copy the content of the `docker-compose.yml` file from the [GitHub repository](https://raw.githubusercontent.com/immich-app/immich/main/docker/docker-compose.yml). +4. Copy the content of the `docker-compose.yml` file from the [GitHub repository](https://github.com/immich-app/immich/releases/latest/download/docker-compose.yml). 5. Replace `.env` with `stack.env` for all containers that need to use environment variables in the web editor. Dot Env Example -9. Copy the content of the `example.env` file from the [GitHub repository](https://raw.githubusercontent.com/immich-app/immich/main/docker/example.env) and paste into the editor. +9. Copy the content of the `example.env` file from the [GitHub repository](https://github.com/immich-app/immich/releases/latest/download/example.env) and paste into the editor. 10. Switch back to "**Simple Mode**". Select Plugins > Compose.Manager > Add New Stack > Label it Immich 3. Select the cog ⚙️ next to Immich then click "**Edit Stack**" -4. Click "**Compose File**" and then paste the entire contents of the [Immich Docker Compose](https://raw.githubusercontent.com/immich-app/immich/main/docker/docker-compose.yml) file into the Unraid editor +4. Click "**Compose File**" and then paste the entire contents of the [Immich Docker Compose](https://github.com/immich-app/immich/releases/latest/download/docker-compose.yml) file into the Unraid editor
Using an existing Postgres container? Click me! Otherwise proceed to step 5.
5. Click "**Save Changes**", you will be promoted to edit stack UI labels, just leave this blank and click "**Ok**" 6. Select the cog ⚙️ next to Immich, click "**Edit Stack**", then click "**Env File**" -7. Past the entire contents of the [Immich example.env](https://raw.githubusercontent.com/immich-app/immich/main/docker/example.env) file into the Unraid editor, then **before saving** edit the following: +7. Past the entire contents of the [Immich example.env](https://github.com/immich-app/immich/releases/latest/download/example.env) file into the Unraid editor, then **before saving** edit the following: - `UPLOAD_LOCATION`: Create a folder in your Images Unraid share and place the **absolute** location here > For example my _"images"_ share has a folder within it called _"immich"_. If I browse to this directory in the terminal and type `pwd` the output is `/mnt/user/images/immich`. This is the exact value I need to enter as my `UPLOAD_LOCATION`