From 1b3b0c6c7eda9b6cd3846ab30abb15ad30dd6f8e Mon Sep 17 00:00:00 2001 From: Julian Lam Date: Tue, 23 Apr 2013 16:51:39 -0400 Subject: [PATCH] updated readme and config defaults --- README.md | 22 +++++++++++++++------- config.default.js | 5 ++++- 2 files changed, 19 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b3b5b57818..03555be9b2 100644 --- a/README.md +++ b/README.md @@ -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: + + + + - + diff --git a/config.default.js b/config.default.js index 5ce32bfbf7..5393551a9e 100644 --- a/config.default.js +++ b/config.default.js @@ -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; \ No newline at end of file
Option Description
base_url(Default: 'http://localhost') A web-accessible URL to your app, without the port
port(Default: 4567) The default port that node-forum runs on(Default: 4567) The default port that NodeBB runs on
mailer