A Secure, Efficient, and Collaborative Real-Time Web Editor
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
src
static/stylesheets
templates
test
.gitignore
Cakefile
LICENSE
README.md
package.coffee

README.md

SECRET

A Secure, Efficient, and Collaborative Real-Time Web Editor initially presented in this ASIACCS paper. If you would like to evaluate the functionality, please use the master branch. If you instead would like to take a look at the proof-of-concept demo that was evaluated for the paper, please use the asiaccs2017 release. The simple dummy keyserver of the proof-of-concept demo can be found in the dummy-keyserver branch.

How to install

The installation steps have been tested with Ubuntu:

  1. Install Node.js and npm:

     # apt-get install npm
    
  2. Ubuntu calls node's binary nodejs, but node is more common:

     # ln -s /usr/bin/nodejs /usr/bin/node
    
  3. Install Coffeescript:

     # npm install -g coffee-script
    
  4. Compile package info:

     $ cake package
    
  5. Install ShareJSXML:

     $ npm install /path/to/ShareJSXML
    
  6. Install remaining libs:

     $ npm install
    
  7. Compile code:

     $ cake build
    
  8. Link client libs:

     $ ln -s ../../node_modules/browserchannel/dist/bcsocket.js ./static/javascripts
     $ ln -s ../../node_modules/ShareJSXML/webclient/ ./static/javascripts
    
  9. Start server (hint: in a screen with reduced permissions):

    • For development:

         $ DEBUG=SECRET npm start
      
    • For production:

         $ NODE_ENV=production npm start