c-l/immich-public-proxy
1
0
Fork 0
mirror of https://github.com/alangrainger/immich-public-proxy.git synced 2024-12-28 03:41:58 +00:00
Code Releases Activity

Update docs

Browse source
This commit is contained in:
Alan Grainger 2024-10-30 11:25:36 +01:00
parent efaa9ba20a
commit e6d056900c
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -9,7 +9,7 @@ Share your Immich photos and albums in a safe way without exposing your Immich i
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
**Immich Public Proxy** provides a barrier of security between the public and Immich, and _only_ allows through requests
which you have publicly shared. When it receives a valid request, it talks to Immich locally via API and returns only
those shared images.
@ -17,9 +17,9 @@ It exposes no ports, allows no incoming data, and has no API to exploit.
The ideal setup is to have Immich secured privately behind VPN or mTLS, and only allow public access to Immich Public Proxy.
[Live demo](https://immich-demo.note.sx/share/UiOulNielojwHbS0IJi5blwBOFzYC18CuPVtU23Bl3XK5YNVkbRONRT-HOTMQSMgdNs)
[Live demo](https://immich-demo.note.sx/share/ffSw63qnIYMtpmg0RNvOui0Dpio7BbxsObjvH8YZaobIjIAzl5n7zTX5d6EDHdOYEvo)
## How to install
## How to install with Docker
1. Clone the repo:
@ -37,8 +37,8 @@ CACHE_AGE=2592000
```
- `IMMICH_URL` is the URL to access Immich in your local network. This is not your public URL.
- `API_KEY` get this from the Account Settings page of your Immich user account
- `CACHE_AGE` by default, assets will be cached for 30 days. Set this to 0 to disable caching.
- `API_KEY` get this from the Account Settings page of your Immich user account.
- `CACHE_AGE` this is setting the `cache-control` header, to tell the browser to cache the assets. Set to 0 to disable caching.
3. Start the docker container:
@ -50,7 +50,7 @@ docker-compose up -d
<img src="public/images/server-settings.png" width="418" height="205">
Now whenever you share an image or gallery through Immich, it will automatically create the
Now whenever you share an image or gallery through Immich, it will automatically create the
correct public path for you.
## Configuration