Rover Deepstream Server¶

This is the main directory for the official Deepstream server that will run on our Rover’s Computer.

Ports the DS rover server will listen on:

Endpoint	Address	PORT
Websocket	0.0.0.0	4020
HTTP	0.0.0.0	4080

Universal Method to install and run deepstream:¶

This process is necessary if you are running deepstream on a raspberry pi, and works on the raspberry pi as well as any other Linux distro

FIRST, Make sure you have NodeJs installed:¶

NodeJs install:

For **Raspberry pi & Beaglebone ONLY** go here and copy paste the code block into your cli to install NodeJs on your raspberry pi or beaglebone.

For x86 or x64 Linux use the installers go here do this:

curl -sL https://deb.nodesource.com/setup_9.x | sudo -E bash -
sudo apt-get install -y nodejs build-essential
`

For Windows go here

For Mac go here

The Linux Guide (raspberry pi, x86 or x64):¶

After you have successfully installed NodeJs…

Clone the deepstream project:¶

I like to keep deepstream in my Documents folder:

cd ~/Documents/;
git clone https://github.com/deepstreamIO/deepstream.io;
cd deepstream.io/;
git submodule update --init
npm i;
npm start;

At this point, you are running deepstream, but we have some config files in deepstream that we want to edit. First go ahead and crash deepstream ctrl-c.

# Install pm2 also, which we will need later to start deepstream on startup
sudo npm install pm2 -g;

Now after we have also installed pm2, Let’s look at the deepstream file tree:

├── appveyor.yml
├── ascii-logo.txt
├── benchmarks
├── bin
├── CHANGELOG.md
├── conf  (file)
├── dist  (file)             <-- we will launch dist/bin/deepstream on startup with pm2
├── elton-square.png             as well as dist/conf/config.yml
├── jasmine.json
├── jasmine-runner.js
├── LICENSE
├── node_modules
├── package.json
├── package-lock.json
├── protocol
├── README.md
├── scripts
├── src
├── test
├── test-e2e
├── tsconfig.json
└── tslint.json

you are going to want to open dist/conf/config.yml and edit lines ~21 and ~47:

Example of part of the dist/conf/config.yml file...
...
connectionEndpoints:
 websocket:
   type: default
   options:
       # port for the websocket server
       port: 4020                          # FOR TITANROVER
       # host for the websocket server
       host: 0.0.0.0
       # url path websocket connections connect to
       urlPath: /deepstream
       # url path for http health-checks, GET requests to this path will return 200 if deepstream is alive
       healthCheckPath: /health-check
       # the amount of milliseconds between each ping/heartbeat message
       heartbeatInterval: 30000
       # the amount of milliseconds that writes to sockets are buffered
       outgoingBufferTimeout: 0
32
       # Security
       # amount of time a connection can remain open while not being logged in
       # or false for no timeout
       unauthenticatedClientTimeout: 180000
       # invalid login attempts before the connection is cut
       maxAuthAttempts: 3
       # if true, the logs will contain the cleartext username / password of invalid login attempts
       logInvalidAuthData: false
       # maximum allowed size of an individual message in bytes
       maxMessageSize: 1048576
 http:
   type: default
   options:
     # port for the http server
     port: 4080                                # FOR TITANROVER
     # host for the http server
     host: 0.0.0.0
     # allow 'authData' parameter in POST requests, if disabled only token and OPEN auth is
     # possible
     allowAuthData: true
     # enable the authentication endpoint for requesting tokens/userData.
     # note: a custom authentication handler is required for token generation
     enableAuthEndpoint: false
     # path for authentication requests
     authPath: /auth
     # path for POST requests
     postPath: /
     # path for GET requests
     getPath: /
...

line 21 should be set to this:

port: 4020

line 47 should be set to this:

port: 4080

Save the file, and now let’s setup deepstream to automatically run on startup.

# First you will need to bee your root user
sudo su;
# Change into the deepstream.io/dist/bin/ folder:
cd dist/bin/;
# add deepstream to the pm2
pm2 start deepstream --name deepstream;
# save the pm2 settings
pm2 save;
# add the startup process to pm2
pm2 startup;

# Now if you want to check pm2 to see if deepstream is running, just make sure you are root and...
pm2 ls;

You should see something like this:

┌────────────┬────┬──────┬──────┬────────┬─────────┬────────┬─────┬───────────┬──────┬──────────┐
│ App name   │ id │ mode │ pid  │ status │ restart │ uptime │ cpu │ mem       │ user │ watching │
├────────────┼────┼──────┼──────┼────────┼─────────┼────────┼─────┼───────────┼──────┼──────────┤
│ deepstream │ 0  │ fork │ 1552 │ online │ 0       │ 4h     │ 0%  │ 74.2 MB   │ root │ disabled │
└────────────┴────┴──────┴──────┴────────┴─────────┴────────┴─────┴───────────┴──────┴──────────┘
 Use `pm2 show <id|name>` to get more details about an app

If you want to view the logs for deepstream, just sudo su, then you can view deepstream logs:

pm2 log deepstream;

You should see this:

audstanley-G750JM bin # pm2 log deepstream
[TAILING] Tailing last 15 lines for [deepstream] process (change the value with --lines option)
/root/.pm2/logs/deepstream-error-0.log last 15 lines:
/root/.pm2/logs/deepstream-out-0.log last 15 lines:
deepstre |  =====================   starting   =====================
deepstre | INFO | logger ready: std out/err
deepstre | INFO | deepstream version: 4.0.0-beta.2
deepstre | INFO | configuration file loaded from ../conf/config.yml
deepstre | INFO | authenticationHandler ready: none
deepstre | INFO | cache ready: local cache
deepstre | INFO | storage ready: noop storage
deepstre | INFO | permissionHandler ready: valve permissions loaded from /home/audstanley/Documents/deepstream.io/dist/conf/permissions.yml
deepstre | INFO | Listening for websocket connections on 0.0.0.0:4020/deepstream
deepstre | INFO | Listening for health checks on path /health-check
deepstre | INFO | connectionEndpoint ready: µWebSocket Connection Endpoint
deepstre | INFO | Listening for http connections on 0.0.0.0:4080
deepstre | INFO | Listening for health checks on path /health-check
deepstre | INFO | connectionEndpoint ready: HTTP connection endpoint
deepstre | INFO | Deepstream started

Ctrl-C to get out of viewing the log.

# To log out of root user:
exit;

Now you have successfully installed deepstream, and pm2 will launch deepstream every time your computer starts up. Now you can get and post data to deepstream. You will need the deepstream.py file in your project’s folder to get and post data easily to deepstream. The deepstream.py file has a dependency called: requests,

Let’s install that NOW

sudo apt-get install python-requests

Happy coding Titan Rover data to deepstream.

Windows Guide:¶

If you are on windows, there are two ways you can install deepstream.

Follow this guide first, then you can install NodeJs in bash. Open the Windows command prompt:

bash

Then you can follow this Linux portion of this guide

The second method is boring and complex, just get bash on ubuntu on windows.

Mac Guide:¶

todo;