Upcoming Container Consolidation (breaking changes planned for the v1.88.0 release)
#5086
Replies: 24 comments 81 replies
-
|
So what do we need to do when you release v1.87.0 ? |
Beta Was this translation helpful? Give feedback.
-
|
Nothing for |
Beta Was this translation helpful? Give feedback.
-
|
{"message":"Cannot GET /","error":"Not Found","statusCode":404} |
Beta Was this translation helpful? Give feedback.
-
Beta Was this translation helpful? Give feedback.
-
|
@Genry777Morgan port 2283 is exposed, not 3001 |
Beta Was this translation helpful? Give feedback.
-
|
I'm guessing users of the Imagegenius Docker image won't be affected? |
Beta Was this translation helpful? Give feedback.
-
|
Defer the answer to @martabal |
Beta Was this translation helpful? Give feedback.
-
|
PRs are already open, tested and ready to be merged 😜 imagegenius/docker-immich#213 |
Beta Was this translation helpful? Give feedback.
-
|
Yes, it won't affect you |
Beta Was this translation helpful? Give feedback.
-
|
I've been using the imagegenius Docker images for the last several months, after upgrade to 1.88.X I see I am on unraid, are there any recommendations for that? My docker command/config would look equivalent to whats on the imagegeneius README yet I get a 404. |
Beta Was this translation helpful? Give feedback.
-
|
Appears an issue only with the |
Beta Was this translation helpful? Give feedback.
-
|
Will we have to change reverse proxy to point to 3001 vs 8080? |
Beta Was this translation helpful? Give feedback.
-
|
Looks like it stays pointing to |
Beta Was this translation helpful? Give feedback.
-
|
No, just keep pointing it to 2283 |
Beta Was this translation helpful? Give feedback.
-
|
if you were previously using 8080, then yes it needs to go to 3001 one. If it was previously 2283 it can stay as 2283. |
Beta Was this translation helpful? Give feedback.
-
|
Will the Official Helm Chart be Updated too? |
Beta Was this translation helpful? Give feedback.
-
|
Yes, I intend to get around to this hopefully this weekend or early next week. Of course a PR is welcome if someone wants to :) |
Beta Was this translation helpful? Give feedback.
-
|
For those just checking in on this discussion, @bo0tzz has opened this PR: immich-app/immich-charts#50 |
Beta Was this translation helpful? Give feedback.
-
|
For the Helm chart, also worth noting that there's a new version of the common chart by bjw-s, with several breaking changes: bjw-s/helm-charts#189 Edit: I've just deployed Immich with the current version of the bjw-s common chart, so I thought a Gist could help: https://gist.github.com/fernandodeperto/aa3460eb776f4849842014d3592b73b7 |
Beta Was this translation helpful? Give feedback.
-
|
I'm aware of the new common chart version. I believe it doesn't have any noteworthy fixes, and since I believe it would be a breaking change for the immich chart, I'm fine with not upgrading. |
Beta Was this translation helpful? Give feedback.
-
|
I have been exposing immich via a virtual IP directly on a network interface of my docker host (rather than NAT-ing ports through the docker-internal network) so my immich-proxy:
container_name: immich_proxy
image: ghcr.io/immich-app/immich-proxy:v1.85.0
environment:
<<: *immichwebvars
networks:
immich: {}
qnet-static-eth0-3b751d:
ipv4_address: 192.168.2.102 # External, virtual IP of immich
#ports:
# - 2283:8080
depends_on:
- immich-server
- immich-web
restart: alwaysit's always bothered me a bit that I can't change the port because of this (it's stuck at 8080 because it isn't NAT-ed). immich-server:
container_name: immich_server
image: ghcr.io/immich-app/immich-server:v1.88.0
command: [ "start.sh", "immich" ]
volumes:
- ${UPLOAD_LOCATION}:/usr/src/app/upload
- /etc/localtime:/etc/localtime:ro
environment:
IMMICH_PORT: 80
<<: *immichwebvars
networks:
immich: {}
qnet-static-eth0-3b751d:
ipv4_address: 192.168.2.102 # External, virtual IP of immich
depends_on:
- redis
- database
- typesense
restart: alwaysuntil I can add HTTPS later (at which point I will have to add a proxy-container again anyway I guess) |
Beta Was this translation helpful? Give feedback.
-
|
|
Beta Was this translation helpful? Give feedback.
-
|
Thanks a lot, this doesn't work currently because the |
Beta Was this translation helpful? Give feedback.
-
|
Correct |
Beta Was this translation helpful? Give feedback.
-
|
@alextran1502 will the banner warning of the pending release only appear in the web app, or can it be made to appear in the client app too? |
Beta Was this translation helpful? Give feedback.
-
|
The banner will probably only be in the web app. But if you've seen this message then you are already informed and not the target audience for the banner 😄 |
Beta Was this translation helpful? Give feedback.
-
|
Fair enough - I'll turn off Watchtower until after the new release. 😉 |
Beta Was this translation helpful? Give feedback.
-
|
If my server was initially installed without the name directive, will this be a breaking change if left in the docker-compose.yml? |
Beta Was this translation helpful? Give feedback.
-
|
This was covered - you can leave it out if you don't already use it otherwise, yes, it will be a breaking change. |
Beta Was this translation helpful? Give feedback.
-
|
If you change it, all your existing containers and volumes will become orphans. This doesn't normally matter (since everything can be re-created), but the database is stored by default on a docker volume and if that is orphaned you basically would be starting the stack with a different (new) database. |
Beta Was this translation helpful? Give feedback.
-
|
Thank you for the heads up! We absolutely love your work! Our app is proposing Immich as a 1 click installer and I was wondering why you decided to release breaking changes as minor semver versions? We have almost 200 apps to keep track of and have manual reviews for major updates but it's easy to miss these kind of announcements and have user installs breaking if we don't pay enough attention |
Beta Was this translation helpful? Give feedback.
-
|
I didn't see anywhere in the readme or the docs site that states immich uses semver. In fact the readme says:
but as you can clearly see the app is not in the So just because it is a three-part version number, does not mean it is SemVer 2.0.0. |
Beta Was this translation helpful? Give feedback.
-
|
Immich isn't actually 1.x, that was an unfortunate mistake early on. We're really more like 0.x.x with no guarantees that minor updates won't contain breaking changes. In fact many of them will. Currently we recommend reading the release notes every release. If that doesn't work you should probably just hold off updating. |
Beta Was this translation helpful? Give feedback.
-
|
Thanks for the clarification, indeed it is not stated that it uses semver but I couldn't find a documentation describing the release strategy either. Just trying to understand as I would have thought it would be easier to warn users about breaking changes with semver rather than using online announcements. But that's just my opinion after breaking my install at some occasions by blindly clicking update (blame on me) |
Beta Was this translation helpful? Give feedback.
-
|
We are trying to push out updates weekly as incremental bug fixes and introdue new features. There is no concrete release strategy at the moment since we still have many bugs to fix and many features we want to introduce before incorporating "feature freeze" and backward compatibility. |
Beta Was this translation helpful? Give feedback.
-
|
Actually we warn our users with the warning on the readme combined with a breaking changes section in each applicable release. |
Beta Was this translation helpful? Give feedback.
-
|
I've been using Immich with reverse proxy by exposing the proxy container: where the As the proxy container will be gone, how should i alter my setup? |
Beta Was this translation helpful? Give feedback.
-
|
You can probably move those labels to the server container instead |
Beta Was this translation helpful? Give feedback.
-
|
Thank you. I'll try asap the 1.88 is out |
Beta Was this translation helpful? Give feedback.
-
|
Up until now, I've been updating to the latest version of Immich by simply running version: "3.8"
services:
immich-server:
container_name: immich_server
image: ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release}
command: ["start.sh", "immich"]
volumes:
- ${UPLOAD_LOCATION}:/usr/src/app/upload/upload
- ${LIBRARY_LOCATION}:/usr/src/app/upload/library
- ${THUMBS_LOCATION}:/usr/src/app/upload/thumbs
- ${PROFILE_LOCATION}:/usr/src/app/upload/profile
- ${VIDEO_LOCATION}:/usr/src/app/upload/encoded-video
- /etc/localtime:/etc/localtime:ro
env_file:
- .env
depends_on:
- redis
- database
- typesense
restart: always
immich-microservices:
container_name: immich_microservices
image: ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release}
# extends:
# file: hwaccel.yml
# service: hwaccel
command: ["start.sh", "microservices"]
volumes:
- ${UPLOAD_LOCATION}:/usr/src/app/upload/upload
- ${LIBRARY_LOCATION}:/usr/src/app/upload/library
- ${THUMBS_LOCATION}:/usr/src/app/upload/thumbs
- ${PROFILE_LOCATION}:/usr/src/app/upload/profile
- ${VIDEO_LOCATION}:/usr/src/app/upload/encoded-video
- /etc/localtime:/etc/localtime:ro
env_file:
- .env
depends_on:
- redis
- database
- typesense
restart: always
immich-machine-learning:
container_name: immich_machine_learning
image: ghcr.io/immich-app/immich-machine-learning:${IMMICH_VERSION:-release}
volumes:
- model-cache:/cache
- ${LIBRARY_LOCATION}:/usr/src/app/upload/library
- ${UPLOAD_LOCATION}:/usr/src/app/upload/upload
- ${THUMBS_LOCATION}:/usr/src/app/upload/thumbs
- ${PROFILE_LOCATION}:/usr/src/app/upload/profile
- ${VIDEO_LOCATION}:/usr/src/app/upload/encoded-video
env_file:
- .env
restart: always
immich-web:
container_name: immich_web
image: ghcr.io/immich-app/immich-web:${IMMICH_VERSION:-release}
env_file:
- .env
restart: always
typesense:
container_name: immich_typesense
image: typesense/typesense:0.24.1@sha256:9bcff2b829f12074426ca044b56160ca9d777a0c488303469143dd9f8259d4dd
environment:
- TYPESENSE_API_KEY=${TYPESENSE_API_KEY}
- TYPESENSE_DATA_DIR=/data
# remove this to get debug messages
- GLOG_minloglevel=1
volumes:
- ${TYPESENSE_DATA_LOCATION}:/data
restart: always
redis:
container_name: immich_redis
image: redis:6.2-alpine@sha256:70a7a5b641117670beae0d80658430853896b5ef269ccf00d1827427e3263fa3
restart: always
database:
container_name: immich_postgres
image: postgres:14-alpine@sha256:28407a9961e76f2d285dc6991e8e48893503cc3836a4755bbc2d40bcc272a441
env_file:
- .env
environment:
POSTGRES_PASSWORD: ${DB_PASSWORD}
POSTGRES_USER: ${DB_USERNAME}
POSTGRES_DB: ${DB_DATABASE_NAME}
volumes:
- ${POSTGRES_DATA_LOCATION}:/var/lib/postgresql/data
restart: always
immich-proxy:
container_name: immich_proxy
image: ghcr.io/immich-app/immich-proxy:${IMMICH_VERSION:-release}
ports:
- 2283:8080
depends_on:
- immich-server
- immich-web
restart: always
volumes:
pgdata:
model-cache:
tsdata: |
Beta Was this translation helpful? Give feedback.
-
|
I think you will need to add Also, after pulling the new images you need to execute: to remove the containers of |
Beta Was this translation helpful? Give feedback.
-
|
@alex-007 Running the prune command, instead of removing orphans, should also suffice, right?
|
Beta Was this translation helpful? Give feedback.
-
|
@n00b12345 |
Beta Was this translation helpful? Give feedback.
-
|
@jrasm91 Wouldn't |
Beta Was this translation helpful? Give feedback.
-
|
Only if you run it with |
Beta Was this translation helpful? Give feedback.
-
|
Just followed the steps and am now getting "{"message":"Cannot GET /","error":"Not Found","statusCode":404}" when accessing HOST IP:2283 Not sure where I've gone wrong. |
Beta Was this translation helpful? Give feedback.
-
|
Indeed. I also did the same. |
Beta Was this translation helpful? Give feedback.
-
|
Sorry, I still have no clue... What exactly did you do to solve it? |
Beta Was this translation helpful? Give feedback.
-
|
I received the same error then noticed that the step by step instructions did not pull the new version. Running "docker compose pull" fixed that for me. |
Beta Was this translation helpful? Give feedback.
-
|
thank you.. |
Beta Was this translation helpful? Give feedback.
-
|
I got a 502 bad gateway when i just tried to upgrade to 1.89. Also can access http://:2283 or 3001. Not sure what the problem is yet. Any thoughts? |
Beta Was this translation helpful? Give feedback.
-
|
Why don't you make it version 2.0 ? It more obvious from semantic versioning point of view that this breaks the installation |
Beta Was this translation helpful? Give feedback.
-
|
Because Immich doesn't use semver, as discussed earlier in this thread. |
Beta Was this translation helpful? Give feedback.
-
I like this! When I was installing it for the 1st time I was very confused of amount of containers that it needed. |
Beta Was this translation helpful? Give feedback.
-
|
Are the TLDR steps required for unRAID users clicking "Update Stack" or will the update stack pull the updated docker yaml file? |
Beta Was this translation helpful? Give feedback.
-
|
I'm the one who managed to break Immich during this update... |
Beta Was this translation helpful? Give feedback.
-
|
Here is my docker-compose file: |
Beta Was this translation helpful? Give feedback.
-
|
Move the port mapping from immich microservices to immich server |
Beta Was this translation helpful? Give feedback.
-
|
@PixelAlex you're mapping the ports in |
Beta Was this translation helpful? Give feedback.
-
|
Embarrassing, ehh?.. |
Beta Was this translation helpful? Give feedback.
-
Heads up, the ports will need to wrapped in quotes to avoid a YAML parsing error. |
Beta Was this translation helpful? Give feedback.
-
|
From the docs: |
Beta Was this translation helpful? Give feedback.
-
|
So, what's the idiots guide to updating this in Portainer? |
Beta Was this translation helpful? Give feedback.
-
|
maybe check the immich-server logs and make sure it is running 1.88 |
Beta Was this translation helpful? Give feedback.
-
|
Yes, I can even see the version number on the local access of immich 
PS: the storage usage is false, it's always been like this for some reason. I have nowhere near |
Beta Was this translation helpful? Give feedback.
-
|
is there another place I can look at logs? |
Beta Was this translation helpful? Give feedback.
-
|
I think it is going to be related to your reverse proxy. Basically you need to properly connect it. It runs on 3001 internally or 2283 externally if you followed the release notes. If it is supposed to be internal it needs to be on the same network. |
Beta Was this translation helpful? Give feedback.
-
|
Yes indeed. I had to add to the |
Beta Was this translation helpful? Give feedback.
-
|
Just updated to 1.88 without any issues 👍 |
Beta Was this translation helpful? Give feedback.
-
|
http://192.168.0.xx:2283/api worked for me @tomatonuders, fwiw. |
Beta Was this translation helpful? Give feedback.
-
|
@tomatonuders For me the URL is http://local_lan_ip_of_docker_host:2283 from the mobile app. That is the web server address. |
Beta Was this translation helpful? Give feedback.
-
|
But you have to make sure to add the new exposed port onto the immich-server container. |
Beta Was this translation helpful? Give feedback.
-
|
@jrasm91 / @yotis1982 / @pedropombeiro . Not sure how to copy the docker config immich-server to here. sorry for the bad layout. here is the docker Image [ghcr.io/immich-app/immich-server:release@sha256:........] ENV Labels |
Beta Was this translation helpful? Give feedback.
-
|
Strange thing, it started working after I removed the app and redownloaded the app. Then I tried logging into the server from a mobile browser -- this worked. Then copied the URL from the mobile to the app, then it prompted me a login (yay). So not sure what happened. I did in fact use the right URL. So I'm stumped. But everything is working for the time being. |
Beta Was this translation helpful? Give feedback.
-
|
Such a seamless update ♥ |
Beta Was this translation helpful? Give feedback.
-
|
I was able to migrate everything following the instructions for docker compose without issues |
Beta Was this translation helpful? Give feedback.
-
|
Unfortunately, I cannot get it to work. I am using Portainer and adapted my docker-compose according to the instructions above (i.e. add ports to server and remove web and proxy). It now looks like this: I left everything in stack.env untouched, as it worked with previous versions. Portainer shows me that the proxy and web container are not running anymore and that the server container now exposes 2283:8080. However, opening Immich using the 2283 port in a browser does not work. I cannot access the webui nor connect using the app. Can anyone help me with this? |
Beta Was this translation helpful? Give feedback.
-
|
You got the port wrong, it should be 2283:3001. |
Beta Was this translation helpful? Give feedback.
-
|
Well, that totally makes sense. Thank you, it's working now. |
Beta Was this translation helpful? Give feedback.
-
|
Done update following simple instrunction in TLDR. |
Beta Was this translation helpful? Give feedback.
-
|
Have you removed the |
Beta Was this translation helpful? Give feedback.
-
|
Sorry, my mistake. |
Beta Was this translation helpful? Give feedback.
-
|
I just want to thank you for making this very easy to follow guide! I updated today without any problems. |
Beta Was this translation helpful? Give feedback.
-
|
Just tried to launch Immich and got the notice. Came over here via the link, followed the (very simple) instructions and was back up and running inside five minutes. Kudos, folks! Excellent work! |
Beta Was this translation helpful? Give feedback.
-
|
Same -- I logged into Github just to say thanks! I had no idea about this, just updated on CLI and then saw the placeholder screen with the notice. Elegantly solved! <3 The small adjustment was easy+quick to do, no worries here. |
Beta Was this translation helpful? Give feedback.
-
|
Interesting, following the guide to the letter (i hope) and I end up with error on the postgres database.. this leads to: thats strange - since it looks like everybody is using the same postgresql image... - i modified the line to be exactly as in upper yml config file: any ideas? should I modify he db image and add pgvector? thanks a lot for any hints..:) |
Beta Was this translation helpful? Give feedback.
-
|
I had the same issue and mine was due to a breaking change in the latest version (v1.91.0). So if you are on the latest version, typesense has been removed in favor of pgvecto.rs, see the release notes for more info. I've also copied the relevant changes to the docker-compose.yml below for simplicity: immich-server:
[...]
depends_on:
- redis
- database
- - typesense
restart: always
immich-microservices:
[...]
depends_on:
- redis
- database
- - typesense
restart: always
- typesense:
- container_name: immich_typesense
- image: typesense/typesense:0.24.1@sha256:9bcff2b829f12074426ca044b56160ca9d777a0c488303469143dd9f8259d4dd
- environment:
- - TYPESENSE_API_KEY=${TYPESENSE_API_KEY}
- - TYPESENSE_DATA_DIR=/data
- # remove this to get debug messages
- - GLOG_minloglevel=1
- volumes:
- - tsdata:/data
- restart: always
[...]
database:
container_name: immich_postgres
- image: postgres:14-alpine@sha256:6a0e35296341e676fe6bd8d236c72afffe2dfe3d7eb9c2405c0f3fc04500cd07
+ image: tensorchord/pgvecto-rs:pg14-v0.1.11
env_file:
- .env
environment:
volumes:
pgdata:
model-cache:
- tsdata: |
Beta Was this translation helpful? Give feedback.
-
|
ha...thanks a lot :)..did not realize there were 2 breaking changed releases in the raw :). now all works fine |
Beta Was this translation helpful? Give feedback.
-
|
Wow, flippin' lifesaver, @aagrifo! Minor heart-attack there for like 5 minutes till I found this. Thank you so much. |
Beta Was this translation helpful? Give feedback.
-
|
Yeah lifesaver. The breaking changes 1 2 punch got me good. |
Beta Was this translation helpful? Give feedback.
and others
-
Hello, Immich Fans!
The following only applies to upcoming version 1.88.0, please ensure you only make these changes when updating to that specific version!
With an effort to reduce complexity, we have worked on simplifying the deployment and inter-container communication within Immich.
We have reduced the total services from 8 containers down to 6 containers. Namely,
immich-proxyandimmich-webhave been removed. @jrasm91 had done an outstanding job (#5069) of switching the web rendering method from server-side rendering to client-side rendering, eliminating the need for a specialized web server (previouslyimmich-webcontainer). Any web server can now host the web's output.Since
immich-serverhas an embedded web server (expressjs) and we have decided to use that to also host the web application. With these changes theimmich-proxycontainer has become unnecessary and has been removed from the defaultdocker-compose.ymlfile.With those changes, the new
docker-compose.ymlfile will have the following content.version: "3.8" name: immich services: immich-server: container_name: immich_server image: ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release} command: [ "start.sh", "immich" ] volumes: - ${UPLOAD_LOCATION}:/usr/src/app/upload - /etc/localtime:/etc/localtime:ro env_file: - .env + ports: + - 2283:3001 depends_on: - redis - database - typesense restart: always immich-microservices: container_name: immich_microservices image: ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release} # extends: # file: hwaccel.yml # service: hwaccel command: [ "start.sh", "microservices" ] volumes: - ${UPLOAD_LOCATION}:/usr/src/app/upload - /etc/localtime:/etc/localtime:ro env_file: - .env depends_on: - redis - database - typesense restart: always immich-machine-learning: container_name: immich_machine_learning image: ghcr.io/immich-app/immich-machine-learning:${IMMICH_VERSION:-release} volumes: - model-cache:/cache env_file: - .env restart: always - immich-web: - container_name: immich_web - image: ghcr.io/immich-app/immich-web:${IMMICH_VERSION:-release} - env_file: - - .env - restart: always typesense: container_name: immich_typesense image: typesense/typesense:0.24.1@sha256:9bcff2b829f12074426ca044b56160ca9d777a0c488303469143dd9f8259d4dd environment: - TYPESENSE_API_KEY=${TYPESENSE_API_KEY} - TYPESENSE_DATA_DIR=/data # remove this to get debug messages - GLOG_minloglevel=1 volumes: - tsdata:/data restart: always redis: container_name: immich_redis image: redis:6.2-alpine@sha256:3995fe6ea6a619313e31046bd3c8643f9e70f8f2b294ff82659d409b47d06abb restart: always database: container_name: immich_postgres image: postgres:14-alpine@sha256:50d9be76e9a90da4c781554955e0ffc79d9d5c4226838e64b36aacc97cbc35ad env_file: - .env environment: POSTGRES_PASSWORD: ${DB_PASSWORD} POSTGRES_USER: ${DB_USERNAME} POSTGRES_DB: ${DB_DATABASE_NAME} volumes: - pgdata:/var/lib/postgresql/data restart: always - immich-proxy: - container_name: immich_proxy - image: ghcr.io/ Warninimmich-app/immich-proxy:${IMMICH_VERSION:-release} - ports: - - 2283:8080 - depends_on: - - immich-server - - immich-web - restart: always volumes: pgdata: model-cache: tsdata:TLDR
Basically, the steps are:
Note
docker compose down --remove-orphansdocker-compose.ymlfile2.1. Remove
immich-proxyservice2.2. Remove
immich-webservice2.3. Expose port
2283:3001in theimmich-serverservicedocker compose pulldocker compose up -dUse with Reverse Proxy
All requests will now need to be forwarded to
ip:2283(external port) orimmich-server:3001(internal port). If you were previously routing requests to both web/server and stripping the api prefix, all of that can be replaced with a blanked forward to the immich-server container (no api stripping required).Gotcha
Warning
There is a new
name: immichdirective at the top of thedocker-compose.ymlto group the containers belonging to immich under one namespace (#4906).Please do not include this change in your current setup if you don't have it already.
Release v1.87 Warning
We will add a banner in the app for the admin user in the next release,
v1.87.0, to notify you of this upcoming change so you can prepare for the update and avoid downtime when upgrading.Note
This change will take effect starting version
v1.88.0Cheers!
Immich Team
Beta Was this translation helpful? Give feedback.
All reactions