Speckle (nodejs) Server - The beating heart of speckle.
Clone or download
didimitrie Merge pull request #101 from gouldingken/patch-1
Updated broken API docs link - thanks!
Latest commit 802d486 Nov 14, 2018

readme.md

Speckle Server

DOI

This is the Speckle Server, which coordinates communications between the various SpeckleClients.

Speckle Server provides :

  • a basic accounts system
  • stream coordination
  • design data collation and retrieval
  • live update events
  • a basic querying mechanism

5 Minute Docker Install ™️ (with Digital Ocean)

Head over to Digital Ocean and create an account. Subsequently, create a new droplet (vm) via "One Click Apps" and select "Docker". Finally, ssh into your new virtual machine.

Execute the following commands:

$ mkdir speckle && cd speckle
$ curl https://raw.githubusercontent.com/speckleworks/SpeckleServer/master/docker-compose.yml -o docker-compose.yml
$ docker-compose up

⚠️ Imporant security notice: Finally, make sure you create a digital ocean cloud firewall rule (and apply it to your droplet) to allow port 3000, or whatever port you're using. See discussion: https://github.com/speckleworks/SpeckleServer/issues/90#issuecomment-400011794

screenshot

Note: You're not restricted to digital ocean. Any machine with docker should be ok.

Deploying to Heroku

$ heroku create --stack cedar
$ heroku addons:create mongolab:sandbox
$ heroku addons:create heroku-redis:hobby-dev
$ git push heroku master
$ heroku open

Deploying on Debian-based OSes (Ubuntu etc)

  1. Install mongodb, redis servers and npm:

    $ sudo apt-get install mongodb redis npm
    
  2. If you don't want both the redis and mongo servers running all the time (For ex. if you are just testing), disable both startup scripts (If you wish to leave both running automatically, skip to step 4):

    $ sudo systemctl disable mongodb
    $ sudo systemctl disable redis-server`
    
  3. And stop both mongo and redis processes that were started automatically by apt-get:

    $ sudo systemctl stop mongodb
    $ sudo systemctl stop redis-server
    
  4. Clone SpeckleServer and run npm to install the needed nodejs packages:

    $ git clone https://github.com/speckleworks/SpeckleServer.git
    $ cd SpeckleServer
    $ npm install
    
  5. Follow the instructions in .env-base file to configure your server.

  6. Start mongo (create a folder somewhere to store the db):

    $ mongodb --dbpath /path/to/some/folder
    
  7. Start redis in another terminal:

    $ redis-server
    
  8. Check that both mongo and redis are running OK and that you can connect to them with these two clients:

    $ mongo
    $ redis-cli
    
  9. Start Speckle in a third terminal:

    $ node server.js
    

API

API docs are here - they are a good overview of what you can do with the speckle server.

Current Limitations

  • Because we rely on mongodb's wired tiger engine, objects larger than 16mb will cause trouble. Unfortunately, most of the defenses are on the client side.
  • The api will refuse payloads larger than MAX_REQ, which defaults to 10mb.

Credits

Developed by Dimitrie A. Stefanescu @idid and Project Contributors.

License

MIT