main/mimic
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
cortex
2026-05-21 07:04:47 +00:00
parent bce505372a
commit 0cf16f40dd
1 changed files with 19 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+19 -4
View File
@@ -1,7 +1,12 @@
# mimic # MIMIC
**Modular Infrastructure for Matrix Integration & Configuration** **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. 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 ### What it deploys
@@ -49,10 +54,12 @@ mimic targets **Linux** and has only been tested on **Ubuntu 24.04**.
## Installation ## 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: Before running mimic, create **A records** pointing to your server's public IP for every subdomain you plan to use:
<span style="color: #fcd303">_Subdomains shown are defaults, custom values can be configured in the wizard._</span>
| Subdomain | Required? | Purpose | | Subdomain | Required? | Purpose |
|---|---|---| |---|---|---|
| `<domain>` | Always | Base Url | | `<domain>` | Always | Base Url |
@@ -63,8 +70,8 @@ Before running mimic, create **A records** pointing to your server's public IP f
| `jwt.<domain>` | If LiveKit is enabled | LiveKit JWT token issuer | | `jwt.<domain>` | If LiveKit is enabled | LiveKit JWT token issuer |
Example for `example.org` with server IP `203.0.113.42`: 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 matrix.example.org IN A 203.0.113.42
auth.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 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 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. 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 ### 2. Clone the repository