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

Update docs

Browse source
This commit is contained in:
Alan Grainger 2024-10-31 13:51:06 +01:00
parent 9b1538c23b
commit ad11453e01
1 changed files with 5 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -27,21 +27,20 @@ Here is an example setup for [securing Immich behind mTLS](./docs/securing-immic
## How to install with Docker ## How to install with Docker
1. Clone the repo: 1. Download the [docker-compose.yml](https://github.com/alangrainger/immich-public-proxy/blob/main/docker-compose.yml) file.
```bash
git clone https://github.com/alangrainger/immich-public-proxy.git
```
2. Create a `.env` file to configure the app. 2. Create a `.env` file to configure the app.
``` ```
IMMICH_URL=http://localhost:2283 IMMICH_URL=http://localhost:2283
PROXY_PUBLIC_URL=https://your-proxy-url.com
PORT=3000 PORT=3000
CACHE_AGE=2592000 CACHE_AGE=2592000
``` ```
- `IMMICH_URL` is the URL to access Immich in your local network. This is not your public URL. - `IMMICH_URL` is the URL to access Immich in your local network. This is not your public URL.
- `PROXY_PUBLIC_URL` is the public URL for your proxy.
- `PORT` is the external port you want for the docker container.
- `CACHE_AGE` this is setting the `cache-control` header, to tell the browser to cache the assets. Set to 0 to disable caching. - `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: 3. Start the docker container:
@ -50,7 +49,7 @@ CACHE_AGE=2592000
docker-compose up -d docker-compose up -d
``` ```
4. Set the "External domain" in your Immich **Server Settings** to be the same as the public URL for your Immich Public Proxy: 4. Set the "External domain" in your Immich **Server Settings** to be the same as the `PROXY_PUBLIC_URL`:
<img src="public/images/server-settings.png" width="400" height="182"> <img src="public/images/server-settings.png" width="400" height="182">
@ -111,5 +110,3 @@ however my goal with this project is to keep it as lean as possible.
Due to the sensitivity of data contained within Immich, I want anyone with a bit of coding knowledge Due to the sensitivity of data contained within Immich, I want anyone with a bit of coding knowledge
to be able to read this codebase and fully understand everything it is doing. to be able to read this codebase and fully understand everything it is doing.
## D