Updates to documentation
This commit is contained in:
parent
6f8f8f7e9d
commit
d593b097f0
|
@ -19,12 +19,12 @@ ENiGMA½ is a modern BBS software with a nostalgic flair!
|
||||||
* Strong [PBKDF2](https://en.wikipedia.org/wiki/PBKDF2) backed password encryption
|
* Strong [PBKDF2](https://en.wikipedia.org/wiki/PBKDF2) backed password encryption
|
||||||
* Door support including common dropfile formats and legacy DOS doors (See [Doors](docs/doors.md))
|
* Door support including common dropfile formats and legacy DOS doors (See [Doors](docs/doors.md))
|
||||||
* [Bunyan](https://github.com/trentm/node-bunyan) logging
|
* [Bunyan](https://github.com/trentm/node-bunyan) logging
|
||||||
|
* FidoNet Type Network (FTN) + BinkleyTerm Style Outbound (BSO) message import/export
|
||||||
|
|
||||||
## In the Works
|
## In the Works
|
||||||
* Lots of code cleanup, ES6+ usage, and **documentation**!
|
* More ES6+ usage, and **documentation**!
|
||||||
* FTN import & export
|
|
||||||
* File areas
|
* File areas
|
||||||
* Full access checking framework (ACS)
|
* ACS support for more areas
|
||||||
* SysOp dashboard (ye ol' WFC)
|
* SysOp dashboard (ye ol' WFC)
|
||||||
* Missing functionality such as searching, pipe code support in message areas, etc.
|
* Missing functionality such as searching, pipe code support in message areas, etc.
|
||||||
* String localization
|
* String localization
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
# Doors
|
# Doors
|
||||||
ENiGMA½ supports a variety of methods for interacting with doors not limited to:
|
ENiGMA½ supports a variety of methods for interacting with doors — not limited to:
|
||||||
* `abracadabra` module: Standard in/out (stdio) capture or temporary socket server that can be used with [DOSEMU](http://www.dosemu.org/), [DOSBox](http://www.dosbox.com/), [QEMU](http://wiki.qemu.org/Main_Page), etc.
|
* `abracadabra` module: Standard in/out (stdio) capture or temporary socket server that can be used with [DOSEMU](http://www.dosemu.org/), [DOSBox](http://www.dosbox.com/), [QEMU](http://wiki.qemu.org/Main_Page), etc.
|
||||||
* `bbs_link` module for interaction with [BBSLink](http://www.bbslink.net/)
|
* `bbs_link` module for interaction with [BBSLink](http://www.bbslink.net/)
|
||||||
|
|
||||||
|
@ -28,7 +28,7 @@ Variables for use in `args`:
|
||||||
|
|
||||||
|
|
||||||
### DOSEMU with abracadabra
|
### DOSEMU with abracadabra
|
||||||
[DOSEMU](http://www.dosemu.org/) can provide a good solution for running legacy DOS doors when running on Linux systems. For this, we will a virtual serial port (COM1) that communicates with stdio.
|
[DOSEMU](http://www.dosemu.org/) can provide a good solution for running legacy DOS doors when running on Linux systems. For this, we will create a virtual serial port (COM1) that communicates via stdio.
|
||||||
|
|
||||||
As an example, here are the steps for setting up Pimp Wars:
|
As an example, here are the steps for setting up Pimp Wars:
|
||||||
|
|
||||||
|
|
|
@ -5,8 +5,7 @@ ENiGMA½ is a modern from scratch BBS package written in Node.js.
|
||||||
TL;DR? This should get you started...
|
TL;DR? This should get you started...
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
* [Node.js](https://nodejs.org/) version **v0.12.2 or higher** (v4.2+ is recommended)
|
* [Node.js](https://nodejs.org/) version **v4.2.x or higher**
|
||||||
* [io.js](https://iojs.org/) should also work, though I have not yet tested this.
|
|
||||||
* :information_source: It is suggested to use [nvm](https://github.com/creationix/nvm) to manage your Node/io.js installs
|
* :information_source: It is suggested to use [nvm](https://github.com/creationix/nvm) to manage your Node/io.js installs
|
||||||
* **Windows users will need additional dependencies installed** for the `npm install` step in order to compile native binaries:
|
* **Windows users will need additional dependencies installed** for the `npm install` step in order to compile native binaries:
|
||||||
* A recent copy of Visual Studio ([Visual Studio Express](https://www.visualstudio.com/en-us/products/visual-studio-express-vs.aspx) editions OK)
|
* A recent copy of Visual Studio ([Visual Studio Express](https://www.visualstudio.com/en-us/products/visual-studio-express-vs.aspx) editions OK)
|
||||||
|
@ -16,9 +15,9 @@ TL;DR? This should get you started...
|
||||||
If you're new to Node.js and/or do not care about Node itself and just want to get ENiGMA½ running these steps should get you going on most \*nix type enviornments:
|
If you're new to Node.js and/or do not care about Node itself and just want to get ENiGMA½ running these steps should get you going on most \*nix type enviornments:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.30.1/install.sh | bash
|
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.31.0/install.sh | bash
|
||||||
nvm install 4.2.4
|
nvm install 4.4.0
|
||||||
nvm use 4.2.4
|
nvm use 4.4.0
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
@ -48,16 +47,27 @@ The main system configuration is handled via `~/.config/enigma-bbs/config.hjson`
|
||||||
general: {
|
general: {
|
||||||
boardName: Super Awesome BBS
|
boardName: Super Awesome BBS
|
||||||
}
|
}
|
||||||
|
|
||||||
servers: {
|
servers: {
|
||||||
ssh: {
|
ssh: {
|
||||||
privateKeyPass: YOUR_PK_PASS
|
privateKeyPass: YOUR_PK_PASS
|
||||||
enabled: true /* set to false to disable the SSH server */
|
enabled: true /* set to false to disable the SSH server */
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
messages: {
|
|
||||||
areas: [
|
messageConferences: {
|
||||||
{ name: "local_enigma_discusssion", desc: "ENiGMA Discussion", groups: [ "users" ] }
|
local_general: {
|
||||||
]
|
name: Local
|
||||||
|
desc: Local Discussions
|
||||||
|
default: true
|
||||||
|
|
||||||
|
areas: {
|
||||||
|
local_music: {
|
||||||
|
name: Music Discussion
|
||||||
|
desc: Music, bands, etc.
|
||||||
|
default: true
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue