Convert Immich installation and SWAG exposure sections to steps

This commit is contained in:
Djeex
2026-09-04 14:56:03 +02:00
parent b8fbab8a18
commit eeeaa706a2
+18 -4
View File
@@ -29,6 +29,9 @@ tree:
--- ---
:: ::
::steps{level="3"}
### Deploy the stack
Open Dockge, click on `compose`, name the stack `immich`, then copy and paste the latest `docker-compose.yml` [published here](https://github.com/immich-app/immich/blob/main/docker/docker-compose.yml). Open Dockge, click on `compose`, name the stack `immich`, then copy and paste the latest `docker-compose.yml` [published here](https://github.com/immich-app/immich/blob/main/docker/docker-compose.yml).
::warning ::warning
@@ -36,6 +39,8 @@ Open Dockge, click on `compose`, name the stack `immich`, then copy and paste th
__Warning__: Do not add the Watchtower label to the Immich stack. Immich evolves rapidly, and automatic updates may break your installation. __Warning__: Do not add the Watchtower label to the Immich stack. Immich evolves rapidly, and automatic updates may break your installation.
:: ::
### Set your environment variables
Configure the `.env` file by copying the latest version [from here](https://github.com/immich-app/immich/blob/main/docker/example.env) and follow the comments in the file. Configure the `.env` file by copying the latest version [from here](https://github.com/immich-app/immich/blob/main/docker/example.env) and follow the comments in the file.
::note ::note
@@ -47,19 +52,23 @@ If you're using a NAS or a network-shared drive via [Samba](/general/networking/
__Tip:__ If your CPU/iGPU/GPU supports it, Immich can use hardware acceleration for video playback and image recognition. This can triple performance. Learn more about [Transcoding](https://immich.app/docs/features/hardware-transcoding/) and [Machine Learning](https://immich.app/docs/features/ml-hardware-acceleration). __Tip:__ If your CPU/iGPU/GPU supports it, Immich can use hardware acceleration for video playback and image recognition. This can triple performance. Learn more about [Transcoding](https://immich.app/docs/features/hardware-transcoding/) and [Machine Learning](https://immich.app/docs/features/ml-hardware-acceleration).
:: ::
Deploy the container. Deploy the container. You can connect and follow the setup instructions at `http://yourserverip:2283`.
You're done! You can connect and follow the setup instructions at `http://yourserverip:2283`. ### Done !
::
## Exposing Immich with SWAG ## Exposing Immich with SWAG
The main benefit of this setup is being able to access Immich remotely on all your devices. We'll expose Immich using SWAG. The main benefit of this setup is being able to access Immich remotely on all your devices. We'll expose Immich using SWAG.
::note ::note{icon=""}
📋 __Before you begin:__ 📋 __Before you begin:__
<br/><br/> <br/><br/>
We assume that you have a subdomain `immich.yourdomain.com` with a `CNAME` pointing to `yourdomain.com` in your [DNS zone](/general/networking/dns). Also, unless you're using [Cloudflare Zero Trust](/serveex/security/cloudflare), make sure port `443` on your router is forwarded to port `443` on your server via [NAT rules](/general/networking/nat). We assume that you have a subdomain `immich.yourdomain.com` with a `CNAME` pointing to `yourdomain.com` in your [DNS zone](/general/networking/dns). Also, unless you're using [Cloudflare Zero Trust](/serveex/security/cloudflare), make sure port `443` on your router is forwarded to port `443` on your server via [NAT rules](/general/networking/nat).
:: ::
::steps{level="3"}
### Add Immich's network to SWAG
In Dockge, open the SWAG stack and edit the compose file to add Immich's network: In Dockge, open the SWAG stack and edit the compose file to add Immich's network:
```yaml [compose.yaml] ```yaml [compose.yaml]
@@ -86,6 +95,8 @@ We're assuming Immich's network is named `immich_default`. You can check connect
Restart the stack by clicking "deploy" and wait for SWAG to fully initialize. Restart the stack by clicking "deploy" and wait for SWAG to fully initialize.
### Create the subdomain.conf file
In the SWAG folders, create a file named `immich.subdomain.conf`. In the SWAG folders, create a file named `immich.subdomain.conf`.
::tip{icon=""} ::tip{icon=""}
@@ -159,6 +170,9 @@ server {
Press :kbd{value="Ctrl+O"}, then :kbd{value="Enter"} to save, and :kbd{value="Ctrl+X"} to exit. Press :kbd{value="Ctrl+O"}, then :kbd{value="Enter"} to save, and :kbd{value="Ctrl+X"} to exit.
### Done !
::
That's it! Immich is now accessible from the internet. Dont forget to install the [iOS](https://apps.apple.com/us/app/immich/id1613945652) / [Android](https://play.google.com/store/apps/details?id=app.alextran.immich) apps to sync your devices. That's it! Immich is now accessible from the internet. Dont forget to install the [iOS](https://apps.apple.com/us/app/immich/id1613945652) / [Android](https://play.google.com/store/apps/details?id=app.alextran.immich) apps to sync your devices.
## Protecting Immich with Pocket ID ## Protecting Immich with Pocket ID
@@ -190,7 +204,7 @@ In Immich, go to _Administration > Settings > Authentication Settings > OAuth_,
### Done ! ### Done !
:: ::
::tip ::tip{icon=""}
✨ You can use [Authentik](/serveex/advanced/authentik) instead of Pocket ID: ✨ You can use [Authentik](/serveex/advanced/authentik) instead of Pocket ID:
1. In Authentik, create an application and an OAuth2/OpenID Connect provider named `immich`, with the same three redirect URIs as above (type `Strict`). 1. In Authentik, create an application and an OAuth2/OpenID Connect provider named `immich`, with the same three redirect URIs as above (type `Strict`).