diff --git a/README.md b/README.md index 0773f3fe..83fb50ea 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/) diff --git a/docs/config.md b/docs/config.md index ff653e37..4e510b35 100644 --- a/docs/config.md +++ b/docs/config.md @@ -50,13 +50,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) } 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: { @@ -131,3 +132,4 @@ Below is a **sample** `config.hjson` illustrating various (but certainly not all * [Modding](modding.md) * [Doors](doors.md) * [MCI Codes](mci.md) +* [Menu System docs](menu_system.md) diff --git a/docs/index.md b/docs/index.md index 48fdc090..909ff836 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 + } } - } - } + } } } ``` @@ -105,6 +107,15 @@ Below is an _example_ configuration. It is recommended that you at least **start ./main.js ``` +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) +* 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: @@ -112,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. diff --git a/package.json b/package.json index 0f86e3d0..232e1dca 100644 --- a/package.json +++ b/package.json @@ -4,6 +4,9 @@ "description": "ENiGMA½ Bulletin Board System", "author": "Bryan Ashby ", "license": "BSD-2-Clause", + "scripts": { + "start": "node main.js" + }, "repository": { "type": "git", "url": "https://github.com/NuSkooler/enigma-bbs.git"