Skip to content

Latest commit

 

History

History
64 lines (47 loc) · 3.19 KB

web-server.md

File metadata and controls

64 lines (47 loc) · 3.19 KB
Raw
layout title
page
Web Server

ENiGMA½ comes with a built in content server for supporting both HTTP and HTTPS. Currently the File Bases 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:

contentServers: {
    web: {
        domain: bbs.yourdomain.com

        http: {
            enabled: true
            port: 8080
        }
    }
}

The following is a table of all configuration keys available under contentServers.web:

Key Required Description
domain 👍 Sets the domain, e.g. bbs.yourdomain.com.
http 👎 Sub configuration for HTTP (non-secure) connections. See HTTP Configuration below.
overrideUrlPrefix 👎 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
enable 👍 Set to true to enable this server.
port 👎 Override the default port of 8080.
address 👎 Sets an explicit bind address.

HTTPS Configuration

Entries available under contentServers.web.https:

Key Required Description
enable 👍 Set to true to enable this server.
port 👎 Override the default port of 8080.
address 👎 Sets an explicit bind address.
certPem 👍 Overrides the default certificate path of /config/https_cert.pem. Certificate must be in PEM format. See Certificates below.
keyPem 👍 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 Let's Encrypt who supplies free and trusted TLS certificates. A common strategy is to place another web server such as Caddy 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.

Static Routes

Static files live relative to the contentServers.web.staticRoot path which defaults to enigma-bbs/www. This is also commonly known as your "public root".

Custom Error Pages

Customized error pages can be created for HTTP error codes by providing a <error_code>.html file in the static routes area. For example: 404.html.