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] 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.