Skip to content

Latest commit

 

History

History
88 lines (61 loc) · 2.62 KB

README.md

File metadata and controls

88 lines (61 loc) · 2.62 KB
Raw

WPI Collablab Internal Website

Description

This site allows users to swipe in and out of the lab, and view the status of the lab from outside the lab. It is built using NodeJS/ExpressJS, and exposes an API that can be consumed by other applications.

Dependencies

NodeJS - Runs the node code

npm - To grab all of the necessary node modules easily

Redis - Session Store

postgres - Database backend

ForeverJS (Production)* - Will continuously restart script on crash

NodeMon (Development)* - Will run script until crash, and then wait for file change before restarting

* Are recommended packages, they make things easier for their environment.

Production Usage

If all you want to do is pull a change and restart, do this.

ssh [email protected]
cd code/collablab
git pull
sudo service website stop
sudo service website start

To set up from scratch, read further

To use the site in a production setting, follow these steps (some commands may be debian centric and require conversion):

  1. Install dependencies:
sudo apt install nodejs redis-server npm postgresql
sudo npm install -g forever

  1. Clone the repository into some directory: git clone https://github.com/WPI-CollabLab/Lab-Website.git

  2. Install the node dependencies:

cd collablab
npm install

  1. Modify config.js, especially:

    • Default admin credentials, generally should be set by sysadmin or president to their information.
    • Default passphrases, there's three and they should be changed from their default
    • cookieSecret, this should be random, I recommend generating a twelve character string from random.org or equivalent.
    • nukeOnRestart, this should be set to false.
    • externalPort, this should be set to 80.

  2. Add iptables rules to block communication to the server from anywhere but localhost on the configured internalPort (default: 8080)

'sudo iptables -A INPUT -p tcp --destination-port 8080 -j DROP`
  1. Start with ForeverJS
forever start index.js

Development Usage

To setup for development, the steps are slightly more straighforward.

  1. Install dependencies:
sudo apt install nodejs redis npm
sudo npm install -g nodemon

  1. Clone the repository into some directory: git clone https://github.com/WPI-CollabLab/Lab-Website.git

  2. Install the node dependencies:

cd collablab
npm install

  1. Start the postgresql server, supply the postgres username and password in the ormconfig.json, make sure to make a database called "collablab" or update ormconfig.js to the correct database name

  2. Run the website: npm start