Running gist-reveal

gist-reveal in a container

Start gist-reveal on port 8080 using docker or podman:

docker run --rm -p 8080:8080 ryanj/gist-reveal

Optionally configure the default gist_id:

docker run --rm -p 8080:8080 -e "DEFAULT_GIST=af84d40e58c5c2a908dd" ryanj/gist-reveal

Include your own GitHub API Token to avoid rate limiting:

docker run --rm -p 8080:8080 -e "GH_API_TOKEN=YOUR_API_TOKEN" ryanj/gist-reveal

Running gist-reveal

Broadcast Presentations via Websockets

To enable websockets, create a GitHub OAuth app that redirects to: YOUR_SITE/github/callback

Then configure your CLIENT_ID and CLIENT_SECRET:

docker run --rm -p 8080:8080 -e "CLIENT_SECRET=YOUR_SECRET_KEY" \
                             -e "CLIENT_ID=YOUR_CLIENT_ID" ryanj/gist-reveal

Running gist-reveal

gist-reveal on kubernetes

Create a kubernetes pod and service:

kubectl run gist-reveal --image=ryanj/gist-reveal \
--expose --port=8080 \
--env="DEFAULT_GIST=YOUR_DEFAULT_GIST_ID" \
--env="GH_API_TOKEN=YOUR_GH_API_TOKEN" \
--env="CLIENT_SECRET=YOUR_GH_CLIENT_SECRET" \
--env="CLIENT_ID=YOUR_GH_CLIENT_ID"

See the README for additional app configuration options