Skip to content
This repository was archived by the owner on Jan 8, 2023. It is now read-only.

Latest commit

 

History

History
79 lines (38 loc) · 2.41 KB

README.md

File metadata and controls

79 lines (38 loc) · 2.41 KB

Sidekiq Monitor Github OAuth

Dependency Status Code Climate License-GPLv2-blue

A tiny Github-OAuth protected Sinatra app to display the current state of a Sidekiq installation.

Originally forked from tbalthazar/sidekiq-web-ui. This repo use Github OAuth instead of HTTP basic auth.

Usage

This standalone Sinatra app helps monitoring a Sidekiq installation running as a separate app.

Made to monitor a Sidekiq installation running on Heroku, but it should be usable elsewhere too.

Prerequisite

Register your application on Github.

Default authorization callback URL: <http://example.com>/auth/github/callback

You will need the Client ID and Client Secret.

Installation

git clone https://github.com/TangRufus/sidekiq-monitor-github-oauth.git
cd sidekiq-monitor-github-oauth
bundle install
cp .env.example .env

Deployment

If you are using Heroku, just click the deploy button and configure the envirment variables.

Deploy

Setting environment variables:

Edit the .env file values:

  • GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET

    Get these values from your Github application settings page

  • GITHUB_ORG

    Set this to your Github organization name to provide access to organization members only.

  • REDIS_URL

    URL to redis server

  • LOGOUT_REDIRECT_URL

    Where to go after logout?

  • WARDEN_GITHUB_VERIFIER_SECRET

    A very long random string

    $ openssl rand -base64 48 and $ rails secret are your friends.

To start the server:

$ heroku local web or $ foreman start