Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arr2036/omnigollum
Omniauth authentication for gollum
https://github.com/arr2036/omnigollum
Last synced: 1 day ago
JSON representation
Omniauth authentication for gollum
- Host: GitHub
- URL: https://github.com/arr2036/omnigollum
- Owner: arr2036
- License: mit
- Created: 2011-06-05T00:42:57.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2023-04-12T06:19:50.000Z (almost 2 years ago)
- Last Synced: 2024-04-24T18:09:07.520Z (9 months ago)
- Language: Ruby
- Homepage:
- Size: 130 KB
- Stars: 146
- Watchers: 7
- Forks: 61
- Open Issues: 14
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - arr2036/omnigollum - Omniauth authentication for gollum (others)
README
# omnigollum - omniauth meets gollum
## Quick Installation/Configuration
```sh
$ git clone https://github.com/arr2036/omnigollum.git
$ cd omnigollum
$ gem build omnigollum.gemspec
$ gem install omnigollum*.gem
```
```sh
$ cp config.rb.example config.rb
```
Customize config.rb to use your preferred omniauth strategy.
Execute via Gollum
```sh
$ gollum --config config.rb
```
## Installation
```sh
$ gem install omnigollum
```
## Configuration
Omnigollum executes an OmniAuth::Builder proc/block to figure out which providers you've configured,
then passes it on to omniauth to create the actual omniauth configuration.
To configure both omniauth and omnigollum you should add the following to your config.ru file.
### Load omnigollum library
```ruby
require 'omnigollum'
```
### Load individual provider libraries
```ruby
require 'omniauth/strategies/twitter'
require 'omniauth/strategies/open_id'
```
### Set configuration
```ruby
options = {
# OmniAuth::Builder block is passed as a proc
:providers => Proc.new do
provider :twitter, 'CONSUMER_KEY', 'CONSUMER_SECRET'
provider :open_id, OpenID::Store::Filesystem.new('/tmp')
end,
:dummy_auth => false
}
# :omnigollum options *must* be set before the Omnigollum extension is registered
Precious::App.set(:omnigollum, options)
```
### Access control
By default, any authenticated user will be able to access the protected routes. Restrict this by setting the `authorized_users` option.
`authorized_users` accepts an array of emails. Users must authenticate with one of these authorized emails in order to be allowed access.
```ruby
options[:authorized_users] = ["[email protected]", "[email protected]", "[email protected]"]
```
Instead of setting these directly, you can use an env var, maybe like this:
```ruby
# in .env, or other
# [email protected],[email protected],[email protected]
options[:authorized_users] = ENV["OMNIGOLLUM_AUTHORIZED_USERS"].split(",")
```
### Register omnigollum extension with sinatra
```ruby
Precious::App.register Omnigollum::Sinatra
```
## Required patches
### Gollum
You can (optionally) apply the patches here, to get a neat little auth
status widget in the top right corner of the page https://github.com/arr2036/gollum/commit/dd1fdad59d9f12bfe637704c0101af96aaa1a7e4