Browse Source

Include information on GHCR login for docker installation (#3457)

Without authenticating to the GitHub Container Registry, users may struggle to install Immich server.
Nahin Khan 2 years ago
parent
commit
54db2a48af
1 changed files with 4 additions and 0 deletions
  1. 4 0
      docs/docs/install/docker-compose.md

+ 4 - 0
docs/docs/install/docker-compose.md

@@ -166,6 +166,10 @@ docker-compose up -d     # or `docker compose up -d` based on your docker-compos
 For more information on how to use the application, please refer to the [Post Installation](/docs/install/post-install.mdx) guide.
 :::
 
+:::tip
+Note that downloading container images might require you to authenticate to the GitHub Container Registry ([steps here](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-to-the-container-registry)).
+:::
+
 ### Step 4 - Upgrading
 
 If `IMMICH_VERSION` is set, it will need to be updated to the latest or desired version.