Nemcio/NodeBB
1
0
Fork 0
mirror of https://github.com/NodeBB/NodeBB.git synced 2026-08-05 00:29:56 +02:00
Code Issues Packages Projects Releases Wiki Activity

updated readme and config defaults

Browse Source
This commit is contained in:
Julian Lam
2013-04-23 16:51:39 -04:00
parent bdbbed18ae
commit 1b3b0c6c7e
2 changed files with 19 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -1,9 +1,9 @@
# node-forum
**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
**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
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
@@ -11,11 +11,15 @@ First step is to obtain all of the dependencies requires by node-forum:
# 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
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.
@@ -23,16 +27,20 @@ Lastly, we run the forum.
## 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>
<tr>
<th>Option</th>
<th>Description</th>
</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>
<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>
<td><b>mailer</b></td>

5
config.default.js
View File

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