Skip to content

btrask/fsmash

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

fsmash.org site software

fsmash is the software that powers http://fsmash.org/. It requires node.js and MySQL.

Installation

  1. cd to the fsmash directory
  2. Run make release
  3. Upload /public, /server, and /shared to the server
  4. On the server:
  5. Install the IP geolocation database from http://www.maxmind.com/app/geolitecity
  6. Configure the server (see below)
  7. Configure the MySQL database (see below)
  8. Run npm install bcrypt mysql
  9. Run ./server/index.js

Configuring the server

Configuration files are stored in /server/config/. JSON files in this folder are read (in order of Array.sort) and deep-merged to produce a single config object. Values in later files overwrite values for the same property in earlier files. Instead of changing the existing files, it is recommended to create an additional file that overrides any necessary default values. This file should be named such that it appears last when sorted.

Example zz01-secret.json { "PayPal": { "verify": { "receiver_email": "you@example.com" } }, "server": { "port": 8001 }, "database": { "password": "" }, "GeoIP": { "path": null } }

If you installed the IP geolocation database in the default location, you don't need to specify a path for it.

MySQL database configuration

  1. Create the database schema using /resources/database.sql
  2. Create some channels and add them to publicChannels
  3. Add matchTypes, rules, and soundsets
  4. Configure your account as an administrator