Skip to content
This repository has been archived by the owner on Jan 18, 2023. It is now read-only.

Latest commit

 

History

History
67 lines (42 loc) · 2.08 KB

INSTALL.md

File metadata and controls

67 lines (42 loc) · 2.08 KB
Raw

Installing this application

This application NodeJS for server-side rendering. It can also be installed on Heroku with one-click by clicking the button below.

Deploy to Heroku

Requirements

Install the following:

  • NodeJS v6.9.0+
  • NPM v5.1.0+
  • Git (optional)

Setup

Clone or download the project and change to the project root directory:

$ git clone git://github.com/opentok/opentok-video-embed-demo
$ cd opentok-video-embed-demo

Install application dependencies:

$ npm install

Start the application on default port (3000):

$ npm start

To run the application on a different port, say 8080, specify the PORT environment variable:

$ PORT=8080 npm start

First time setup

  • Create an OpenTok video embed and copy the generated code
  • Once the application is up and running, open it in Firefox or Google Chrome.
  • Click the button "Setup/Update embed code"
  • Paste the embed code in the text box and click "Set up"

Note: If you don't want the setup option to be available after first setup, start the application with environment variable LOCK_SETUP=true.

Setting up SSL

WebRTC requires web applications to be served over a secure channel so we will host this application over HTTPS. We recommend using Heroku because it serves all applications over HTTPS. Alternatively, you can set up nginx as a reverse proxy with SSL termination.

Debug

Use NODE_DEBUG environment variable to turn on debug flags for specific components. NODE_DEBUG takes a comma-separated string of component names. Available components for this application are:

  • app: Shows debug messages for the application, including any errors caught by the application

Here are few examples of using the debug mode:

Show debug messages for the app:

$ NODE_DEBUG=app npm start