Quick Start

Running Co-Browsing API On-Premise

To run Co-Browsing API on your infrastructure, you'll need to either run a Docker image that contains everything or host the components separately yourself.

If you have fewer than 5,000 Visitors online at any given time and no more than 100 concurrent Sessions, a single server will likely be enough. If you have more, you'll likely need to add more servers and scale Co-Browsing API horizontally by having a separate Redis cluster.

docker run -d \
  -e BASE_ENDPOINT=https://cobrowsing.acmetech.com/ \
  -e LICENSE_KEY=https://api.upscope.io/v1.3/.... \
  -e SECRET_KEY=myrandomsecretkey... \
  -p 5002:5002 \
  upscope/onpremise

BASE_ENDPOINT=http://localhost:5002 PORT=5002 \
LICENSE_KEY=https://api.upscope.io/v1.3/.... \
SECRET_KEY=myrandomsecretkey... ./upscope-data-linux

Installing Co-Browsing API on Your Website

After you run Co-Browsing API, the output will give you instructions for your JavaScript SDK installation code. It looks like this (notice {BASE_ENDPOINT}):

<script>
  (function(w, u, d){if(typeof u!=="function"){var i=function(){i.c(arguments)};i.q=[];i.c=function(args){i.q.push(args)};
  w.Upscope=i;var l = function(){var s=d.createElement('script');s.type='text/javascript';s.async=true;
  s.src='{BASE_ENDPOINT}/upscope.js';var x=d.getElementsByTagName('script')[0];x.parentNode.insertBefore(s,x);};l();}}
  )(window, window.Upscope, document);
  Upscope('init');
  Upscope('getWatchLink', console.log);
</script>

You can add that code to pages like you would with our cloud solution.

Your License Key

To run Co-Browsing API, you'll need to retrieve your license key. The license key can be downloaded to your server or read automatically from our server every time the server starts.

You'll need to enter the license key into the LICENSE_KEY environment variable. The LICENSE_KEY environment variable can be one of:

• The license key content (note it's multi-line)
• A file path to the license key content
• The URL to the license key, the preferred method

If you don't have to restrict the instance's interactions with the internet, entering the URL provided on the dashboard as the LICENSE_KEY environment variable is preferable as you won't need to update it when it expires.

Configuration

The following is configurable through environment variables:

If you use MONGO_URI=mongodb://localhost/upscope with the Docker image, a MongoDB server will be installed inside the container to serve the application.

If you use redis://localhost/ with the Docker image, a Redis server will be installed inside the container to serve the application.

API Endpoint

Check the on-premise REST API docs to know how to make requests to the on-premise instance.

What Doesn't Work On-Premise?

Although we've made our on-premise version as similar as possible to the original, there are a few missing functionalities. You'll need to use Co-Browsing API cloud if you are interested in:

• IP geolocation features
• Session video recording
• Audio/video communication