High performance self-hosted photo and video management solution.
TypeScript backup-toolfluttergoogle-photosgoogle-photos-alternativejavascriptmobile-appnestjsnodejsphoto-galleryphotosphotos-managementself-hostedsveltesveltekittypescriptvideos
docs: separate upgrading page (#17257)
bo0tzza5093a943445
diff --git a/docs/docs/install/config-file.md b/docs/docs/install/config-file.mdindex f5d2680658..9806af760a 100644--- a/docs/docs/install/config-file.md+++ b/docs/docs/install/config-file.md@@ -1,3 +1,7 @@+---+sidebar_position: 100+---+# Config FileA config file can be provided as an alternative to the UI configuration.diff --git a/docs/docs/install/docker-compose.mdx b/docs/docs/install/docker-compose.mdxindex 99a29397fa..06154161f4 100644--- a/docs/docs/install/docker-compose.mdx+++ b/docs/docs/install/docker-compose.mdx@@ -69,39 +69,4 @@ If you get an error `can't set healthcheck.start_interval as feature require Doc## Next Steps-Read the [Post Installation](/docs/install/post-install.mdx) steps or setup optional features below.--### Setting up optional features--- [External Libraries](/docs/features/libraries.md): Adding your existing photo library to Immich-- [Hardware Transcoding](/docs/features/hardware-transcoding.md): Speeding up video transcoding-- [Hardware-Accelerated Machine Learning](/docs/features/ml-hardware-acceleration.md): Speeding up various machine learning tasks in Immich--### Upgrading--:::danger Read the release notes-Immich is currently under heavy development, which means you can expect [breaking changes][breaking] and bugs. Therefore, we recommend reading the release notes prior to updating and to take special care when using automated tools like [Watchtower][watchtower].--You can see versions that had breaking changes [here][breaking].-:::--If `IMMICH_VERSION` is set, it will need to be updated to the latest or desired version.--When a new version of Immich is [released][releases], the application can be upgraded and restarted with the following commands, run in the directory with the `docker-compose.yml` file:--```bash title="Upgrade and restart Immich"-docker compose pull && docker compose up -d-```--To clean up disk space, the old version's obsolete container images can be deleted with the following command:--```bash title="Clean up unused Docker images"-docker image prune-```--[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/-[breaking]: https://github.com/immich-app/immich/discussions?discussions_q=label%3Achangelog%3Abreaking-change+sort%3Adate_created-[container-auth]: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-to-the-container-registry-[releases]: https://github.com/immich-app/immich/releases+Read the [Post Installation](/docs/install/post-install.mdx) steps and [upgrade instructions](/docs/install/upgrading.md).diff --git a/docs/docs/install/post-install.mdx b/docs/docs/install/post-install.mdxindex 45b5f446fd..636274aaea 100644--- a/docs/docs/install/post-install.mdx+++ b/docs/docs/install/post-install.mdx@@ -41,3 +41,9 @@ A list of common steps to take after installing Immich include:## Step 7 - Setup Server Backups<ServerBackup />++## Setting up optional features++- [External Libraries](/docs/features/libraries.md): Adding your existing photo library to Immich+- [Hardware Transcoding](/docs/features/hardware-transcoding.md): Speeding up video transcoding+- [Hardware-Accelerated Machine Learning](/docs/features/ml-hardware-acceleration.md): Speeding up various machine learning tasks in Immichdiff --git a/docs/docs/install/synology.md b/docs/docs/install/synology.mdindex cab80df999..0ff6a3b85c 100644--- a/docs/docs/install/synology.md+++ b/docs/docs/install/synology.md@@ -67,10 +67,4 @@ Click "**Edit Rules**" and add the following firewall rules:## Next Steps-Read the [Post Installation](/docs/install/post-install.mdx) steps or setup optional features below.--### Setting up optional features--- [External Libraries](/docs/features/libraries.md): Adding your existing photo library to Immich-- [Hardware Transcoding](/docs/features/hardware-transcoding.md): Speeding up video transcoding-- [Hardware-Accelerated Machine Learning](/docs/features/ml-hardware-acceleration.md): Speeding up various machine learning tasks in Immich+Read the [Post Installation](/docs/install/post-install.mdx) steps and [upgrade instructions](/docs/install/upgrading.md).diff --git a/docs/docs/install/truenas.md b/docs/docs/install/truenas.mdindex 31b007a47d..3cd772de63 100644--- a/docs/docs/install/truenas.md+++ b/docs/docs/install/truenas.md@@ -247,6 +247,10 @@ Some examples are: `IMMICH_VERSION`, `UPLOAD_LOCATION`, `DB_DATA_LOCATION`, `TZ`## Updating the App+:::danger+Make sure to read the general [upgrade instructions](/docs/install/upgrading.md).+:::+When updates become available, SCALE alerts and provides easy updates.To update the app to the latest version:diff --git a/docs/docs/install/unraid.md b/docs/docs/install/unraid.mdindex 731f53bb00..344b912aea 100644--- a/docs/docs/install/unraid.md+++ b/docs/docs/install/unraid.md@@ -131,6 +131,10 @@ For more information on how to use the application once installed, please refer## Updating Steps+:::danger+Make sure to read the general [upgrade instructions](/docs/install/upgrading.md).+:::+Updating is extremely easy however it's important to be aware that containers managed via the Docker Compose Manager plugin do not integrate with Unraid's native dockerman UI, the label "_update ready_" will always be present on containers installed via the Docker Compose Manager.<imgdiff --git a/docs/docs/install/upgrading.md b/docs/docs/install/upgrading.mdnew file mode 100644index 0000000000..26cb22ffcc--- /dev/null+++ b/docs/docs/install/upgrading.md@@ -0,0 +1,32 @@+---+sidebar_position: 95+---++# Upgrading++:::danger Read the release notes+Immich is currently under heavy development, which means you can expect [breaking changes][breaking] and bugs. You should read the release notes prior to updating and take special care when using automated tools like [Watchtower][watchtower].++You can see versions that had breaking changes [here][breaking].+:::++When a new version of Immich is [released][releases], you should read the release notes and account for any breaking changes noted (as mentioned above).+If you use `IMMICH_VERSION` in your `.env` file, it will need to be updated to the latest or desired version.+After that, the application can be upgraded and restarted with the following commands, run in the directory with the `docker-compose.yml` file:++```bash title="Upgrade and restart Immich"+docker compose pull && docker compose up -d+```++To clean up disk space, the old version's obsolete container images can be deleted with the following command:++```bash title="Clean up unused Docker images"+docker image prune+```++[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/+[breaking]: https://github.com/immich-app/immich/discussions?discussions_q=label%3Achangelog%3Abreaking-change+sort%3Adate_created+[container-auth]: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-to-the-container-registry+[releases]: https://github.com/immich-app/immich/releasesdiff --git a/docs/docs/partials/_server-backup.md b/docs/docs/partials/_server-backup.mdindex 7aab90a753..b9479600aa 100644--- a/docs/docs/partials/_server-backup.md+++ b/docs/docs/partials/_server-backup.md@@ -1,2 +1,7 @@Now that you have imported some pictures, you should setup server backups to preserve your memories.You can do so by following our [backup guide](/docs/administration/backup-and-restore.md).++:::danger+Immich is still under heavy development _and_ handles very important data.+It is essential that you set up good backups, and test them.+:::