feat: Updates README
This commit is contained in:
17
README.md
17
README.md
@@ -1,3 +1,18 @@
|
||||
# caddy
|
||||
|
||||
Caddy reverse proxy.
|
||||
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`
|
||||
|
||||
Reference in New Issue
Block a user