Skip to content
Origin for developer.kaltura.com
Branch: master
Clone or download
Latest commit 6a8520f Apr 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets Added anchors for header tags Apr 15, 2019
codegen camelCase plugins in python Mar 19, 2019
homepage add metadata to homepage Jan 23, 2019
lib add ott lib Apr 26, 2017
markdown
routes add permissions to login Nov 19, 2018
scripts New API schema and client lib ver [14.18.0] Apr 15, 2019
styles removed the dark blue background from code blocks Mar 26, 2019
templates change GA tracking code strategy Jan 23, 2019
test camelCase plugins in python Mar 19, 2019
views use Lato font for discussion Apr 18, 2018
workflows/ovp Update workflow: create_and_manage_youtube_videos_as_native_kaltura_e… Mar 20, 2019
.gitignore
.travis.yml update lucybot Apr 18, 2019
LICENSE Initial commit Feb 24, 2017
LucyBot.js change GA tracking code strategy Jan 23, 2019
README.md Update README.md Mar 18, 2019
base.LucyBot.yml remove swiftype integration Jan 13, 2019
ott.LucyBot.yml
ott.openapi.json Rewrite Open API spec, LucyBot v4 (#55) Apr 11, 2018
ovp.LucyBot.yml Merge branch 'master' of https://github.com/kaltura/developer-platform Apr 3, 2019
ovp.openapi.json New API schema and client lib ver [14.18.0] Apr 15, 2019
package-lock.json npm audit fix Mar 20, 2019
package.json fix: package.json & package-lock.json to reduce vulnerabilities (#85) Mar 20, 2019
recipe-redirects.json
server.js
v4-navigation.js bug fixes Nov 28, 2018
v4-redirects.json Rewrite Open API spec, LucyBot v4 (#55) Apr 11, 2018

README.md

Kaltura API Documentation

This repository contains everything necessary to build documentation for the Kaltura VPaaS API using LucyBot.

The generated website is contained in kaltura/developer-platform-generated.

Documentation for LucyBot is available at docs.lucybot.com

Running

Running in Production

There are two target APIs: ovp (the standard Kaltura VPaaS) and ott.

ovp

npm install
git clone http://github.com/kaltura/developer-platform-generated generated/ovp
TARGET_API=ovp node server.js

ott

npm install
git clone http://github.com/kaltura/ott-developer-platform-generated generated/ott
TARGET_API=ott node server.js

Running in Development

npm install
TARGET_API=ovp lucybot build --prerender --truncate_prerender --destination generated/ovp
TARGET_API=ovp node server.js

or replace ovp with ott to build the OTT site.

Environment Options

Several options can be set using environment variables:

  • DEVELOPMENT - for use in active development, disables SSL and cache
  • NO_SSL
  • USE_CACHE
  • ENABLE_CROSS_ORIGIN
  • KALTURA_RECIPES_PORT
  • DISCOURSE_HOST
  • DISCOURSE_CATEGORY_ID
  • DISABLE_SWIFTYPE
  • ENABLE_HOMEPAGE
  • BASE_PATH
  • OTT_API_VERSION - relevant for 'ott' only. (e.g. v5_1_0)

Required in production

  • TARGET_API - either 'ott' or 'ovp'
  • KALTURA_SSO_SECRET
  • KALTURA_SSO_PAYLOAD
  • GITHUB_CLIENT_ID
  • GITHUB_CLIENT_SECRET
  • DISCOURSE_API_KEY - valid for forum.kaltura.org

Building

Any changes that are pushed to the master branch of kaltura/developer-platform will automatically trigger a Travis build. Travis will use LucyBot to update the generated/ folder with new HTML, CSS, and JS assets. Once Travis is finished, simply pull the result and restart the server.

Trigger a Build

If Travis fails, or you want to pull in the latest changes to LucyBot, you can manually trigger a build on Travis by pushing an empty commit:

git commit --allow-empty -m "Trigger CI"
git push

Testing

If you make changes to the codegen logic, you'll need to run the following to regenerate the test output:

WRITE_GOLDEN=true npm test

To check that there are no changes to codegen output, you can run:

npm test
You can’t perform that action at this time.