Skip to content

chore(docs): update Podman/Quadlets instructions link to a more up to date repo #20744

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

linux-universe
Copy link

Description

While I am thankful to Tbelway for creating instructions, I did not find them to be the most up-to-date or clearly arranged. So I've written my own! ;)

old instructions: https://github.com/tbelway/immich-podman-quadlets/blob/main/docs/install/podman-quadlet.md

mine: https://github.com/linux-universe/immich-podman-quadlets/blob/main/README.md

How Has This Been Tested?

I've tested everything not in the README mentioned as not tested on my own homeserver. On the things I couldn't test because of missing hardware, I took inspiration on Tbelways repo.

  • I have an homeserver running openSUSE microos with podman. I successfully tested it with rootful podman on it.

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation if applicable
  • I have no unrelated changes in the PR.
  • I have confirmed that any new dependencies are strictly necessary.
  • I have written tests for new code (if applicable)
  • I have followed naming conventions/patterns in the surrounding code
  • All code in src/services/ uses repositories implementations for database calls, filesystem operations, etc.
  • All code in src/repositories/ is pretty basic/simple and does not have any immich specific logic (that belongs in src/services/)

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Aug 7, 2025
Copy link
Contributor

github-actions bot commented Aug 7, 2025

Label error. Requires exactly 1 of: changelog:.*. Found: documentation. A maintainer will add the required label.

@bo0tzz
Copy link
Member

bo0tzz commented Aug 7, 2025

Have you tried contributing to tbelway's repo? I'm hesitant to get into changing out links every time someone thinks it needs improving ;)

@linux-universe
Copy link
Author

linux-universe commented Aug 7, 2025

Have you tried contributing to tbelway's repo? I'm hesitant to get into changing out links every time someone thinks it needs improving ;)

I've thought about it, but since our guides are structured very differently, I don’t think replacing most of someone else’s repository would be the right move.

For example, tbelway uses a single page with all the Quadlet files listed, while I’ve structured mine as individual .container files. Also, tbelway separates the microservices from the main server container, which is totally valid - but my goal is to stay as close as possible to the original Docker Compose setup from Immich. I believe that’s a more familiar and user-friendly approach for most people.

Because of these differences, I don’t think a pull request is the right way forward. Instead, as a compromise, we could rename tbelway’s entry in community-guides.tsx to something like "Podman/Quadlets Install (with separated Microservices)", and add a new entry for my guide: "Immich Podman Quadlet Base (with related wiki guides)"

Update:
Like the original Compose file, my setup aims to be a clean and unopinionated base. I’ve also created a public wiki where the community can build on this base by adding more advanced or opinionated features. So, for example, if someone wants to add OAuth support, instead of creating a whole new guide, they can just add a wiki page that extends the base setup. This way, we keep things organized, clean and expandable. https://github.com/linux-universe/immich-podman-quadlets/wiki

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants