From 2bb716531832896f5ff3196c07241502c409f11b Mon Sep 17 00:00:00 2001 From: aspezowka Date: Thu, 1 Oct 2020 09:57:27 -0600 Subject: [PATCH 1/3] Added info about server routing, i.e. /static/ vs / --- docs/servers/web-server.md | 26 +++++++++++++++++++------- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/docs/servers/web-server.md b/docs/servers/web-server.md index fd9ac1b9..5ad9321f 100644 --- a/docs/servers/web-server.md +++ b/docs/servers/web-server.md @@ -5,18 +5,19 @@ title: Web Server ENiGMA½ comes with a built in *content server* for supporting both HTTP and HTTPS. Currently the [File Bases](../modding/file-base-web-download-manager.md) registers routes for file downloads, password reset email links are handled via the server, and static files can also be served for your BBS. Other features will likely come in the future or you can easily write your own! # Configuration + By default the web server is not enabled. To enable it, you will need to at a minimum configure two keys in the `contentServers.web` section of `config.hjson`: ```hjson contentServers: { - web: { - domain: bbs.yourdomain.com + web: { + domain: bbs.yourdomain.com - http: { - enabled: true - port: 8080 - } - } + http: { + enabled: true + port: 8080 + } + } } ``` @@ -28,6 +29,7 @@ The following is a table of all configuration keys available under `contentServe | `overrideUrlPrefix` | :-1: | Instructs the system to be explicit when handing out URLs. Useful if your server is behind a transparent proxy. | ### HTTP Configuration + Entries available under `contentServers.web.http`: | Key | Required | Description | @@ -37,6 +39,7 @@ Entries available under `contentServers.web.http`: | `address` | :-1: | Sets an explicit bind address. | ### HTTPS Configuration + Entries available under `contentServers.web.https`: | Key | Required | Description | @@ -48,10 +51,19 @@ Entries available under `contentServers.web.https`: | `keyPem` | :+1: | Overrides the default certificate key path of `/config/https_cert_key.pem`. Key must be in PEM format. See **Certificates** below. | #### 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. ## Static Routes + Static files live relative to the `contentServers.web.staticRoot` path which defaults to `enigma-bbs/www`. +`index.html, favicon.ico`, and any error pages like `404.html` are accessible from the route path. Other static assets hosted by the web server must be referenced from `/static/`, for example: + +```html + Example Link +``` + ## Custom Error Pages + Customized error pages can be created for [HTTP error codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#4xx_Client_Error) by providing a `.html` file in the *static routes* area. For example: `404.html`. From 462593232c072bcf4c5eff6c3dc0125ff988e1cd Mon Sep 17 00:00:00 2001 From: aspezowka Date: Thu, 1 Oct 2020 10:05:39 -0600 Subject: [PATCH 2/3] Added some sparse documentation regarding home networking --- docs/installation/network.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/installation/network.md b/docs/installation/network.md index def09ad2..92e36f44 100644 --- a/docs/installation/network.md +++ b/docs/installation/network.md @@ -2,5 +2,12 @@ layout: page title: Network Setup --- -:zap: This page is to describe general information on how to set your router to forward traffic to ENiGMA. It -needs fleshing out, please submit a PR if you'd like to help! \ No newline at end of file +## Hosting an ENIGMA instance from your Home Network + +If you are hosting your ENGIMA instance from inside your local network, you'll need to open your chosen ports on your router, so people outside your local area network can access the BBS. + +Each router has a different way of doing this, but this [comprehensive resource](https://portforward.com/) explains how to port forward on most common brand routers. + +Secondly, it is likely that your public facing server IP is a [Dynamic Address](https://support.opendns.com/hc/en-us/articles/227987827-What-is-a-Dynamic-IP-Address-) automatically provisoned to you by your ISP. You can contact your ISP and request a static IP, but in some areas this isn't available to consumers, only businesses. + +Using a tool like [Duck DNS](https://www.duckdns.org/) will give you a free subdomain that automatically adjusts its records whenever your IP Address changes. \ No newline at end of file From ded575cf57ea448e5814cb1ab786f7d13ac02036 Mon Sep 17 00:00:00 2001 From: aspezowka Date: Thu, 1 Oct 2020 10:24:21 -0600 Subject: [PATCH 3/3] Added note about Certbots Privilege problems --- docs/servers/web-server.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/servers/web-server.md b/docs/servers/web-server.md index 5ad9321f..216efb6c 100644 --- a/docs/servers/web-server.md +++ b/docs/servers/web-server.md @@ -54,6 +54,8 @@ Entries available under `contentServers.web.https`: 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. +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 Static files live relative to the `contentServers.web.staticRoot` path which defaults to `enigma-bbs/www`.