chore(docs): refactor pages (#1144)

* chore(docs): refactor pages * fix: links * fix: broken link * refactor: post install steps using partials
2025-12-07 07:33:47 +09:00 · 2022-12-21 16:01:50 -05:00
parent 7966c925ea
commit 752b267399
67 changed files with 380 additions and 258 deletions
--- a/docs/docs/install/docker-compose.md
+++ b/docs/docs/install/docker-compose.md
@@ -0,0 +1,130 @@
+---
+sidebar_position: 3
+---
+
+# Docker Compose [Recommended]
+
+Docker Compose is the recommended method to run Immich in production. Below are the steps to deploy Immich with Docker Compose.
+
+### Step 1 - Download the required files
+
+Download [`docker-compose.yml`][compose-file] [`.env.example`][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
+```
+
+```bash title="Get .env file"
+wget -O .env https://raw.githubusercontent.com/immich-app/immich/main/docker/.env.example
+```
+
+### Step 2 - Populate the .env file with custom values
+
+<details>
+
+<summary>Example <code>.env</code> content</summary>
+
+```bash
+###################################################################################
+# Database
+###################################################################################
+
+DB_HOSTNAME=immich_postgres
+DB_USERNAME=postgres
+DB_PASSWORD=postgres
+DB_DATABASE_NAME=immich
+
+# Optional Database settings:
+# DB_PORT=5432
+
+###################################################################################
+# Redis
+###################################################################################
+
+REDIS_HOSTNAME=immich_redis
+
+# Optional Redis settings:
+# REDIS_PORT=6379
+# REDIS_DBINDEX=0
+# REDIS_PASSWORD=
+# REDIS_SOCKET=
+
+###################################################################################
+# Upload File Config
+###################################################################################
+
+UPLOAD_LOCATION=absolute_location_on_your_machine_where_you_want_to_store_the_backup
+
+###################################################################################
+# Log message level - [simple|verbose]
+###################################################################################
+
+LOG_LEVEL=simple
+
+###################################################################################
+# JWT SECRET
+###################################################################################
+
+# This JWT_SECRET is used to sign the authentication keys for user login
+# You should set it to a long randomly generated value
+# You can use this command to generate one: openssl rand -base64 128
+JWT_SECRET=
+
+###################################################################################
+# Reverse Geocoding
+####################################################################################
+
+# DISABLE_REVERSE_GEOCODING=false
+
+# Reverse geocoding is done locally which has a small impact on memory usage
+# This memory usage can be altered by changing the REVERSE_GEOCODING_PRECISION variable
+# This ranges from 0-3 with 3 being the most precise
+# 3 - Cities > 500 population: ~200MB RAM
+# 2 - Cities > 1000 population: ~150MB RAM
+# 1 - Cities > 5000 population: ~80MB RAM
+# 0 - Cities > 15000 population: ~40MB RAM
+
+# REVERSE_GEOCODING_PRECISION=3
+
+####################################################################################
+# WEB - Optional
+####################################################################################
+
+# Custom message on the login page, should be written in HTML form.
+# For example PUBLIC_LOGIN_PAGE_MESSAGE="This is a demo instance of Immich.<br><br>Email: <i>demo@demo.de</i><br>Password: <i>demo</i>"
+
+PUBLIC_LOGIN_PAGE_MESSAGE="My Family Photos and Videos Backup Server"
+```
+
+</details>
+
+- Populate custom database information if necessary.
+- Populate `UPLOAD_LOCATION` with your preferred location for storing backup assets.
+- Populate a secret value for `JWT_SECRET`. You can use the command below to generate a secure key:
+
+```bash title="Command to generate secure JWT_SECRET key"
+openssl rand -base64 128
+```
+
+### Step 3 - Start the containers
+
+```bash title="Start the containers using docker compose command"
+docker-compose up -d # or `docker compose up -d` based on your docker-compose version
+```
+
+:::tip
+For more information on how to use the application, please refer to the [Post Installation](/docs/install/post-install.md) guide.
+:::
+
+### Step 4 - Upgrading
+
+When a new version of Immich is (released)[], the application can be upgraded with the following commands, run in the directory with the `docker-compose.yml` file:
+
+```bash title="Upgrade Immich"
+docker-compose pull && docker-compose up -d # Or `docker compose`
+```
+
+[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/.env.example