Skip to content

INSTALL.md

Latest commit

 

History

History
73 lines (59 loc) · 2.89 KB

INSTALL.md

File metadata and controls

73 lines (59 loc) · 2.89 KB

Installing a Cocreate Server

These instructions on based on the more complicated installation instructions for Coauthor.

Test Server

Here is how to get a local test server running:

  1. Install Meteor: curl https://install.meteor.com/ | sh on UNIX, choco install meteor on Windows (in administrator command prompt after installing Chocolatey)
  2. Download Cocreate: git clone https://github.com/edemaine/cocreate.git
  3. Run meteor:
    • cd cocreate
    • meteor npm install
    • meteor

Even a test server will be accessible from the rest of the Internet, on port 3000.

Public Server

To deploy to a public server, we recommend deploying from a development machine via meteor-up. Installation instructions:

  1. Install Meteor and download Cocreate as above.
  2. Install mup via npm install -g mup (after installing Node and thus NPM).
  3. Edit .deploy/mup.js to point to your SSH key (for accessing the server), and your SSL certificate (for an https server).
  4. cd .deploy
  5. mup setup to install all necessary software on the server
  6. mup deploy each time you want to deploy code to server (initially and after each git pull)

MongoDB

All of Cocreate's data is stored in the Mongo database (which is part of Meteor). You probably want to do regular (e.g. daily) dump backups.

mup's MongoDB stores data in /var/lib/mongodb. MongoDB prefers an XFS filesystem, so you might want to create an XFS filesystem and mount or link it there. (For example, I have mounted an XFS volume at /data and linked via ln -s /data/mongodb /var/lib/mongodb).

mup also, by default, makes the MongoDB accessible to any user on the deployed machine. This is a security hole: make sure that there aren't any user accounts on the deployed machine. But it is also useful for manual database inspection and/or manipulation. Install MongoDB client tools, run mongo cocreate (or mongo then use cocreate) and you can directly query or update the collections. (Start with show collections, then e.g. db.messages.find().) On a test server, you can run meteor mongo to get the same interface.

bcrypt on Windows

To install bcrypt on Windows (to avoid warnings about it missing), install windows-build-tools via npm install --global --production windows-build-tools, and then run meteor npm install bcrypt.