moon
/
enigma-bbs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated quickstart to note Node version requirements/etc. and better overall docs

This commit is contained in:
Bryan Ashby 2015-12-08 11:21:21 -07:00
parent e6aaac1f51
commit cdfd074024
1 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/index.md
View File

@ -4,29 +4,29 @@ ENiGMA½ is a modern from scratch BBS package written in Node.js.
# Quickstart # Quickstart
TL;DR? This should get you started... TL;DR? This should get you started...
1\. Clone ## Prerequisites
* Node.js version **v0.12.2 or higher** (v4.2+ is recommended). io.js should also work, though I have not yet tested this.
* Windows users will need additional dependencies installed for the `npm install` step in order to compile native binaries:
* A recent copy of Visual Studio (Express editions OK)
* Python 2.7.x
## Clone
```bash ```bash
git clone https://github.com/NuSkooler/enigma-bbs.git git clone https://github.com/NuSkooler/enigma-bbs.git
``` ```
2\. Install dependencies ## Install Node Modules
```bash ```bash
npm install npm install
``` ```
**Note for Windows users**:<br> ## Generate a SSH Private Key
Some dependencies require compilation. You will need at least the following installed for `npm install` to succeed: To utilize the SSH server, a SSH Private Key will need generated. This step can be skipped if desired by disabling the SSH server in `config.hjson`.
* A recent copy of Visual Studio (Express editions OK)
* Python 2.7.x
3\. Generate a SSH Private Key<br>
Note that you can skip this step and disable the SSH server in your `config.hjson` if desired.
```bash ```bash
openssl genrsa -des3 -out ./misc/ssh_private_key.pem 2048 openssl genrsa -des3 -out ./misc/ssh_private_key.pem 2048
``` ```
4\. Create a minimal config<br> ## Create a Minimal Config
The main system configuration is handled via `~/.config/enigma-bbs/config.hjson`. This is a [HJSON](http://hjson.org/) file (compiliant JSON is also OK). See [Configuration](config.md) for more information. The main system configuration is handled via `~/.config/enigma-bbs/config.hjson`. This is a [HJSON](http://hjson.org/) file (compiliant JSON is also OK). See [Configuration](config.md) for more information.
```hjson ```hjson
@ -36,6 +36,7 @@ general: {
servers: { servers: {
ssh: { ssh: {
privateKeyPass: YOUR_PK_PASS privateKeyPass: YOUR_PK_PASS
}
} }
messages: { messages: {
areas: [ areas: [
@ -44,12 +45,12 @@ messages: {
} }
``` ```
5\. Launch! ## Launch!
```bash ```bash
./main.js ./main.js
``` ```
Some points of interest: Some points of interest:
* Default ports are 8888 (Telnet) and 8889 (SSH) * Default ports are 8888 (Telnet) and 8889 (SSH)
* The first user you create via applying is the root SysOp. * 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` * You may want to tail the logfile with Bunyan: `tail -F ./logs/enigma-bbs.log | ./node_modules/bunyan/bin/bunyan`