more tweaks to readme

v1.18.x
Julian Lam 12 years ago
parent 1d3d3df73b
commit 6da36bb859

@ -3,11 +3,17 @@
## Installation ## 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 ## 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><b>port</b></td>
<td><i>(Default: 4567)</i> The default port that node-forum runs on</td> <td><i>(Default: 4567)</i> The default port that node-forum runs on</td>
</tr> </tr>
<tr>
<td><b>mailer</b></td>
<td>
<i>(Default: {<br />
&nbsp;&nbsp;&nbsp;&nbsp;host: 'localhost',<br />
&nbsp;&nbsp;&nbsp;&nbsp;port: '25',<br />
&nbsp;&nbsp;&nbsp;&nbsp;from: 'mailer@localhost.lan'<br />
})</i><br />
Settings for the outgoing mailer (for emails involving user registration/password resets)
</td>
</tr>
</table> </table>
Loading…
Cancel
Save