All apps · 0 apps
immich-public-proxy
Docker app from bg_hizzy's Repository
Overview
Readme
View on GitHubImmich Public Proxy
Share your Immich photos and albums in a safe way without exposing your Immich instance to the public.
This does not need an API key, or any privileged access to Immich. Setup takes less than a minute, and you never need to touch it again as all of your sharing stays managed within Immich.
See a Live demo gallery serving straight out of my own Immich instance.
About this project
Immich is a wonderful bit of software, but since it holds all your private photos it's best to keep it fully locked down. This presents a problem when you want to share a photo or a gallery with someone.
Immich Public Proxy provides a barrier of security between the public and Immich, and only allows through requests which you have publicly shared. It is stateless, needs no API key, and knows nothing about your Immich instance beyond what you have shared.
Read more in the Introduction, including
why not just expose Immich's /share/ path.
Visitors can optionally add their own photos and videos to a share, for example guests at a wedding. See Let visitors send photos back.
Quick start
- Download the docker-compose.yml file.
- Set
IMMICH_URLto the local (not public) URL of your Immich server, andPUBLIC_BASE_URLto the public URL of IPP. - Run
docker-compose up -dand check thathttps://photos.example.com/share/healthcheckresponds. - In Immich's Server Settings, set the "External domain" to your IPP URL. Every link Immich generates from now on points at the proxy.
If you use Cloudflare, set your /share/video/* path to Bypass Cache or videos may not play.
Full instructions, including Kubernetes: Installation.
Documentation
Everything is at docs.ipp.nz:
- Installation and Sharing from Immich
- Configuration: downloads, gallery layout, lightbox, metadata privacy, error responses
- Guides: let visitors send photos back, single domain with Immich, redirect your root domain to a share, securing Immich with mTLS
- Troubleshooting
Feature requests
You can add feature requests here.
IPP has read-only access to Immich and stores nothing: anything that needs an API key, modifies Immich, or would require storing a share key won't be considered. Visitor uploads are the one write path, and they live in their own optional container. See CONTRIBUTING.md for the full list.
Thanks
The gallery lightbox, with its zoom, swipe and keyboard navigation, is PhotoSwipe by Dmytro Semenov. It is a superb piece of work, MIT licensed, and IPP would be a much poorer viewer without it. If you find it useful, consider sponsoring the project.
Categories
Download Statistics
Total Downloads Over Time
Related apps
Explore more like this
Explore allLinks
Details
alangrainger/immich-public-proxy:latestRuntime arguments
- Web UI
http://[IP]:[PORT:3000]/healthcheck- Network
bridge- Shell
sh- Privileged
- false
Template configuration
local URL for Immich, http://immich-ip-address:8080.
- Target
- IMMICH_URL
- Default
- http://immich-ip-address:8080
- Value
- http://immich-ip-address:8080
Port to send requests, picked 3005 to stay out of other containers
- Target
- 3000
- Default
- 3005
- Value
- 3005