diff --git a/README.md b/README.md index f4f8b19..9abd54e 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,22 @@ pip install -r requirements.txt PREVIEW_HOMESERVER=https://example.com python3 server.py ``` +### Example docker-compose.yml +```yaml +version: "3" +services: + url_previews: + environment: + - "PREVIEW_HOMESERVER=https://matrix.nexy7574.co.uk" + ports: + - "2226:2226" + restart: "unless-stopped" + container_name: "dendrite-url-previews" + volumes: + - ./data/:/app/data/ + build: . # there's no pre-built image +``` + ## Configuration The only configuration option is `PREVIEW_HOMESERVER`, which is the homeserver to use for the previews. If not specified, it defaults to the host name of the request URL, which may not work in some reverse-proxy