owncast

History

Owncast 822d107ee0 Commit updated Javascript packages		2021-10-11 21:38:53 +00:00
..
package-lock.json	Commit updated Javascript packages	2021-10-11 21:38:53 +00:00
package.json	Update + clean up old js module files	2021-10-11 14:37:41 -07:00
postcss.config.js
README.md
tailwind.config.js	Reduce the production build of TailwindCSS from 2M to 12k	2021-09-12 01:20:13 -07:00

README.md

Third party web dependencies

Owncast's web frontend utilizes a few third party Javascript and CSS dependencies that we ship with the application.

To add, remove, or update one of these components:

Perform your npm install/uninstall/etc, or edit the package.json file to reflect the change you want to make.
Edit the snowpack install block of package.json to specify what files you want to add to the Owncast project. This can be an entire library (such as preact) or a single file (such as video.js/dist/video.min.js). These paths point to files that live in node_modules.
Run npm run build. This will download the requested module from NPM, package up the assets you specified, and then copy them to the Owncast web app in the webroot/js/web_modules directory.
Your new web dependency is now available for use in your web code.

VideoJS versions

Currently Videojs version 7.8.3 and http-streaming version 2.2.0 are hardcoded because these are versions that have been found to work properly with our HLS stream. Other versions have had issues with things like discontinuities causing a loading spinner.

So if you update videojs or vhs make sure you do an end-to-end test of a stream and make sure the "this stream is offline" ending video displays properly.