From 8bee7fd31a8d868fb94bc40257e7ed7ebb625d13 Mon Sep 17 00:00:00 2001 From: Bryan Ashby Date: Sat, 19 Sep 2020 10:17:55 -0600 Subject: [PATCH 1/7] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 30 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++++++++ 2 files changed, 50 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..91f99583 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,30 @@ +--- +name: Bug report +about: Help improve ENiGMA½! +title: '' +labels: '' +assignees: '' + +--- + +**Describe the Bug** +A clear and concise description of what the :bug: bug is. + +**To Reproduce** +Any relevant steps to reproduce the behavior: + +**Expected Behavior** +A clear and concise description of what you expected to happen. + +**Actual Behavior** + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Environment** +* [ ] I am using Node.js v12.x LTS or higher +* [ ] `npm install` or `yarn` reports success +* Actual Node.js version (`node --version`): +* Operating system (`uname -a` on *nix systems): +* Revision (`git rev-parse --short HEAD`): +* Any additional relevant information about your setup diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..011200ae --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. Links to relevant specs such as FTN or documentation are appreciated if relevant. From e6448dab599aac4e58306b24c066650526eebbdd Mon Sep 17 00:00:00 2001 From: Bryan Ashby Date: Sat, 19 Sep 2020 10:18:48 -0600 Subject: [PATCH 2/7] Delete ISSUE_TEMPLATE.md Now using newer GitHub format --- .github/ISSUE_TEMPLATE.md | 16 ---------------- 1 file changed, 16 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index b6d1464a..00000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,16 +0,0 @@ -For :bug: bug reports, please fill out the information below plus any additional relevant information. If this is a feature request, feel free to clear the form. - -**Short problem description** - -**Environment** -- [ ] I am using Node.js v12.x LTS or higher -- [ ] `npm install` or `yarn` reports success -- Actual Node.js version (`node --version`): -- Operating system (`uname -a` on *nix systems): -- Revision (`git rev-parse --short HEAD`): - -**Expected behavior** - -**Actual behavior** - -**Steps to reproduce** From cffa11906ca7f96814be32bb2ccd37f22a3b1eff Mon Sep 17 00:00:00 2001 From: Bryan Ashby Date: Sat, 19 Sep 2020 20:22:43 -0600 Subject: [PATCH 3/7] Update README.md Add donate button, fingers crossed. --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a2bcee99..a3013a0c 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@ ENiGMA½ is a modern BBS software with a nostalgic flair! - ## Features Available Now * Multi platform: Anywhere [Node.js](https://nodejs.org/) runs likely works (known to work under Linux, FreeBSD, OpenBSD, OS X and Windows) * Unlimited multi node support (for all those BBS "callers"!) @@ -39,10 +38,10 @@ curl -o- https://raw.githubusercontent.com/NuSkooler/enigma-bbs/master/misc/inst Please see [Installation Methods](https://nuskooler.github.io/enigma-bbs/installation/installation-methods.html) for Windows, Docker, and so on... -## Known Issues -As of now this is considered **beta** code! Please **expect bugs** :bug: -- and when you find them, log issues and/or submit pull requests. With that said, the code is actually quite stable and is used by a number of boards. +## Donating +If you feel the urge to donate, [you can do so here](https://liberapay.com/NuSkooler/donate)
-See [the issue tracker](https://github.com/NuSkooler/enigma-bbs/issues) for more information. +Donate using Liberapay ## Support * Use [the issue tracker](https://github.com/NuSkooler/enigma-bbs/issues) From 2bb716531832896f5ff3196c07241502c409f11b Mon Sep 17 00:00:00 2001 From: aspezowka Date: Thu, 1 Oct 2020 09:57:27 -0600 Subject: [PATCH 4/7] 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 5/7] 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 6/7] 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`. From ea93199a10897cff38f12b0b6ef379bbb329c228 Mon Sep 17 00:00:00 2001 From: aspezowka Date: Thu, 1 Oct 2020 12:36:27 -0600 Subject: [PATCH 7/7] Added an additional digit to the hour slot, fixing minor spacing issue --- art/themes/luciano_blocktronics/theme.hjson | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/art/themes/luciano_blocktronics/theme.hjson b/art/themes/luciano_blocktronics/theme.hjson index f5dbbe30..407e8a1b 100644 --- a/art/themes/luciano_blocktronics/theme.hjson +++ b/art/themes/luciano_blocktronics/theme.hjson @@ -17,7 +17,7 @@ passwordChar: * dateTimeFormat: { - short: MMM Do h:mm a + short: MMM Do hh:mm a } } @@ -91,7 +91,7 @@ fullLoginSequenceOnelinerz: { config: { - dateTimeFormat: ddd h:mma + dateTimeFormat: ddd hh:mma } 0: { mci: { @@ -118,7 +118,7 @@ mainMenuUserAchievementsEarned: { config: { - dateTimeFormat: MMM Do h:mma + dateTimeFormat: MMM Do hh:mma achievementsInfoFormat10: "|00|07\"|11{title}|07\"" achievementsInfoFormat11: "|00|03{text}" } @@ -170,7 +170,7 @@ mainMenuLastCallers: { config: { - dateTimeFormat: MMM Do h:mma + dateTimeFormat: MMM Do hh:mma } mci: { VM1: { @@ -183,7 +183,7 @@ mainMenuUserList: { config: { - dateTimeFormat: MMM Do h:mma + dateTimeFormat: MMM Do hh:mma } mci: { VM1: { @@ -222,7 +222,7 @@ mainMenuOnelinerz: { config: { - dateTimeFormat: ddd h:mma + dateTimeFormat: ddd hh:mma } 0: { mci: { @@ -609,7 +609,7 @@ fullLoginSequenceLastCallers: { config: { - dateTimeFormat: MMM Do h:mma + dateTimeFormat: MMM Do hh:mma } mci: { VM1: {