From 96ba5c2b23ee73e99128a33318e650f9e3cd9d27 Mon Sep 17 00:00:00 2001
From: mclang <1721600+mclang@users.noreply.github.com>
Date: Thu, 1 Apr 2021 14:04:15 +0300
Subject: [PATCH] docker: Add docker-compose example (#7355)

Co-authored-by: bt90 <btom1990@googlemail.com>
---
 README-Docker.md | 29 ++++++++++++++++++++++++++++-
 1 file changed, 28 insertions(+), 1 deletion(-)

diff --git a/README-Docker.md b/README-Docker.md
index 123026696..c9bb74f7e 100644
--- a/README-Docker.md
+++ b/README-Docker.md
@@ -7,18 +7,45 @@ Use the `/var/syncthing` volume to have the synchronized files available on the
 host. You can add more folders and map them as you prefer.
 
 Note that Syncthing runs as UID 1000 and GID 1000 by default. These may be
-altered with the ``PUID`` and ``PGID`` environment variables.
+altered with the ``PUID`` and ``PGID`` environment variables. In addition
+the name of the Syncthing instance can be optionally defined by using
+``--hostname=syncthing`` parameter.
 
 ## Example Usage
 
+**Docker cli**
 ```
 $ docker pull syncthing/syncthing
 $ docker run --sysctl net.core.rmem_max=2097152 \
     -p 8384:8384 -p 22000:22000/tcp -p 22000:22000/udp \
     -v /wherever/st-sync:/var/syncthing \
+    --hostname=my-syncthing \
     syncthing/syncthing:latest
 ```
 
+**Docker compose**
+```
+---
+version: "3"
+services:
+  syncthing:
+    image: syncthing/syncthing
+    container_name: syncthing
+    hostname: my-syncthing
+    environment:
+      - PUID=1000
+      - PGID=1000
+    volumes:
+      - /wherever/st-sync:/var/syncthing
+    ports:
+      - 8384:8384
+      - 22000:22000/tcp
+      - 22000:22000/udp
+    sysctls:
+      - net.core.rmem_max=2097152
+    restart: unless-stopped
+```
+
 ## Discovery
 
 Note that local device discovery will not work with the above command,