Skip to content

Commit

Permalink
Adds some additional headers to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
Derek Lindahl committed Jun 14, 2013
1 parent 6952999 commit e125ec7
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,19 @@ Rails.application.config.middleware.use OmniAuth::Builder do
end
```

### Configuration Options

#### Required

OmniAuth CAS requires at least one of the following two configuration options:

* `url` - Defines the URL of your CAS server (i.e. `http://example.org:8080`)
* `host` - Defines the host of your CAS server. Optional if using `url`
* `login_url` - Defines the URL used to prompt users for their login information. Defaults to `/login`
If no `host` is configured, the host application's domain will be used.

#### Optional

Other configuration options:

* `port` - The port to use for your configured CAS `host`. Optional if using `url`
Expand Down

0 comments on commit e125ec7

Please sign in to comment.