Skip to content

Commit a5093a9

Browse files
bo0tzzgithub-actions[bot]
bo0tzz
and
github-actions[bot]
authored
docs: separate upgrading page (#17257)
* docs: separate upgrading page * chore: move "setup optional features" into postinstall * docs: stronger backup warning in postinstall * chore: link to upgrading page * docs: reiterate breaking changes in upgrade doc * chore: fix formatting --------- Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 637ad1f commit a5093a9

File tree

8 files changed

+57
-43
lines changed

8 files changed

+57
-43
lines changed

‎docs/docs/install/config-file.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
sidebar_position: 100
3+
---
4+
15
# Config File
26

37
A config file can be provided as an alternative to the UI configuration.

‎docs/docs/install/docker-compose.mdx

Lines changed: 1 addition & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -69,39 +69,4 @@ If you get an error `can't set healthcheck.start_interval as feature require Doc
6969

7070
## Next Steps
7171

72-
Read the [Post Installation](/docs/install/post-install.mdx) steps or setup optional features below.
73-
74-
### Setting up optional features
75-
76-
- [External Libraries](/docs/features/libraries.md): Adding your existing photo library to Immich
77-
- [Hardware Transcoding](/docs/features/hardware-transcoding.md): Speeding up video transcoding
78-
- [Hardware-Accelerated Machine Learning](/docs/features/ml-hardware-acceleration.md): Speeding up various machine learning tasks in Immich
79-
80-
### Upgrading
81-
82-
:::danger Read the release notes
83-
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].
84-
85-
You can see versions that had breaking changes [here][breaking].
86-
:::
87-
88-
If `IMMICH_VERSION` is set, it will need to be updated to the latest or desired version.
89-
90-
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:
91-
92-
```bash title="Upgrade and restart Immich"
93-
docker compose pull && docker compose up -d
94-
```
95-
96-
To clean up disk space, the old version's obsolete container images can be deleted with the following command:
97-
98-
```bash title="Clean up unused Docker images"
99-
docker image prune
100-
```
101-
102-
[compose-file]: https://github.com/immich-app/immich/releases/latest/download/docker-compose.yml
103-
[env-file]: https://github.com/immich-app/immich/releases/latest/download/example.env
104-
[watchtower]: https://containrrr.dev/watchtower/
105-
[breaking]: https://github.com/immich-app/immich/discussions?discussions_q=label%3Achangelog%3Abreaking-change+sort%3Adate_created
106-
[container-auth]: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-to-the-container-registry
107-
[releases]: https://github.com/immich-app/immich/releases
72+
Read the [Post Installation](/docs/install/post-install.mdx) steps and [upgrade instructions](/docs/install/upgrading.md).

‎docs/docs/install/post-install.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,9 @@ A list of common steps to take after installing Immich include:
4141
## Step 7 - Setup Server Backups
4242

4343
<ServerBackup />
44+
45+
## Setting up optional features
46+
47+
- [External Libraries](/docs/features/libraries.md): Adding your existing photo library to Immich
48+
- [Hardware Transcoding](/docs/features/hardware-transcoding.md): Speeding up video transcoding
49+
- [Hardware-Accelerated Machine Learning](/docs/features/ml-hardware-acceleration.md): Speeding up various machine learning tasks in Immich

‎docs/docs/install/synology.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,4 @@ Click "**Edit Rules**" and add the following firewall rules:
6767

6868
## Next Steps
6969

70-
Read the [Post Installation](/docs/install/post-install.mdx) steps or setup optional features below.
71-
72-
### Setting up optional features
73-
74-
- [External Libraries](/docs/features/libraries.md): Adding your existing photo library to Immich
75-
- [Hardware Transcoding](/docs/features/hardware-transcoding.md): Speeding up video transcoding
76-
- [Hardware-Accelerated Machine Learning](/docs/features/ml-hardware-acceleration.md): Speeding up various machine learning tasks in Immich
70+
Read the [Post Installation](/docs/install/post-install.mdx) steps and [upgrade instructions](/docs/install/upgrading.md).

‎docs/docs/install/truenas.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,10 @@ Some examples are: `IMMICH_VERSION`, `UPLOAD_LOCATION`, `DB_DATA_LOCATION`, `TZ`
247247

248248
## Updating the App
249249

250+
:::danger
251+
Make sure to read the general [upgrade instructions](/docs/install/upgrading.md).
252+
:::
253+
250254
When updates become available, SCALE alerts and provides easy updates.
251255
To update the app to the latest version:
252256

‎docs/docs/install/unraid.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,10 @@ For more information on how to use the application once installed, please refer
131131

132132
## Updating Steps
133133

134+
:::danger
135+
Make sure to read the general [upgrade instructions](/docs/install/upgrading.md).
136+
:::
137+
134138
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.
135139

136140
<img

‎docs/docs/install/upgrading.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
sidebar_position: 95
3+
---
4+
5+
# Upgrading
6+
7+
:::danger Read the release notes
8+
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].
9+
10+
You can see versions that had breaking changes [here][breaking].
11+
:::
12+
13+
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).
14+
If you use `IMMICH_VERSION` in your `.env` file, it will need to be updated to the latest or desired version.
15+
After that, the application can be upgraded and restarted with the following commands, run in the directory with the `docker-compose.yml` file:
16+
17+
```bash title="Upgrade and restart Immich"
18+
docker compose pull && docker compose up -d
19+
```
20+
21+
To clean up disk space, the old version's obsolete container images can be deleted with the following command:
22+
23+
```bash title="Clean up unused Docker images"
24+
docker image prune
25+
```
26+
27+
[compose-file]: https://github.com/immich-app/immich/releases/latest/download/docker-compose.yml
28+
[env-file]: https://github.com/immich-app/immich/releases/latest/download/example.env
29+
[watchtower]: https://containrrr.dev/watchtower/
30+
[breaking]: https://github.com/immich-app/immich/discussions?discussions_q=label%3Achangelog%3Abreaking-change+sort%3Adate_created
31+
[container-auth]: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-to-the-container-registry
32+
[releases]: https://github.com/immich-app/immich/releases

‎docs/docs/partials/_server-backup.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,7 @@
11
Now that you have imported some pictures, you should setup server backups to preserve your memories.
22
You can do so by following our [backup guide](/docs/administration/backup-and-restore.md).
3+
4+
:::danger
5+
Immich is still under heavy development _and_ handles very important data.
6+
It is essential that you set up good backups, and test them.
7+
:::

0 commit comments

Comments
 (0)