From 5732d8ed274a78a213fbd7c7de361f3e28070cea Mon Sep 17 00:00:00 2001
From: Tobias Schmidl <5060861-schtobia@users.noreply.gitlab.com>
Date: Tue, 28 Sep 2021 08:02:45 +0200
Subject: [PATCH] Added README, renamed the labels

---
 README.md          | 25 +++++++++++++++++++++++++
 docker-compose.yml |  8 ++++----
 2 files changed, 29 insertions(+), 4 deletions(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..29436b5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# quasselcore
+
+## Purpose
+
+[Quasselcore](https://quassel-irc.org/) works best with a real certificate. But if you have, like I have, a [traefik](https://traefik.io/) instance
+running, you should obtain your certificates from that instance. The combination of services in this `docker-compose` file ensures this.
+
+## Installation
+
+Very simple. Just fetch the `docker-compose` file and add your hostname (`QUASSEL_HOSTNAME`) to a local `.env` file:
+
+    $ echo "QUASSEL_HOSTNAME=example.local" > .env
+
+Best then to check if everything is okay:
+
+    $ docker-compose config -q && echo "Everything is fine."
+    Everything is fine.
+
+Then fire it up:
+
+    $ docker-compose up -d
+    Creating quasselcore_echo_1 ... done
+    Creating quasselcore_certdumper_1 ... done
+    Creating quassel-core             ... done
+
diff --git a/docker-compose.yml b/docker-compose.yml
index 956cae0..9615523 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -13,10 +13,10 @@ services:
     image: hashicorp/http-echo
     labels:
       - traefik.enable=true
-      - traefik.http.routers.schmidldev.entryPoints=websecure
-      - traefik.http.routers.schmidldev.middlewares=commonSSLHeaders
-      - traefik.http.routers.schmidldev.rule=Host(`${QUASSEL_HOSTNAME}`)
-      - traefik.http.routers.schmidldev.tls.certResolver=acmelive
+      - traefik.http.routers.quasselecho.entryPoints=websecure
+      - traefik.http.routers.quasselecho.middlewares=commonSSLHeaders
+      - traefik.http.routers.quasselecho.rule=Host(`${QUASSEL_HOSTNAME}`)
+      - traefik.http.routers.quasselecho.tls.certResolver=acmelive
 
   certdumper:
     image: humenius/traefik-certs-dumper