# Gollum::Auth - Authentication Middleware for Gollum Wiki

`Gollum::Auth` is a Rack-Middleware to add
[HTTP Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication)
to
[gollum](https://github.com/gollum/gollum).
This requires users to authenticate in order to change the wiki (create /
edit / delete / rename / revert pages).
Read-only access is permitted by default.


## Installation

Add this line to your application's Gemfile:

```ruby
gem 'gollum-auth'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install gollum-auth


## Usage

You have to run
[Gollum via Rack](https://github.com/gollum/gollum/wiki/Gollum-via-Rack)
and use this middleware *before* gollum.
Here is a sample `config.ru`:

```ruby
#!/usr/bin/env ruby
require 'rubygems'
require 'gollum/auth' # Load the gem!
require 'gollum/app'

# Enable Authentication and define users *before* running Precious::App!
use Gollum::Auth, users: YAML.load(%q{
---
- user: admin
  password: test
- user: foo
  password: bar
})

gollum_path = File.expand_path(File.dirname(__FILE__)) # CHANGE THIS TO POINT TO YOUR OWN WIKI REPO
wiki_options = {:universal_toc => false}
Precious::App.set(:gollum_path, gollum_path)
Precious::App.set(:wiki_options, wiki_options)
run Precious::App
```


## Development

After checking out the repo, run `bin/setup` to install dependencies.
Then, run `rake spec` to run the tests. You can also run `bin/console` for an
interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`.
To release a new version, update the version number in `version.rb`, and then
run `bundle exec rake release`, which will create a git tag for the version,
push git commits and tags, and push the `.gem` file to
[rubygems.org](https://rubygems.org).


## Contributing

Bug reports and pull requests are welcome on the official
[GitHub Repository](https://github.com/bjoernalbers/gollum-auth).
This project is intended to be a safe, welcoming space for collaboration, and
contributors are expected to adhere to the
[Contributor Covenant](http://contributor-covenant.org) code of conduct.


## License

The gem is available as open source under the terms of the
[MIT License](LICENSE.txt).