From 0cf16f40ddad635e8e505c3f7e27bdff4752faa1 Mon Sep 17 00:00:00 2001
From: cortex <1+cortex@noreply.localhost>
Date: Thu, 21 May 2026 07:04:47 +0000
Subject: [PATCH] Update README.md
---
README.md | 23 +++++++++++++++++++----
1 file changed, 19 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 8f1fde7..8272819 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,12 @@
-# mimic
-
+# MIMIC
**Modular Infrastructure for Matrix Integration & Configuration**
+> **Status:** Beta / Experimental
+> **Target OS:** Linux (Ubuntu/Debian recommended)
+> **License:** AGPL-3.0
+> **Maintainer:** Cortex@Fossgate
+> **Source:** [https://git.fossgate.uk/main/mimic](https://git.fossgate.uk/main/mimic)
+
mimic is an interactive deployment wizard for self-hosting a Matrix homeserver stack. It automates the provisioning and configuration of Synapse, the Matrix Authentication Service (MAS), PostgreSQL, reverse proxying, optional web clients, and Synapse workers — all driven from a single guided setup session.
### What it deploys
@@ -49,10 +54,12 @@ mimic targets **Linux** and has only been tested on **Ubuntu 24.04**.
## Installation
-### 1. Configure DNS
+### 1. Configure DNS and Firewall
Before running mimic, create **A records** pointing to your server's public IP for every subdomain you plan to use:
+ _Subdomains shown are defaults, custom values can be configured in the wizard._
+
| Subdomain | Required? | Purpose |
|---|---|---|
| `` | Always | Base Url |
@@ -63,8 +70,8 @@ Before running mimic, create **A records** pointing to your server's public IP f
| `jwt.` | If LiveKit is enabled | LiveKit JWT token issuer |
Example for `example.org` with server IP `203.0.113.42`:
- _Subdomains shown are defaults; custom values can be configured in the wizard._
```
+ example.org IN A 203.0.113.42
matrix.example.org IN A 203.0.113.42
auth.example.org IN A 203.0.113.42
app.example.org IN A 203.0.113.42
@@ -72,6 +79,14 @@ Before running mimic, create **A records** pointing to your server's public IP f
jwt.example.org IN A 203.0.113.42
```
+### Firewall Requirements
+| Port(s) | Protocol | Required For |
+|---|---|---|
+| 80 | TCP | Traefik ACME challenges |
+| 443 | TCP | HTTPS traffic |
+| 10000–20000 | UDP | LiveKit media (if enabled) |
+
+Adjust the UDP range via `LIVEKIT_UDP_RANGE` in `.env` if needed.
If using Traefik, ensure ports **80** and **443** are open — Traefik uses HTTP-01 ACME challenges for automatic TLS certificate provisioning.
### 2. Clone the repository