From 71831639f97e4ce63a16a4657e94b1d6f922e229 Mon Sep 17 00:00:00 2001 From: Zachary Chai Date: Fri, 2 Dec 2016 18:02:33 -0500 Subject: [PATCH] update readme and add new env file --- README.md | 28 +++++++++------------------- env | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 41 insertions(+), 19 deletions(-) create mode 100644 env diff --git a/README.md b/README.md index 7db80e4c..58b9450e 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,14 @@ -# README +# Greenlight -This README would normally document whatever steps are necessary to get the -application up and running. +Greenlight is a simple front-end application for [BigBlueButton](http://bigbluebutton.org/) -Things you may want to cover: +## Usage -* Ruby version +Install [docker](https://docs.docker.com/engine/getstarted/step_one/) +Create an environment variables file, here is a [template with instructions](https://raw.githubusercontent.com/zach-chai/greenlight/new_prod/env) +Start the server in docker -* System dependencies + docker run -d -p 3000:80 -v ${pwd}/db/production --env-file env bigbluebutton/greenlight -* Configuration - -* Database creation - -* Database initialization - -* How to run the test suite - -* Services (job queues, cache servers, search engines, etc.) - -* Deployment instructions - -* ... +You can change the published port (-p) default is 3000 +and the location of the environment variables file (--env-file) default is env diff --git a/env b/env new file mode 100644 index 00000000..801e123b --- /dev/null +++ b/env @@ -0,0 +1,32 @@ +# Rails secret key base +# +# You can generate a secure one through the Greenlight docker image with: +# `docker run --rm bigbluebutton/greenlight rake secret` +# +SECRET_KEY_BASE= + +# BigBlueButton +# +# The endpoint and secret from your bigbluebutton server +# +BIGBLUEBUTTON_ENDPOINT=http://test-install.blindsidenetworks.com/bigbluebutton/ +BIGBLUEBUTTON_SECRET=8cd8ef52e8e101574e400365b55e11a6 + +# Twitter Login Provider (optional) +# +# You will need to register the app at https://apps.twitter.com/ +# For the callback URL use 'http:///users/auth/twitter/callback' +# Once registered copy the ID and Secret here +# +TWITTER_ID= +TWITTER_SECRET= + +# Google Login Provider (optional) +# +# You will need to register for at https://console.developers.google.com/apis/credentials +# Select Oauth client ID -> web application +# For the callback URL use 'http:///users/auth/google/callback' +# Once registered copy the ID and Secret here +# +GOOGLE_OAUTH2_ID= +GOOGLE_OAUTH2_SECRET=