updated readme and config defaults

v1.18.x
Julian Lam 12 years ago
parent bdbbed18ae
commit 1b3b0c6c7e

@ -1,9 +1,9 @@
# node-forum # NodeBB
**node-forum** is a robust nodejs driven forum built on a redis database. It is powered by web sockets, and is compatible down to IE8. **NodeBB** is a robust nodejs driven forum built on a redis database. It is powered by web sockets, and is compatible down to IE8.
## Installation ## Installation
First step is to obtain all of the dependencies requires by node-forum: First step is to obtain all of the dependencies requires by NodeBB:
$ npm install $ npm install
@ -11,11 +11,15 @@ First step is to obtain all of the dependencies requires by node-forum:
# apt-get install redis # apt-get install redis
Now we ensure that the configuration files are properly set up. node-forum runs on port 4567 by default. The client side config can be set up thusly: Now we ensure that the configuration files are properly set up. NodeBB runs on port 4567 by default. The client side config can be set up thusly:
$ cp public/config.default.json public/config.json $ cp public/config.default.json public/config.json
Ensure that `/public/config.json` points to the publically accessible IP/hostname of your forum. ... and the server side config can be set up similarly:
$ cp config.default.js config.js
Ensure that `/public/config.json` points to the publically accessible IP/hostname of your forum, and that the values of the server side config are also set correctly (see below).
Lastly, we run the forum. Lastly, we run the forum.
@ -23,16 +27,20 @@ Lastly, we run the forum.
## Server Configuration ## Server Configuration
The server configuration file (located at `/config.js`) contains default options required for the running of node-forum. The following options are available: The server configuration file (located at `/config.js`) contains default options required for the running of NodeBB. The following options are available:
<table> <table>
<tr> <tr>
<th>Option</th> <th>Option</th>
<th>Description</th> <th>Description</th>
</tr> </tr>
<tr>
<td><b>base_url</b></td>
<td><i>(Default: 'http://localhost')</i> A web-accessible URL to your app, without the port</td>
</tr>
<tr> <tr>
<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 NodeBB runs on</td>
</tr> </tr>
<tr> <tr>
<td><b>mailer</b></td> <td><b>mailer</b></td>

@ -1,6 +1,7 @@
var config = { var config = {
"url": "http://localhost:4567/", "base_url": "http://localhost",
"port": 4567, "port": 4567,
"url": undefined, // Leave this alone
"mailer": { "mailer": {
host: 'localhost', host: 'localhost',
port: '25', port: '25',
@ -8,4 +9,6 @@ var config = {
} }
} }
config.url = config.base_url + ':' + config.port + '/';
module.exports = config; module.exports = config;
Loading…
Cancel
Save