Skip to content
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

docs: add example reverse proxy config for HA Proxy #12347

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

Conversation

linuxtim
Copy link

@linuxtim linuxtim commented Sep 5, 2024

Thanks for helping to maintain Immich and also for looking at this PR...

haproxy is a commonly used and long-standing high performance and full featured proxy and load balancer etc. etc. This PR adds instructions for configuring HA Proxy to provide access to Immich.

Since the availability and use of basic auth (see #6840 etc.) is not well documented, I also show the use of this in the sample config (along with instructions for how to omit that feature).

Thanks!

Tim.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Sep 5, 2024
@bo0tzz
Copy link
Member

bo0tzz commented Sep 5, 2024

Thanks for the PR! I think we want to keep the configurations on this page to the bare minimum without extra bits like basic auth or HTTPS, otherwise the page is going to overflow with those in no time. If you want to document a more elaborate configuration, feel free to write that up elsewhere and add a link to the community guides (https://immich.app/docs/community-guides).

Copy link
Contributor

github-actions bot commented Sep 5, 2024

📖 Documentation deployed to pr-12347.preview.immich.app

@danieldietzler danieldietzler changed the title Add example reverse proxy config for HA Proxy. docs: add example reverse proxy config for HA Proxy Sep 5, 2024
@mmomjian
Copy link
Contributor

mmomjian commented Sep 5, 2024

Thanks for the PR! I think we want to keep the configurations on this page to the bare minimum without extra bits like basic auth or HTTPS, otherwise the page is going to overflow with those in no time. If you want to document a more elaborate configuration, feel free to write that up elsewhere and add a link to the community guides (https://immich.app/docs/community-guides).

Agreed, especially since Basic auth doesn't work with our video player library. We should probably cut it down to only the backend immich_b_e section, with less intro comments - user should know how to add/configure their own proxy already.

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

Successfully merging this pull request may close these issues.

4 participants