From 1d121fb83cefe53bcd793a2871a8bba333760635 Mon Sep 17 00:00:00 2001
From: nex <me@nexy7574.co.uk>
Date: Sat, 10 Feb 2024 02:04:12 +0000
Subject: [PATCH] update README

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

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