- « Production Installation
+ « Development Environment Setup
MENU
@@ -2300,7 +2325,7 @@
diff --git a/installation/testing.html b/installation/testing.html
index 7092189c..064b7ade 100644
--- a/installation/testing.html
+++ b/installation/testing.html
@@ -10,18 +10,18 @@
- « Production Installation
+ « Development Environment Setup
SysOp Setup »
diff --git a/configuration/directory-structure.html b/configuration/directory-structure.html
index a7161088..5b218bbb 100644
--- a/configuration/directory-structure.html
+++ b/configuration/directory-structure.html
@@ -10,18 +10,18 @@
Directory Structure | ENiGMA½ BBS Software
-
+
-
+
+{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"description":"All paths mentioned here are relative to the ENiGMA½ checkout directory.","url":"/enigma-bbs/configuration/directory-structure.html","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/configuration/directory-structure.html"},"headline":"Directory Structure","dateModified":"2023-08-30T21:37:29+00:00","datePublished":"2023-08-30T21:37:29+00:00","@context":"https://schema.org"}
@@ -285,6 +285,31 @@
+
+
+
+
+
+ Development Environment Setup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/configuration/email.html b/configuration/email.html
index 7bbca41f..fd78d52b 100644
--- a/configuration/email.html
+++ b/configuration/email.html
@@ -10,18 +10,18 @@
Email | ENiGMA½ BBS Software
-
+
-
+
+{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"description":"Email Support ENiGMA½ uses email to send password reset information to users. For it to work, you need to provide valid Nodemailer compatible email block in your config.hjson. Nodemailer supports SMTP in addition to many pre-defined services for ease of use. The transport block within email must be Nodemailer compatible.","url":"/enigma-bbs/configuration/email.html","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/configuration/email.html"},"headline":"Email","dateModified":"2023-08-30T21:37:29+00:00","datePublished":"2023-08-30T21:37:29+00:00","@context":"https://schema.org"}
@@ -285,6 +285,31 @@
+
+
+
+
+
+ Development Environment Setup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/configuration/event-scheduler.html b/configuration/event-scheduler.html
index 5ddda29a..3106e7ba 100644
--- a/configuration/event-scheduler.html
+++ b/configuration/event-scheduler.html
@@ -10,18 +10,18 @@
Event Scheduler | ENiGMA½ BBS Software
-
+
-
+
+{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"description":"Event Scheduler The ENiGMA½ scheduler allows system operators to configure arbitrary events that can can fire based on date and/or time, or by watching for changes in a file. Events can kick off internal handlers, custom modules, or binaries & scripts.","url":"/enigma-bbs/configuration/event-scheduler.html","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/configuration/event-scheduler.html"},"headline":"Event Scheduler","dateModified":"2023-08-30T21:37:29+00:00","datePublished":"2023-08-30T21:37:29+00:00","@context":"https://schema.org"}
@@ -285,6 +285,31 @@
+
+
+
+
+
+ Development Environment Setup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/configuration/external-binaries.html b/configuration/external-binaries.html
index b5ef272b..1ec35493 100644
--- a/configuration/external-binaries.html
+++ b/configuration/external-binaries.html
@@ -10,18 +10,18 @@
External Support Binaries | ENiGMA½ BBS Software
-
+
-
+
+{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"description":"External Support Binaries ENiGMA½ relies on various external binaries in order to perform common tasks such as processing file archives and extracting information from uploads/file imports, some legacy transfer protocols, etc.","url":"/enigma-bbs/configuration/external-binaries.html","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/configuration/external-binaries.html"},"headline":"External Support Binaries","dateModified":"2023-08-30T21:37:29+00:00","datePublished":"2023-08-30T21:37:29+00:00","@context":"https://schema.org"}
@@ -285,6 +285,31 @@
+
+
+
+
+
+ Development Environment Setup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/configuration/file-transfer-protocols.html b/configuration/file-transfer-protocols.html
index bf05be9d..3435af2e 100644
--- a/configuration/file-transfer-protocols.html
+++ b/configuration/file-transfer-protocols.html
@@ -10,18 +10,18 @@
File Transfer Protocols | ENiGMA½ BBS Software
-
+
-
+
+{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"description":"ENiGMA½ currently relies on external executable binaries for “legacy” file transfer protocols such as X, Y, and ZModem. Remember that ENiGMA½ also support modern web (HTTP/HTTPS) downloads!","url":"/enigma-bbs/configuration/file-transfer-protocols.html","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/configuration/file-transfer-protocols.html"},"headline":"File Transfer Protocols","dateModified":"2023-08-30T21:37:29+00:00","datePublished":"2023-08-30T21:37:29+00:00","@context":"https://schema.org"}
@@ -285,6 +285,31 @@
+
+
+
+
+
+ Development Environment Setup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/configuration/hjson.html b/configuration/hjson.html
index 7c0dc86c..8fee96a4 100644
--- a/configuration/hjson.html
+++ b/configuration/hjson.html
@@ -10,18 +10,18 @@
HJSON Config Files | ENiGMA½ BBS Software
-
+
-
+
+{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"description":"JSON for Humans! HJSON is the configuration file format used by ENiGMA½ for System Configuration, Menus, etc. HJSON is is JSON for humans!","url":"/enigma-bbs/configuration/hjson.html","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/configuration/hjson.html"},"headline":"HJSON Config Files","dateModified":"2023-08-30T21:37:29+00:00","datePublished":"2023-08-30T21:37:29+00:00","@context":"https://schema.org"}
@@ -285,6 +285,31 @@
+
+
+
+
+
+ Development Environment Setup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/configuration/menu-hjson.html b/configuration/menu-hjson.html
index 15176e37..7e335a37 100644
--- a/configuration/menu-hjson.html
+++ b/configuration/menu-hjson.html
@@ -10,18 +10,18 @@
Menu HSJON | ENiGMA½ BBS Software
-
+
-
+
+{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"description":"Menu HJSON The core of a ENiGMA½ based BBS is it’s menus driven by what will be referred to as menu.hjson. Throughout ENiGMA½ documentation, when menu.hjson is referenced, we’re actually talking about config/menus/yourboardname-*.hjson. These files determine the menus (or screens) a user can see, the order they come in, how they interact with each other, ACS configuration, and so on. Like all configuration within ENiGMA½, menu configuration is done in HJSON format.","url":"/enigma-bbs/configuration/menu-hjson.html","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/configuration/menu-hjson.html"},"headline":"Menu HSJON","dateModified":"2023-08-30T21:37:29+00:00","datePublished":"2023-08-30T21:37:29+00:00","@context":"https://schema.org"}
@@ -285,6 +285,31 @@
+
+
+
+
+
+ Development Environment Setup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/configuration/security.html b/configuration/security.html
index 39e5b8be..3b16b443 100644
--- a/configuration/security.html
+++ b/configuration/security.html
@@ -10,18 +10,18 @@
Security | ENiGMA½ BBS Software
-
+
-
+
+{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"description":"Security Unlike in the golden era of BBSing, modern Internet-connected systems are prone to hacking attempts, eavesdropping, etc. While plain-text passwords, insecure data over Plain Old Telephone Service (POTS), and so on was good enough then, modern systems must employ protections against attacks. ENiGMA½ comes with many security features that help keep the system and your users secure — not limited to: Passwords are never stored in plain-text, but instead are stored using Password-Based Key Derivation Function 2 (PBKDF2). Even the system operator can never know your password! Alternatives to insecure Telnet logins are built in: SSH and secure WebSockets for example. A built in web server with TLS support (aka HTTPS). Optional Two-Factor Authentication (2FA) via One-Time-Password (OTP) for users, supporting Google Authenticator, Time-Based One-Time Password Algorithm (TOTP, RFC-6238), and HMAC-Based One-Time Password Algorithm (HOTP, RFC-4266).","url":"/enigma-bbs/configuration/security.html","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/configuration/security.html"},"headline":"Security","dateModified":"2023-08-30T21:37:29+00:00","datePublished":"2023-08-30T21:37:29+00:00","@context":"https://schema.org"}
@@ -285,6 +285,31 @@
+
+
+
+
+
+ Development Environment Setup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/configuration/sysop-setup.html b/configuration/sysop-setup.html
index df1670a0..fc3a5594 100644
--- a/configuration/sysop-setup.html
+++ b/configuration/sysop-setup.html
@@ -10,18 +10,18 @@
SysOp Setup | ENiGMA½ BBS Software
-
+
-
+
+{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"description":"SySop privileges will be granted to the first user to log into a fresh ENiGMA½ installation. +ops belong to the sysop user group by default.","url":"/enigma-bbs/configuration/sysop-setup.html","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/configuration/sysop-setup.html"},"headline":"SysOp Setup","dateModified":"2023-08-30T21:37:29+00:00","datePublished":"2023-08-30T21:37:29+00:00","@context":"https://schema.org"}
@@ -285,6 +285,31 @@
+
+
+
+
+
+ Development Environment Setup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/filebase/acs.html b/filebase/acs.html
index d3cc4c35..3bdfde9f 100644
--- a/filebase/acs.html
+++ b/filebase/acs.html
@@ -10,18 +10,18 @@
ACS | ENiGMA½ BBS Software
-
+
-
+
+{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"description":"File Base ACS ACS Codes may be used to control access to File Base areas by specifying an acs string in a file area’s definition. If no acs is supplied in a file area definition, the following defaults apply to an area: read : GM[users]: List/view the area and it’s contents. write : GM[sysops]: Upload. download : GM[users]: Download.","url":"/enigma-bbs/filebase/acs.html","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/filebase/acs.html"},"headline":"ACS","dateModified":"2023-08-30T21:37:29+00:00","datePublished":"2023-08-30T21:37:29+00:00","@context":"https://schema.org"}
@@ -285,6 +285,31 @@
+
+
+
+
+
+ Development Environment Setup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/filebase/first-file-area.html b/filebase/first-file-area.html
index f23500b9..fe76616d 100644
--- a/filebase/first-file-area.html
+++ b/filebase/first-file-area.html
@@ -10,18 +10,18 @@
Configuring a File Base | ENiGMA½ BBS Software
-
+
-
+
+{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"description":"Configuring a File Base ENiGMA½ offers a powerful and flexible file base. Configuration of file the file base and areas is handled via the fileBase section of config.hjson.","url":"/enigma-bbs/filebase/first-file-area.html","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/filebase/first-file-area.html"},"headline":"Configuring a File Base","dateModified":"2023-08-30T21:37:29+00:00","datePublished":"2023-08-30T21:37:29+00:00","@context":"https://schema.org"}
@@ -285,6 +285,31 @@
+
+
+
+
+
+ Development Environment Setup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/filebase/index.html b/filebase/index.html
index f4427761..5ba73f3c 100644
--- a/filebase/index.html
+++ b/filebase/index.html
@@ -10,18 +10,18 @@
About File Areas | ENiGMA½ BBS Software
-
+
-
+
+{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"description":"About File Areas","url":"/enigma-bbs/filebase/","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/filebase/"},"headline":"About File Areas","dateModified":"2023-08-30T21:37:29+00:00","datePublished":"2023-08-30T21:37:29+00:00","@context":"https://schema.org"}
@@ -285,6 +285,31 @@
+
+
+
+
+
+ Development Environment Setup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/filebase/network-mounts-and-symlinks.html b/filebase/network-mounts-and-symlinks.html
index 9c08e161..f3cb6c51 100644
--- a/filebase/network-mounts-and-symlinks.html
+++ b/filebase/network-mounts-and-symlinks.html
@@ -10,18 +10,18 @@
Network Mounts & Symlinks | ENiGMA½ BBS Software
-
+
-
+
+{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"description":"Network Mounts & Symlinks With many Bulletin Board Systems running on small headless boxes such as Raspberry Pis, it may not be practical to have all files you would like to make available in your file base. One solution to this is to utilize network mounts. Add in symbolic links to make things even easier!","url":"/enigma-bbs/filebase/network-mounts-and-symlinks.html","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/filebase/network-mounts-and-symlinks.html"},"headline":"Network Mounts & Symlinks","dateModified":"2023-08-30T21:37:29+00:00","datePublished":"2023-08-30T21:37:29+00:00","@context":"https://schema.org"}
@@ -285,6 +285,31 @@
+
+
+
+
+
+ Development Environment Setup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/filebase/tic-support.html b/filebase/tic-support.html
index 6dca4017..8a7f9280 100644
--- a/filebase/tic-support.html
+++ b/filebase/tic-support.html
@@ -10,18 +10,18 @@
TIC Support | ENiGMA½ BBS Software
-
+
-
+
+{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"description":"TIC Support ENiGMA½ supports FidoNet-Style TIC file attachments by mapping TIC areas to local file areas.","url":"/enigma-bbs/filebase/tic-support.html","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/filebase/tic-support.html"},"headline":"TIC Support","dateModified":"2023-08-30T21:37:29+00:00","datePublished":"2023-08-30T21:37:29+00:00","@context":"https://schema.org"}
@@ -285,6 +285,31 @@
+
+
+
+
+
+ Development Environment Setup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/filebase/uploads.html b/filebase/uploads.html
index df2db464..a4a2c9d2 100644
--- a/filebase/uploads.html
+++ b/filebase/uploads.html
@@ -10,18 +10,18 @@
Uploads | ENiGMA½ BBS Software
-
+
-
+
+{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"description":"Uploads The default ACS for file areas in ENiGMA½ is to allow regular users ‘read’ and sysops ‘read/write’. Read ACS includes listing and downloading while write allows for uploading. See File Base ACS for more information.","url":"/enigma-bbs/filebase/uploads.html","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/filebase/uploads.html"},"headline":"Uploads","dateModified":"2023-08-30T21:37:29+00:00","datePublished":"2023-08-30T21:37:29+00:00","@context":"https://schema.org"}
@@ -285,6 +285,31 @@
+
+
+
+
+
+ Development Environment Setup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/filebase/web-access.html b/filebase/web-access.html
index 3c69255d..fbd16c7f 100644
--- a/filebase/web-access.html
+++ b/filebase/web-access.html
@@ -10,18 +10,18 @@
Web Access | ENiGMA½ BBS Software
-
+
-
+
+{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"description":"Temporary web HTTP(S) URLs can be used to download files using the built in web server. Temporary links expire after fileBase::web::expireMinutes (default 24 hours). The full URL given to users is built using contentServers::web::domain and will default to HTTPS (https://) if enabled with a fallback to HTTP. The end result is users are given a temporary web link that may look something like this: https://xibalba.l33t.codes:44512/f/h7JK","url":"/enigma-bbs/filebase/web-access.html","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/filebase/web-access.html"},"headline":"Web Access","dateModified":"2023-08-30T21:37:29+00:00","datePublished":"2023-08-30T21:37:29+00:00","@context":"https://schema.org"}
@@ -285,6 +285,31 @@
+
+
+
+
+
+ Development Environment Setup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/index.html b/index.html
index 914d09e9..68fd7f3a 100644
--- a/index.html
+++ b/index.html
@@ -10,7 +10,7 @@
Home | ENiGMA½ BBS Software
-
+
@@ -19,7 +19,7 @@
+{"name":"ENiGMA½ BBS Software","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"description":"ENiGMA½ BBS is modern open source BBS software with a nostalgic flair, written in Node.js.","url":"/enigma-bbs/","@type":"WebSite","headline":"Home","@context":"https://schema.org"}
@@ -285,6 +285,31 @@
+
+
+
+
+
+ Development Environment Setup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/installation/development.html b/installation/development.html
new file mode 100644
index 00000000..64765813
--- /dev/null
+++ b/installation/development.html
@@ -0,0 +1,2369 @@
+
+
+
+
+
+
+
+
+
+
+
+Development Environment Setup | ENiGMA½ BBS Software
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Docker | ENiGMA½ BBS Software
-
+
-
+
+{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"description":":warning: You’ll need Docker installed before going any further. How to do so are out of scope of these docs, but you can find full instructions for every operating system on the Docker website.","url":"/enigma-bbs/installation/docker.html","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/installation/docker.html"},"headline":"Docker","dateModified":"2023-08-30T21:37:29+00:00","datePublished":"2023-08-30T21:37:29+00:00","@context":"https://schema.org"}
@@ -285,6 +285,31 @@
+
+
+
+
+
+ Development Environment Setup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/installation/hardware/rpi.html b/installation/hardware/rpi.html
index a2bfcd3b..363822b8 100644
--- a/installation/hardware/rpi.html
+++ b/installation/hardware/rpi.html
@@ -10,18 +10,18 @@
Raspberry Pi | ENiGMA½ BBS Software
-
+
-
+
+{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"description":"All Raspberry Pi models work great with ENiGMA½! Keep in mind compiling the dependencies with npm install will take some time and may appear to hang. It’s still working - just be patient and let it complete.","url":"/enigma-bbs/installation/hardware/rpi.html","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/installation/hardware/rpi.html"},"headline":"Raspberry Pi","dateModified":"2023-08-30T21:37:29+00:00","datePublished":"2023-08-30T21:37:29+00:00","@context":"https://schema.org"}
@@ -285,6 +285,31 @@
+
+
+
+
+
+ Development Environment Setup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/installation/hardware/windows.html b/installation/hardware/windows.html
index 8c6dfd05..a36ace95 100644
--- a/installation/hardware/windows.html
+++ b/installation/hardware/windows.html
@@ -10,18 +10,18 @@
Installation Under Windows | ENiGMA½ BBS Software
-
+
-
+
+{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"description":"Installation Under Windows","url":"/enigma-bbs/installation/hardware/windows.html","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/installation/hardware/windows.html"},"headline":"Installation Under Windows","dateModified":"2023-08-30T21:37:29+00:00","datePublished":"2023-08-30T21:37:29+00:00","@context":"https://schema.org"}
@@ -285,6 +285,31 @@
+
+
+
+
+
+ Development Environment Setup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/installation/install-script.html b/installation/install-script.html
index 32b5877a..d7939e5d 100644
--- a/installation/install-script.html
+++ b/installation/install-script.html
@@ -10,18 +10,18 @@
Install Script | ENiGMA½ BBS Software
-
+
-
+
+{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"description":"Install Script Under most Linux/UNIX like environments (Linux, BSD, OS X, …) new users can simply execute the install.sh script to get everything up and running. Cut + paste the following into your terminal:","url":"/enigma-bbs/installation/install-script.html","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/installation/install-script.html"},"headline":"Install Script","dateModified":"2023-08-30T21:37:29+00:00","datePublished":"2023-08-30T21:37:29+00:00","@context":"https://schema.org"}
@@ -285,6 +285,31 @@
+
+
+
+
+
+ Development Environment Setup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/installation/installation-methods.html b/installation/installation-methods.html
index 8702fc0a..bb3f4b63 100644
--- a/installation/installation-methods.html
+++ b/installation/installation-methods.html
@@ -10,18 +10,18 @@
Installation Methods | ENiGMA½ BBS Software
-
+
-
+
+{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"description":"Installation Methods There are multiple ways of installing ENiGMA BBS, depending on your level of experience and desire to do things manually versus have it automated for you.","url":"/enigma-bbs/installation/installation-methods.html","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/installation/installation-methods.html"},"headline":"Installation Methods","dateModified":"2023-08-30T21:37:29+00:00","datePublished":"2023-08-30T21:37:29+00:00","@context":"https://schema.org"}
@@ -285,6 +285,31 @@
+
+
+
+
+
+ Development Environment Setup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/installation/manual.html b/installation/manual.html
index d52bc9cb..155b75df 100644
--- a/installation/manual.html
+++ b/installation/manual.html
@@ -10,18 +10,18 @@
Manual Installation | ENiGMA½ BBS Software
-
+
-
+
+{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"description":"For Linux environments it’s recommended you run the install script. If you like to do things manually, read on…","url":"/enigma-bbs/installation/manual.html","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/installation/manual.html"},"headline":"Manual Installation","dateModified":"2023-08-30T21:37:29+00:00","datePublished":"2023-08-30T21:37:29+00:00","@context":"https://schema.org"}
@@ -285,6 +285,31 @@
+
+
+
+
+
+ Development Environment Setup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/installation/network.html b/installation/network.html
index 4643fcc2..f60d6bbf 100644
--- a/installation/network.html
+++ b/installation/network.html
@@ -10,18 +10,18 @@
Network Setup | ENiGMA½ BBS Software
-
+
-
+
+{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"description":"Hosting an ENiGMA instance from your Home Network","url":"/enigma-bbs/installation/network.html","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/installation/network.html"},"headline":"Network Setup","dateModified":"2023-08-30T21:37:29+00:00","datePublished":"2023-08-30T21:37:29+00:00","@context":"https://schema.org"}
@@ -285,6 +285,31 @@
+
+
+
+
+
+ Development Environment Setup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/installation/production.html b/installation/production.html
index 6d7b13b7..aed6bef2 100644
--- a/installation/production.html
+++ b/installation/production.html
@@ -10,18 +10,18 @@
Production Installation | ENiGMA½ BBS Software
-
+
-
+
+{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"description":"If you’ve become convinced you would like a “production” BBS running ENiGMA½ a more advanced installation may be in order.","url":"/enigma-bbs/installation/production.html","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/installation/production.html"},"headline":"Production Installation","dateModified":"2023-08-30T21:37:29+00:00","datePublished":"2023-08-30T21:37:29+00:00","@context":"https://schema.org"}
@@ -285,6 +285,31 @@
+
+
+
+
+
+ Development Environment Setup
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -2279,7 +2304,7 @@
MENU
- Creating Initial Config Files »
+ Development Environment Setup »
@@ -2302,7 +2327,7 @@ Additionally, it is suggested that you run as a specific more locked down user (
« Testing Your Installation
- Creating Initial Config Files »
+ Development Environment Setup »
+
+
+
+
+
diff --git a/installation/docker.html b/installation/docker.html
index 3acf8b99..c17652a8 100644
--- a/installation/docker.html
+++ b/installation/docker.html
@@ -10,18 +10,18 @@
+
+
+ +
+ 
+
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Installation +
- Installation Methods + + + + + + + + + + + + + + + + + + + + + + + + +
- Install Script + + + + + + + + + + + + + + + + + + + + + + + + +
- Docker + + + + + + + + + + + + + + + + + + + + + + + + +
- Manual Installation + + + + + + + + + + + + + + + + + + + + + +
- OS / Hardware Specific +
- Raspberry Pi + + + + + + + + + + + + + + + + + + + + + + + + +
- Installation Under Windows + + + + + + + + + + + + + + + + + +
- Network Setup + + + + + + + + + + + + + + + + + + + + + + + + +
- Testing Your Installation + + + + + + + + + + + + + + + + + + + + + + + + +
- Production Installation + + + + + + + + + + + + + + + + + + + + + + + + +
- Development Environment Setup + + + + + + + + + + + + + + + + + + + + +
- Configuration +
- Creating Initial Config Files + + + + + + + + + + + + + + + + + + + + + + + + +
- SysOp Setup + + + + + + + + + + + + + + + + + + + + + + + + +
- Configuration Files + + + + + + + + + + + + + + + + + + + + + + + + +
- System Configuration + + + + + + + + + + + + + + + + + + + + + + + + +
- HJSON Config Files + + + + + + + + + + + + + + + + + + + + + + + + +
- Menu HSJON + + + + + + + + + + + + + + + + + + + + + + + + +
- Directory Structure + + + + + + + + + + + + + + + + + + + + + + + + +
- External Support Binaries + + + + + + + + + + + + + + + + + + + + + + + + +
- Archivers + + + + + + + + + + + + + + + + + + + + + + + + +
- File Transfer Protocols + + + + + + + + + + + + + + + + + + + + + + + + +
- Colour Codes + + + + + + + + + + + + + + + + + + + + + + + + +
- Event Scheduler + + + + + + + + + + + + + + + + + + + + + + + + +
- Access Condition System (ACS) + + + + + + + + + + + + + + + + + + + + + + + + +
- Security + + + + + + + + + + + + + + + + + + + + +
- Miscellaneous +
- User Interruptions + + + + + + + + + + + + + + + + + + + + +
- File Base +
- About File Areas + + + + + + + + + + + + + + + + + + + + + + + + +
- Configuring a File Base + + + + + + + + + + + + + + + + + + + + + + + + +
- ACS + + + + + + + + + + + + + + + + + + + + + + + + +
- Uploads + + + + + + + + + + + + + + + + + + + + + + + + +
- Web Access + + + + + + + + + + + + + + + + + + + + + + + + +
- TIC Support + + + + + + + + + + + + + + + + + + + + + + + + +
- Network Mounts & Symlinks + + + + + + + + + + + + + + + + + + + + +
- Message Areas +
- Message Base + + + + + + + + + + + + + + + + + + + + + + + + +
- Message Networks + + + + + + + + + + + + + + + + + + + + + + + + +
- BSO Import / Export + + + + + + + + + + + + + + + + + + + + + + + + +
- Netmail + + + + + + + + + + + + + + + + + + + + + + + + +
- QWK Support + + + + + + + + + + + + + + + + + + + + + + + + +
- FidoNet-Style Networks (FTN) + + + + + + + + + + + + + + + + + + + + +
- Art +
- General Art Information + + + + + + + + + + + + + + + + + + + + + + + + +
- Themes + + + + + + + + + + + + + + + + + + + + + + + + +
- MCI Codes + + + + + + + + + + + + + + + + + + + + + +
- Views +
- Button View + + + + + + + + + + + + + + + + + + + + + + + + +
- Edit Text View + + + + + + + + + + + + + + + + + + + + + + + + +
- Full Menu View + + + + + + + + + + + + + + + + + + + + + + + + +
- Horizontal Menu View + + + + + + + + + + + + + + + + + + + + + + + + +
- Mask Edit Text View + + + + + + + + + + + + + + + + + + + + + + + + +
- Multi Line Edit Text View + + + + + + + + + + + + + + + + + + + + + + + + +
- Spinner Menu View + + + + + + + + + + + + + + + + + + + + + + + + +
- Text View + + + + + + + + + + + + + + + + + + + + + + + + +
- Toggle Menu View + + + + + + + + + + + + + + + + + + + + + + + + +
- Vertical Menu View + + + + + + + + + + + + + + + + + +
- Servers +
- Login Servers +
- Telnet Server + + + + + + + + + + + + + + + + + + + + + + + + +
- SSH Server + + + + + + + + + + + + + + + + + + + + + + + + +
- Web Socket / Web Interface Server + + + + + + + + + + + + + + + + + +
- Content Servers +
- Web Server + + + + + + + + + + + + + + + + + + + + + + + + +
- Gopher Server + + + + + + + + + + + + + + + + + + + + + + + + +
- NNTP Server + + + + + + + + + + + + + + + + + +
- Modding +
- Local Doors + + + + + + + + + + + + + + + + + + + + + + + + +
- Door Servers + + + + + + + + + + + + + + + + + + + + + + + + +
- Telnet Bridge + + + + + + + + + + + + + + + + + + + + + + + + +
- Existing Mods + + + + + + + + + + + + + + + + + + + + + + + + +
- File Area List + + + + + + + + + + + + + + + + + + + + + + + + +
- Last Callers + + + + + + + + + + + + + + + + + + + + + + + + +
- Who's Online + + + + + + + + + + + + + + + + + + + + + + + + +
- User List + + + + + + + + + + + + + + + + + + + + + + + + +
- Message Conference List + + + + + + + + + + + + + + + + + + + + + + + + +
- Message Area List + + + + + + + + + + + + + + + + + + + + + + + + +
- BBS List + + + + + + + + + + + + + + + + + + + + + + + + +
- Rumorz + + + + + + + + + + + + + + + + + + + + + + + + +
- File Transfer Protocol Select + + + + + + + + + + + + + + + + + + + + + + + + +
- Onelinerz + + + + + + + + + + + + + + + + + + + + + + + + +
- The Show Art Module + + + + + + + + + + + + + + + + + + + + + + + + +
- File Base Download Manager + + + + + + + + + + + + + + + + + + + + + + + + +
- File Base Web Download Manager + + + + + + + + + + + + + + + + + + + + + + + + +
- Set Newscan Date Module + + + + + + + + + + + + + + + + + + + + + + + + +
- Node to Node Messaging + + + + + + + + + + + + + + + + + + + + + + + + +
- TopX + + + + + + + + + + + + + + + + + + + + + + + + +
- 2FA/OTP Config + + + + + + + + + + + + + + + + + + + + + + + + +
- Auto Signature Editor + + + + + + + + + + + + + + + + + + + + + + + + +
- Menu Modules + + + + + + + + + + + + + + + + + + + + +
- Administration +
- Administration + + + + + + + + + + + + + + + + + + + + +
- Modding +
- Waiting For Caller (WFC) + + + + + + + + + + + + + + + + + + + + +
- Administration +
- oputil + + + + + + + + + + + + + + + + + + + + + + + + +
- Updating + + + + + + + + + + + + + + + + + + + + +
- Troubleshooting +
- Monitoring Logs + + + + + +
-
+
+
+
+
+
+
+
+
-
+
+
+
+
+
-
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
-
+
+
+
+
+
-
+
+
+
+
+
-
+
+
+
+
+
-
+
+
+
+
+
-
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Development Environment Setup
+Note: This is only useful for people who are looking to contribute to the ENiGMA½ source base itself. Those that are just setting up a new BBS system do not need this section.
+ +The easiest way to get started with development on ENiGMA½ is via the pre-configured Visual Studio Code remote docker container environment. This setup will download and configure everything needed with minimal interaction. It also works cross-platform.
+ +-
+
- Install Visual Studio Code +
- Install Docker +
- Clone the ENiGMA½ repository. +
- Choose “Open Folder” from Visual Studio Code and open the location where you cloned the repository. +
That’s it! Visual Studio Code should prompt you for everything else that is needed, including some useful extensions for development.
+ +Tasks
+ +Once it completes, there are a few tasks and run-configs that are useful. Open up the command pallete and search/choose “Tasks> Run Task”. From there you can run the following tasks:
+ +Start Jekyll (ENiGMA½ documentation server)
+ +This task will start the Jekyll server to perform local testing of changes to documentation. After running this task, open a browser to (http://localhost:4000/enigma-bbs/) to see the documentation.
+ +(re)build Jekyll bundles
+ +When the image is created the Jekyll bundles are installed, so in general there shouldn’t be much need to run this task. This is available however in case soemthing goes wrong or you are working on the Jekyll setup itself.
+ +(re)build node modules
+ +Used to re-generate the node modules. Generally shouldn’t be necessary unless something is broken or you are adding/changing versions of dependencies.
+ +ENiGMA½ new configuration
+ +This task executes oputil.js in order to create a new BBS configuration (useful if you have just checked out the code and haven’t setup any configuration yet.)
Run / Debug config
+ +There is also a default “Launch Program” config (hotkey access via F5 / Ctrl-Shift-D.) This will launch ENiGMA½. Once it has launched, access the system via telnet, port 8888 as usual.
+ +