mirror of
https://github.com/alangrainger/immich-public-proxy.git
synced 2024-12-29 12:21:57 +00:00
Update docs
This commit is contained in:
parent
02e5b5ad57
commit
5ec35ba103
2 changed files with 72 additions and 2 deletions
12
README.md
12
README.md
|
@ -19,7 +19,9 @@ Setup takes less than a minute, and you never need to touch it again as all of y
|
||||||
### Table of Contents
|
### Table of Contents
|
||||||
|
|
||||||
- [About this project](#about-this-project)
|
- [About this project](#about-this-project)
|
||||||
- [Install with Docker](#installation)
|
- [Installation](#installation)
|
||||||
|
- [Install with Docker](#install-with-docker--podman)
|
||||||
|
- [Install with Kubernetes](docs/kubernetes.md)
|
||||||
- [How to use it](#how-to-use-it)
|
- [How to use it](#how-to-use-it)
|
||||||
- [How it works](#how-it-works)
|
- [How it works](#how-it-works)
|
||||||
- [Additional configuration](#additional-configuration)
|
- [Additional configuration](#additional-configuration)
|
||||||
|
@ -57,6 +59,8 @@ Here is an example setup for [securing Immich behind mTLS](./docs/securing-immic
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
### Install with Docker / Podman
|
||||||
|
|
||||||
1. Download the [docker-compose.yml](https://github.com/alangrainger/immich-public-proxy/blob/main/docker-compose.yml) file.
|
1. Download the [docker-compose.yml](https://github.com/alangrainger/immich-public-proxy/blob/main/docker-compose.yml) file.
|
||||||
|
|
||||||
2. Update the value for `IMMICH_URL` in your docker-compose file to point to your local URL for Immich. This should not be a public URL.
|
2. Update the value for `IMMICH_URL` in your docker-compose file to point to your local URL for Immich. This should not be a public URL.
|
||||||
|
@ -77,12 +81,16 @@ Now whenever you share an image or gallery through Immich, it will automatically
|
||||||
🚨 **IMPORTANT**: If you're using Cloudflare, please make sure to set your `/share/video/*` path to Bypass Cache, otherwise you may
|
🚨 **IMPORTANT**: If you're using Cloudflare, please make sure to set your `/share/video/*` path to Bypass Cache, otherwise you may
|
||||||
run into video playback issues. See [Troubleshooting](#troubleshooting) for more information.
|
run into video playback issues. See [Troubleshooting](#troubleshooting) for more information.
|
||||||
|
|
||||||
### Running on a single domain
|
#### Running on a single domain
|
||||||
|
|
||||||
Because all IPP paths are under `/share/...`, you can run Immich Public Proxy and Immich on the same domain.
|
Because all IPP paths are under `/share/...`, you can run Immich Public Proxy and Immich on the same domain.
|
||||||
|
|
||||||
See the instructions here: [Running on a single domain](./docs/running-on-single-domain.md).
|
See the instructions here: [Running on a single domain](./docs/running-on-single-domain.md).
|
||||||
|
|
||||||
|
### Install with Kubernetes
|
||||||
|
|
||||||
|
[See the docs here](docs/kubernetes.md).
|
||||||
|
|
||||||
## How to use it
|
## How to use it
|
||||||
|
|
||||||
Other than the initial configuration above, everything else is managed through Immich.
|
Other than the initial configuration above, everything else is managed through Immich.
|
||||||
|
|
62
docs/kubernetes.md
Normal file
62
docs/kubernetes.md
Normal file
|
@ -0,0 +1,62 @@
|
||||||
|
# Install with Kubernetes
|
||||||
|
|
||||||
|
Thanks to [@vanchaxy](https://github.com/vanchaxy) for providing these docs.
|
||||||
|
|
||||||
|
See the [official Immich docs](https://immich.app/docs/install/kubernetes/) for additional information.
|
||||||
|
|
||||||
|
1. Add `app-template` chart to the dependencies. It's important to use the same `app-template` version as immich (1.4.0) if installing under the same umbrella chart.
|
||||||
|
```
|
||||||
|
apiVersion: v2
|
||||||
|
name: immich
|
||||||
|
version: 0.0.0
|
||||||
|
dependencies:
|
||||||
|
- name: immich
|
||||||
|
repository: https://immich-app.github.io/immich-charts
|
||||||
|
version: 0.9.0
|
||||||
|
- name: app-template
|
||||||
|
repository: https://bjw-s.github.io/helm-charts
|
||||||
|
version: 1.4.0
|
||||||
|
alias: immich-public-proxy
|
||||||
|
```
|
||||||
|
2. Add deployment and service to values.
|
||||||
|
```
|
||||||
|
immich:
|
||||||
|
# immich values
|
||||||
|
...
|
||||||
|
|
||||||
|
immich-public-proxy:
|
||||||
|
global:
|
||||||
|
nameOverride: public-proxy
|
||||||
|
|
||||||
|
env:
|
||||||
|
IMMICH_URL: http://immich-server:2283
|
||||||
|
|
||||||
|
image:
|
||||||
|
repository: alangrainger/immich-public-proxy
|
||||||
|
tag: 1.5.4
|
||||||
|
pullPolicy: IfNotPresent
|
||||||
|
|
||||||
|
service:
|
||||||
|
main:
|
||||||
|
enabled: true
|
||||||
|
primary: true
|
||||||
|
type: ClusterIP
|
||||||
|
ports:
|
||||||
|
http:
|
||||||
|
enabled: true
|
||||||
|
primary: true
|
||||||
|
port: 3000
|
||||||
|
protocol: HTTP
|
||||||
|
|
||||||
|
ingress:
|
||||||
|
main:
|
||||||
|
enabled: true
|
||||||
|
hosts:
|
||||||
|
- host: &host-share immich-share.local
|
||||||
|
paths:
|
||||||
|
- path: "/"
|
||||||
|
tls:
|
||||||
|
- secretName: immich-share-tls
|
||||||
|
hosts:
|
||||||
|
- *host-share
|
||||||
|
```
|
Loading…
Reference in a new issue