From 8fb5a2dd1ef48746ec521119f75722d45eef46b0 Mon Sep 17 00:00:00 2001 From: Bryan Ashby Date: Sat, 2 Jul 2016 19:26:57 -0600 Subject: [PATCH] Add special thanks, minor updates to logs, etc. --- README.md | 4 +++- docs/index.md | 9 +++++++-- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 40c77f8a..89e9a434 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ ENiGMA½ is a modern BBS software with a nostalgic flair! -## Feature Available Now +## Features Available Now * Multi platform: Anywhere Node.js runs likely works (tested under Linux and OS X) * Multi node support * **Highly** customizable via [HJSON](http://hjson.org/) based configuration, menus, and themes in addition to JavaScript based mods @@ -51,6 +51,7 @@ ENiGMA has been tested with many terminals. However, the following are suggested ## Boards * WQH: :skull: Xibalba :skull: (**telnet://xibalba.l33t.codes:44510**) * Support board: ☠ BLACK ƒlag ☠ (**telnet://blackflag.acid.org:2425**) +* HappyLand (**telnet://andrew.homeunix.org:2023**) ## Installation @@ -65,6 +66,7 @@ Please see the [Quickstart](docs/index.md#quickstart) * Jack Phlash for kick ass ENiGMA½ and Xibalba ASCII (Check out [IMPURE60](http://pc.textmod.es/pack/impure60/)!!) * Avon of [Agency BBS](http://bbs.geek.nz/) and fsxNet * Maskreet of [Throwback BBS](http://www.throwbackbbs.com/) hosting [DoorParty](http://forums.throwbackbbs.com/)! +* [Apam](https://github.com/apamment) of HappyLand BBS ## License Released under the [BSD 2-clause](https://opensource.org/licenses/BSD-2-Clause) license: diff --git a/docs/index.md b/docs/index.md index 5387030a..78b75e5c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -88,13 +88,18 @@ You wil be asked a series of basic questions. ./main.js ``` +## 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: + + tail -F /path/to/enigma-bbs/logs/enigma-bbs.log | /path/to/enigma-bbs/node_modules/bunyan/bin/bunyan + 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: `tail -F ./logs/enigma-bbs.log | ./node_modules/bunyan/bin/bunyan` +* **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.