From d1b97f04fff17a5b552c9c2a41b28a1412b133eb Mon Sep 17 00:00:00 2001 From: Bryan Ashby Date: Mon, 9 Nov 2020 19:40:07 -0700 Subject: [PATCH] Fix table --- docs/servers/web-server.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/servers/web-server.md b/docs/servers/web-server.md index 216efb6c..75c7ea18 100644 --- a/docs/servers/web-server.md +++ b/docs/servers/web-server.md @@ -10,18 +10,19 @@ By default the web server is not enabled. To enable it, you will need to at a mi ```hjson contentServers: { - web: { - domain: bbs.yourdomain.com + web: { + domain: bbs.yourdomain.com - http: { - enabled: true - port: 8080 - } - } + http: { + enabled: true + port: 8080 + } + } } ``` The following is a table of all configuration keys available under `contentServers.web`: + | Key | Required | Description | |------|----------|-------------| | `domain` | :+1: | Sets the domain, e.g. `bbs.yourdomain.com`. | @@ -52,9 +53,9 @@ Entries available under `contentServers.web.https`: #### Certificates -If you don't have a TLS certificate for your domain, a good source for a certificate can be [LetsEncrypt](https://letsencrypt.org/) who supplies free and trusted TLS certificates. +If you don't have a TLS certificate for your domain, a good source for a certificate can be [Let's Encrypt](https://letsencrypt.org/) who supplies free and trusted TLS certificates. A common strategy is to place another web server such as [Caddy](https://caddyserver.com/) in front of ENiGMA½ acting as a transparent proxy and TLS termination point. -Keep in mind that the SSL certificate provided by Let's Encrypt's Certbot is by default stored in a privileged location; if your ENIGMA instance is not running as root (which it should not be!), you'll need to copy the SSL certificate somewhere else in order for ENIGMA to use it. +:information_source: Keep in mind that the SSL certificate provided by Let's Encrypt's Certbot is by default stored in a privileged location; if your ENIGMA instance is not running as root (which it should not be!), you'll need to copy the SSL certificate somewhere else in order for ENIGMA to use it. ## Static Routes