From f3742095781c0d40a96488e525a42e7f9bd5b7af Mon Sep 17 00:00:00 2001 From: Michael Housh Date: Thu, 20 Mar 2025 13:34:16 -0400 Subject: [PATCH] feat: Updates README --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 23ad48f..0139b31 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,18 @@ # caddy -Caddy reverse proxy. \ No newline at end of file +Caddy reverse proxy, [caddy](https://caddyserver.com/docs/quick-starts/reverse-proxy) + +This repository includes the reverse-proxy for the domain's hosted under `*.housh.dev`. The primary +proxy is on the `main` branch, there are also proxies that run on each server, that can be found on +the other branches of this repository. + +This allows TLS to all backend services from the `primary` proxy. + +They all share the same `Dockerfile` and `compose.yaml` file, the only differences are the +`config/Caddyfile`. + +## Usage + +1. Clone the repository onto your host, or setup through your container manager (such as komodo). +2. Copy the `example.env` file to `.env` and update the environment variables. +3. Deploy the proxy `sudo docker compose --env-file .env up -d`