From 7150631fb76667acead1776a2ebcd2b380f18527 Mon Sep 17 00:00:00 2001 From: Bryan Ashby Date: Mon, 2 Oct 2017 21:11:22 -0600 Subject: [PATCH 01/12] Remvoe gaze package --- package.json | 1 - 1 file changed, 1 deletion(-) diff --git a/package.json b/package.json index 5017536e..e00d9211 100644 --- a/package.json +++ b/package.json @@ -26,7 +26,6 @@ "exiftool": "^0.0.3", "farmhash": "^1.2.1", "fs-extra": "^3.0.1", - "gaze": "^1.1.2", "graceful-fs": "^4.1.11", "hashids": "^1.1.1", "hjson": "^2.4.2", From efd1ea28df5ef0f11428b3d2e3b9591d188c7e44 Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Fri, 27 Oct 2017 16:54:02 +0200 Subject: [PATCH 02/12] Support npm start Fill-in the missing pieces in the package.json file. From now on `npm start` just works like all other nodejs apps. --- package.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/package.json b/package.json index e00d9211..e1589314 100644 --- a/package.json +++ b/package.json @@ -4,6 +4,10 @@ "description": "ENiGMA½ Bulletin Board System", "author": "Bryan Ashby ", "license": "BSD-2-Clause", + "main": "./core/bbs", + "scripts": { + "start": "node main" + }, "repository": { "type": "git", "url": "https://github.com/NuSkooler/enigma-bbs.git" From 4092ecd2b23dc4180a48feebb66a6c4461d10111 Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Fri, 27 Oct 2017 17:12:45 +0200 Subject: [PATCH 03/12] Show it's possible to change the telnet default port In my case the default port (8888) was already in use. However, it was very hard to know (more guessing) the port change in possible via telnet: { port: xxxx }. --- docs/index.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/index.md b/docs/index.md index 1147c578..9fbb0cee 100644 --- a/docs/index.md +++ b/docs/index.md @@ -77,9 +77,12 @@ Below is an _example_ configuration. It is recommended that you at least **start loginServers: { ssh: { - privateKeyPass: YOUR_PK_PASS - enabled: true /* set to false to disable the SSH server */ - } + privateKeyPass: YOUR_PK_PASS + enabled: true /* set to false to disable the SSH server */ + } + telnet: { + port: 8888 + } } messageConferences: { @@ -87,15 +90,14 @@ Below is an _example_ configuration. It is recommended that you at least **start name: Local desc: Local Discussions default: true - - areas: { - local_music: { + areas: { + local_music: { name: Music Discussion desc: Music, bands, etc. default: true + } } - } - } + } } } ``` From 0f9e9c75ed9747100f7219631a700dadf1efd33f Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Fri, 27 Oct 2017 17:59:45 +0200 Subject: [PATCH 04/12] Just add a link to the webchat For people who don't have a IRC client installed. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 39ee0561..d7053333 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ See [the issue tracker](https://github.com/NuSkooler/enigma-bbs/issues) for more ## Support * Use [the issue tracker](https://github.com/NuSkooler/enigma-bbs/issues) * **Discussion on a ENiGMA BBS!** (see Boards below) -* IRC: **#enigma-bbs** on **chat.freenode.net** +* IRC: **#enigma-bbs** on **chat.freenode.net** ([webchat](https://webchat.freenode.net/?channels=enigma-bbs)) * Discussion on [fsxNet](http://bbs.geek.nz/#fsxNet) available on many boards * Email: bryan -at- l33t.codes * [Facebook ENiGMA½ group](https://www.facebook.com/groups/enigmabbs/) From 051ef274281f169f2620eafb4a3d6e60cdce4a20 Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Fri, 27 Oct 2017 21:43:10 +0200 Subject: [PATCH 05/12] Update package.json --- package.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/package.json b/package.json index e1589314..fb04a0f4 100644 --- a/package.json +++ b/package.json @@ -4,9 +4,8 @@ "description": "ENiGMA½ Bulletin Board System", "author": "Bryan Ashby ", "license": "BSD-2-Clause", - "main": "./core/bbs", "scripts": { - "start": "node main" + "start": "node main.js" }, "repository": { "type": "git", From 5672fa144b43e24ffdd0834797a1629232490551 Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Sun, 29 Oct 2017 02:15:53 +0100 Subject: [PATCH 06/12] Add some extra begginers info I found this by digging into the code itself, since again oputil doesn't provide anything useful yet. --- docs/index.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/index.md b/docs/index.md index 9fbb0cee..ae30690c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -107,6 +107,11 @@ Below is an _example_ configuration. It is recommended that you at least **start ./main.js ``` + +*Note #1:* The first user who register/apply (user ID = 1) will be automatically be added to the sysop group. And thus becomes SysOp. + +*Note #2:* All data is stored by default in Sqlite3 database files within the `db` sub folder, including user data, messages, system logs and file meta data. + ## Monitoring Logs Logs are produced by Bunyan which outputs each entry as a JSON object. To tail logs in a colorized and pretty pretty format, issue the following command: From acc14483930e9561176ad3138c9b629d1e3d1fc5 Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Sun, 29 Oct 2017 02:17:53 +0100 Subject: [PATCH 07/12] Update index.md Typo --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index ae30690c..73b45739 100644 --- a/docs/index.md +++ b/docs/index.md @@ -108,7 +108,7 @@ Below is an _example_ configuration. It is recommended that you at least **start ``` -*Note #1:* The first user who register/apply (user ID = 1) will be automatically be added to the sysop group. And thus becomes SysOp. +*Note #1:* The first user who register/apply (user ID = 1) will be automatically be added to the `sysops` group. And thus becomes SysOp. *Note #2:* All data is stored by default in Sqlite3 database files within the `db` sub folder, including user data, messages, system logs and file meta data. From c38acebafbf1030a10391eeda548a484114b5cb8 Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Sun, 29 Oct 2017 20:18:40 +0100 Subject: [PATCH 08/12] Update index.md Moved the section + improve text. --- docs/index.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/index.md b/docs/index.md index 73b45739..548d08ee 100644 --- a/docs/index.md +++ b/docs/index.md @@ -107,10 +107,14 @@ Below is an _example_ configuration. It is recommended that you at least **start ./main.js ``` +Read the Points of Interest below for more info. -*Note #1:* The first user who register/apply (user ID = 1) will be automatically be added to the `sysops` group. And thus becomes SysOp. - -*Note #2:* All data is stored by default in Sqlite3 database files within the `db` sub folder, including user data, messages, system logs and file meta data. +## Points of Interest +* **The first user you create via register/applying (user ID = 1) will be automatically be added to the `sysops` group. And thus becomes SysOp.** (aka root) +* Default port for Telnet is 8888 and for SSH 8889 + * Note that on *nix systems port such as telnet/23 are privileged (e.g. require root). See [this SO article](http://stackoverflow.com/questions/16573668/best-practices-when-running-node-js-with-port-80-ubuntu-linode) for some tips on using these ports on your system if desired. +* All data is stored by default in Sqlite3 database files, within the `db` sub folder. Including user data, messages, system logs and file meta data. +* You may want to tail the logfile with Bunyan. See Monitoring Logs below. ## Monitoring Logs Logs are produced by Bunyan which outputs each entry as a JSON object. To tail logs in a colorized and pretty pretty format, issue the following command: @@ -119,12 +123,6 @@ Logs are produced by Bunyan which outputs each entry as a JSON object. To tail l ENiGMA½ does not produce much to standard out. See below for tailing the log file to see what's going on. -## Points of Interest -* Default ports are 8888 (Telnet) and 8889 (SSH) - * Note that on *nix systems port such as telnet/23 are privileged (e.g. require root). See [this SO article](http://stackoverflow.com/questions/16573668/best-practices-when-running-node-js-with-port-80-ubuntu-linode) for some tips on using these ports on your system if desired. -* **The first user you create via applying is the SysOp** (aka root) -* You may want to tail the logfile with Bunyan. See Monitoring Logs above. - # Advanced Installation If you've become convinced you would like a "production" BBS running ENiGMA½ a more advanced installation may be in order. From 7b167b20778fbfc5cc4b51ba5d4e64f3e4735a7b Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Sun, 29 Oct 2017 20:39:12 +0100 Subject: [PATCH 09/12] Add missing menuFile hjson spec Add missing config hjson file item --- docs/config.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/config.md b/docs/config.md index ca760676..b0ce2e6e 100644 --- a/docs/config.md +++ b/docs/config.md @@ -48,6 +48,7 @@ Below is a **sample** `config.hjson` illustrating various (but certainly not all { general: { boardName: A Sample BBS + menuFile: your_bbs.hjson # copy of menu.hjson file (and adapt to your needs) } defaults: { @@ -126,4 +127,4 @@ Below is a **sample** `config.hjson` illustrating various (but certainly not all ``` ## Menus -See [the menu system docs](menu_system.md) \ No newline at end of file +See [the menu system docs](menu_system.md) From 64a8d9fc4106ba0108a262c6ded5d2c430e29712 Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Sun, 29 Oct 2017 20:43:31 +0100 Subject: [PATCH 10/12] Update index.md Add link to docs --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 548d08ee..b57fac84 100644 --- a/docs/index.md +++ b/docs/index.md @@ -107,7 +107,7 @@ Below is an _example_ configuration. It is recommended that you at least **start ./main.js ``` -Read the Points of Interest below for more info. +Read the Points of Interest below for more info. Also check-out all the other documentation files in the [docs](.) directory. ## Points of Interest * **The first user you create via register/applying (user ID = 1) will be automatically be added to the `sysops` group. And thus becomes SysOp.** (aka root) From 4e9b72366c80660d7682eb15722988be46927515 Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Mon, 30 Oct 2017 22:31:39 +0100 Subject: [PATCH 11/12] Update config.md --- docs/config.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/config.md b/docs/config.md index b0ce2e6e..1839978e 100644 --- a/docs/config.md +++ b/docs/config.md @@ -48,7 +48,7 @@ Below is a **sample** `config.hjson` illustrating various (but certainly not all { general: { boardName: A Sample BBS - menuFile: your_bbs.hjson # copy of menu.hjson file (and adapt to your needs) + menuFile: your_bbs.hjson //copy of menu.hjson file (and adapt to your needs) } defaults: { From 8ff3d013bd98a02489866da8d104444545e62dd4 Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Mon, 30 Oct 2017 23:26:55 +0100 Subject: [PATCH 12/12] I made a shame of myself I made a shame of myself, lets improve it even further. --- docs/config.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/config.md b/docs/config.md index 1839978e..fba48119 100644 --- a/docs/config.md +++ b/docs/config.md @@ -48,14 +48,14 @@ Below is a **sample** `config.hjson` illustrating various (but certainly not all { general: { boardName: A Sample BBS - menuFile: your_bbs.hjson //copy of menu.hjson file (and adapt to your needs) + menuFile: "your_bbs.hjson" // copy of menu.hjson file (and adapt to your needs) } defaults: { - theme: super-fancy-theme + theme: "super-fancy-theme" // default-assigned theme (for new users) } - preLoginTheme: luciano_blocktronics + preLoginTheme: "luciano_blocktronics" // theme used before a user logs in (matrix, NUA, etc.) messageConferences: { local_general: {