异世界红茶馆的源码
 
 
 
 
Go to file
Julian Lam 96a4cbd8d1 fixed menu "active" state
public fixed menu "active" state
src added email to registration fields, email existence check
.gitignore added email to registration fields, email existence check
README.md updated readmeh
app.js init, just some testing
config.js optimizing for express, tweaks to config file
package.json init, just some testing

README.md

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.

Installation

First step is to obtain all of the dependencies requires by node-forum:

$ npm install

(Optional) Next, we install redis. If you already have redis installed, you can skip this step.

# 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:

$ cp public/config.default.json public/config.json

Ensure that /public/config.json points to the publically accessible IP/hostname of your forum.

Lastly, we run the forum.

$ node app

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:

Option Description
port (Default: 4567) The default port that node-forum runs on
mailer (Default: {
    host: 'localhost',
    port: '25',
    from: 'mailer@localhost.lan'
})

Settings for the outgoing mailer (for emails involving user registration/password resets)

Client Configuration

As the client will utilise web sockets to connect to the server, you'll need to customise the client configuration file (located at /public/config.json) to point to your server's publically accessible IP. The port will be identical to the port specified in the server-side configuration (defaulted to 4567).