mirror of
https://github.com/NodeBB/NodeBB.git
synced 2026-03-01 10:01:12 +01:00
more tweaks to readme
This commit is contained in:
23
README.md
23
README.md
@@ -3,11 +3,17 @@
|
||||
|
||||
## Installation
|
||||
|
||||
1. `$ npm install`
|
||||
First step is to obtain all of the dependencies requires by node-forum:
|
||||
|
||||
2. `$ apt-get install redis`
|
||||
$ npm install
|
||||
|
||||
3. `$ node app`
|
||||
Next, we install redis. If you have redis installed, you can skip this step.
|
||||
|
||||
# apt-get install redis
|
||||
|
||||
Lastly, we run the forum.
|
||||
|
||||
$ node app
|
||||
|
||||
## Config
|
||||
|
||||
@@ -22,4 +28,15 @@ node-forum is pre-configured to run on port 4567, with default options defined i
|
||||
<td><b>port</b></td>
|
||||
<td><i>(Default: 4567)</i> The default port that node-forum runs on</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><b>mailer</b></td>
|
||||
<td>
|
||||
<i>(Default: {<br />
|
||||
host: 'localhost',<br />
|
||||
port: '25',<br />
|
||||
from: 'mailer@localhost.lan'<br />
|
||||
})</i><br />
|
||||
Settings for the outgoing mailer (for emails involving user registration/password resets)
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
Reference in New Issue
Block a user