From cb6ff9fea45937e5619ef74d870600a32588ae36 Mon Sep 17 00:00:00 2001
From: Hattshire <hattshire@gmail.com>
Date: Mon, 20 Oct 2025 12:22:30 -0300
Subject: [PATCH] Add Readme

---
 Readme.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 Readme.md

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..7b61630
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,14 @@
+# Service[reverse]: Reverse proxy for SSL and routing
+
+## Usage
+### Setup
+1. Set `ADMIN_EMAIL` in `.env`
+2. Run `docker compose up -d`
+3. ...
+4. Profit!
+
+### Services
+1. In the docker-compose file, add the `VIRTUAL_HOST` environment to each web-facing service (ports 80 and 433).
+2. In the docker-compose file, add the `LETSENCRYPT_HOST` environment to each service needing a certificate or web-exposed.
+3. If the web service is in a port different than `80` or `433`, set `VIRTUAL_PORT` and `VIRTUAL_PROTO`(http/https) in the environment section of the service.
+