This repository has been archived on 2021-10-24. You can view files and clone it, but cannot push or open issues or pull requests.
greenlight/README.md

36 lines
2.4 KiB
Markdown
Raw Normal View History

2018-06-13 16:33:23 -04:00
# Greenlight
2018-05-07 16:06:01 -04:00
2018-07-11 10:23:16 -04:00
![Travis CI](https://travis-ci.org/bigbluebutton/greenlight.svg?branch=master)
> Greenlight is currently on version 2.0. If you are still running Greenlight 1.0 we suggest [upgrading to 2.0](http://docs.bigbluebutton.org/install/greenlight-v2.html#upgrading-from-greenlight-10).
2018-07-05 17:25:59 -04:00
2018-06-13 16:33:23 -04:00
Greenlight is a simple front-end interface for your BigBlueButton server. At it's heart, Greenlight provides a minimalistic web-based application that allows users to:
2018-05-07 16:06:01 -04:00
2018-06-13 16:33:23 -04:00
* Signup/Login with Twitter, Google, or through the application itself.
* Manage your account settings and user preferences.
* Create and manage your own personal rooms ([BigBlueButton](https://github.com/bigbluebutton/bigbluebutton) sessions).
* Invite others to your room using a simple URL.
* View recordings and share them with others.
2018-05-07 16:06:01 -04:00
2018-06-29 16:59:45 -04:00
Interested? Try Greenlight out on our [demo server](https://demo.bigbluebutton.org/gl)!
2018-05-07 16:06:01 -04:00
2018-07-05 17:25:59 -04:00
Greenlight is also completely configurable. This means you can turn on/off features to make Greenlight fit your specific use case. For more information on Greenlight and its features, see our [documentation](http://docs.bigbluebutton.org/install/greenlight-v2.html).
2018-06-29 16:59:45 -04:00
2018-07-04 15:22:59 -04:00
For a overview of how Greenlight works, checkout our Introduction to Greenlight Video:
[![GreenLight Overview](https://img.youtube.com/vi/Hso8yLzkqj8/0.jpg)](https://youtu.be/Hso8yLzkqj8)
2018-05-07 16:06:01 -04:00
2018-06-13 16:33:23 -04:00
## Installation on a BigBlueButton Server
2018-05-07 16:06:01 -04:00
2018-06-13 16:33:23 -04:00
Greenlight is designed to work on a [BigBlueButton 2.0](https://github.com/bigbluebutton/bigbluebutton) (or later) server.
2018-05-07 16:06:01 -04:00
2018-06-26 10:48:32 -04:00
For information on installing Greenlight, checkout our [Installing Greenlight on a BigBlueButton Server](http://docs.bigbluebutton.org/install/greenlight.html#installing-on-a-bigbluebutton-server) documentation.
2018-06-13 16:33:23 -04:00
2018-06-14 14:22:19 -04:00
## Source Code & Contributing
2018-06-13 16:33:23 -04:00
2018-06-29 16:59:45 -04:00
Greenlight is built using Ruby on Rails. Many developers already know Rails well, and we wanted to create both a full front-end to BigBlueButton but also a reference implementation of how to fully leverage the [BigBlueButton API](http://docs.bigbluebutton.org/dev/api.html).
2018-06-13 16:33:23 -04:00
We invite you to build upon GreenLight and help make it better. See [Contributing to BigBlueButton](http://docs.bigbluebutton.org/support/faq.html#contributing-to-bigbluebutton).
We invite your feedback, questions, and suggests about GreenLight too. Please post them to the [developer mailing list](https://groups.google.com/forum/#!forum/bigbluebutton-dev).