New Docker Compose Builder

[bo0tzz]

We've just released a new tool to build a docker-compose.yml for Immich! You can find it at https://immich.app/docker-compose-builder.

The reason we built this is to try and simplify the process of installing Immich, especially when needing customizations beyond the default compose file that we include in the repository. Using features like hardware acceleration and external libraries, or customizing the installation in various other ways, has always required manual edits based on snippets that are scattered throughout the docs. Along with the separate .env file which has proven unfamiliar to many self-hosters, this has caused plenty of confusion and trouble. The new tool aims to codify these nuances in a way that's easy to use, giving you a single file that's ready to go.

Please give it a try and let us know how it goes! Is it easy and intuitive to use? Does the generated file work properly for you? Are there any features you're missing?

[Yann-P]

Awesome!

[Janka55]

Awesome! I just learned about this project through AI, and it helped me get it deployed locally right away.

[hagenman]

Doesn't load for me, I get a 500 error.

[bo0tzz]

Is this still happening for you? I can't really think of any reasonable ways this could happen from our end.

[UnknownError235]

Would it be possible to put the selected options in the fragment instead of the url parameters, so that I don't have to send my config/database password to your servers when bookmarking.

[UnknownError235]

Also being able to specify a specific password would be nice for upgrading

[blarrbot]

works great! i was finally able to get rid of that damn .env file, which can get a bit annoying when using portainer stacks and watchtower. cheers, this really simplifies things for new users.

[mv-fs]

Good job, this is such a great tool for people who are not familiar with software deployment. Allows to get into self-hosting super easily!

[zwimer]

A few people here have been testing and so far, cap_drop: - ALL seems to work with user: 1000:1000; it's a lot more secure than letting the user have CAP_DAC_OVERRIDE by default too. There's a discord thread about it

[Im-hsh]

Interesting timing to see these mentions of dropping CAPs and read_only filesystem.
I’ve actually been running a similar setup for several months now without any issues.

Well before seeing this discussion :) I today did wrote a community guide here sharing my complete Immich Docker Compose setup, including:

read_only: true for all containers with caveats (tmpfs mounts & bind mounts)
cap_drop: ALL
no-new-privileges
frontend/backend network isolation

#31702 (comment)

The setup has been running flawlessly for months for the whole stack (Immich Server - Machine Learning - Valkey - Postgres)

Feel free to check it out and appreciate your feedback.

[budius]

Great tool, I'll transfer my compose.yml to it to move it to rootless mode.

My suggestion:
Considering Immich is such a memory and CPU intensive tool, it would be nice to have built-in the tool option to configure the deploy/resources for each container, something like:

        deploy:
            resources:
                limits:
                    cpus: '2.5'
                    memory: 2500mb
                reservations:
                    cpus: '1.8'
                    memory: 1800mb

[jonastr]

Yes, that would be great. I also limit resources of many containers on my home server, including Immich, to avoid noisy neighbors interfering with each other.

[bo0tzz]

To keep the thread readable, I've gone through this thread and hidden various feature-request-like comments that are either now implemented, or that are considered out of scope. Overall the idea behind this builder is to simplify things and output one coherent docker-compose.yml. That means we don't want to fill it up with all kinds of specific options for power users; everybody that wants to is still welcome (and expected) to make edits to the resulting file themselves!
If your comment was hidden without a direct response, don't consider it a value judgement, just some time savings in addressing everything centrally in this one comment :)

Thank you all very much for the great feedback, and please keep it coming!

[mgoerens]

The healthcheck test command for the redis container was recently changed to:

      test: redis-cli ping | grep -q PONG || exit 1

@bo0tzz FYI, I would imagine that the command on the builder should be updated to reflect that change.

[bo0tzz]

immich-app/static-pages#839

[sudoicezen]

would be nice to have a toggle so you can configure customer folder locations so the user can specify where they want each component of immich to be stored.

[bo0tzz]

This is already supported