Immich 1.117.0 → 1.118.0
1 version, 1 with breaking changes, 0 required stops
Version by version, oldest first
1.118.0 2024-10-15
Breaking
This release includes the following breaking changes:
- Port alignment
- Remove deprecated API endpoints
- Remove deprecated
start.sharguments
1. Port alignment
We aligned the internal port of the immich-server to be similar to the binding port. Please make the following change to your docker-compose.yml file under the immich-server section. Reverse proxies using port 3001 also need to be updated to use port 2283.
services:
immich-server:
container_name: immich_server
...
ports:
- - 2283:3001
+ - 2283:2283
...
2. Remove deprecated API endpoints
The following endpoints were previously deprecated and have been removed, if you are a community project maintainer and using one of the endpoints below, please make sure to make changes to your project:
/api/server-info/*has been removed. Use/api/server/*instead./api/people/:id/assetshas been removed. Use/api/search/metadatainstead.
Note
This includes
/api/server-info/ping,/api/server-info/version,/api/server-features,/api/server-info/config,/api/server-info/statistics, and others.
3. Remove deprecated start.sh arguments
The following docker commands have been removed:
start.sh immichstart.sh microservices
Follow the steps below to align docker-compose.yml with the default setup.
Note
These steps are only required if you still have the
immich-microservicessection in yourdocker-compose.ymlor didn't follow the previous instructions to remove the command section. If you don't have the mentioned content below, you can ignore this
1. Update docker-compose.yml
Remove the command line from immich-server and the entire immich-microservices service section as shown below.
services:
immich-server:
container_name: immich_server
...
:
- command: [ "start.sh", "immich" ]
...
- immich-microservices:
- container_name: immich_microservices
- ...
- :
- command: [ "start.sh", "microservices" ]
- ...
2. Remove the running immich-microservices container
Run docker compose down --remove-orphans after updating docker-compose.yml to remove the old immich-microservices container.
Breaking
- refactor(server): worker env by @jrasm91 in https://github.com/immich-app/immich/pull/13160
- chore: remove deprecated controller by @jrasm91 in https://github.com/immich-app/immich/pull/13189
- chore: remove deprecated endpoint by @jrasm91 in https://github.com/immich-app/immich/pull/13190
- feat: align compose ports by @jrasm91 in https://github.com/immich-app/immich/pull/13185
Release notes from github.com/immich-app/immich/releases, checked 17 hours ago. Only text the vendor marks as breaking, or puts in a warning/caution/important note, or a plain note, is shown (a note that asks nothing of the admin, such as a call for feedback or testing, is not); read the full notes for anything else.