Skip to content

Commit

Permalink
Getting Started: Improve Traefik setup guide #186
Browse files Browse the repository at this point in the history
  • Loading branch information
lastzero committed Oct 1, 2024
1 parent 246205a commit b634576
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions docs/getting-started/proxies/traefik.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@
- WebSocket proxying automatically works
- [Traefik](https://doc.traefik.io/traefik/) can [create and update](https://doc.traefik.io/traefik/user-guides/docker-compose/acme-http/) [Let's Encrypt](https://letsencrypt.org/) HTTPS certificates for you

Our example shows a working configuration, excluding general PhotoPrism [config options](../config-options.md)
documented in [Setup Using Docker Compose](../docker-compose.md):
To run PhotoPrism behind Traefik, create a `traefik.yaml` configuration and then add a `traefik` service to your `compose.yaml` or `docker-compose.yml` file, as shown in the following example:

!!! example "compose.yaml"
```yaml
Expand Down Expand Up @@ -76,10 +75,9 @@ documented in [Setup Using Docker Compose](../docker-compose.md):
entryPoint: web
```

Further examples and a description of the config options can be found in the [documentation](https://doc.traefik.io/traefik/user-guides/docker-compose/basic-example/).
Note that you must disable [HTTPS/TLS](../using-https.md#1-https-reverse-proxy) in PhotoPrism by setting `PHOTOPRISM_DISABLE_TLS` to `"true"` as Traefik handles HTTPS connections, and that [all settings and config options](../config-options.md) not related to Traefik have been omitted for brevity.

!!! tldr ""
Note that, as explained in the [HTTPS documentation section](../using-https.md), Photoprism-generated TLS has to be disabled, because the internal communication between the service and the proxy should be unencrypted if the proxy is the HTTPS endpoint (unless the proxy uses a public network to access the service).
Further `traefik.yaml` examples and a description of the Traefik configuration options can be found in the [corresponding documentation](https://doc.traefik.io/traefik/user-guides/docker-compose/basic-example/).

### Why Use a Proxy? ###

Expand Down

0 comments on commit b634576

Please sign in to comment.