Add Readme

This commit is contained in:
Oliver Hattshire 2025-10-20 12:22:30 -03:00
parent 30b52a3025
commit cb6ff9fea4

14
Readme.md Normal file
View file

@ -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.