Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
O
omniauth-cas
Manage
Activity
Members
Labels
Plan
Issues
0
Issue boards
Milestones
Wiki
Code
Merge requests
0
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
nounous-archives
omniauth-cas
Commits
27fe579a
Commit
27fe579a
authored
13 years ago
by
Derek Lindahl
Browse files
Options
Downloads
Patches
Plain Diff
Added some brief usage guidelines to the README
parent
643c372c
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+19
-1
19 additions, 1 deletion
README.md
with
19 additions
and
1 deletion
README.md
+
19
−
1
View file @
27fe579a
...
...
@@ -22,7 +22,25 @@ Or install it yourself as:
## Usage
TODO: Write usage instructions here
Use like any other OmniAuth strategy:
Rails.application.config.middleware.use OmniAuth::Builder do
provider :cas, :host => 'cas.yourdomain.com'
end
OmniAuth CAS requires at least one of the following two configuration options:
*
`host`
- Defines the host of your CAS server. A default login URL of
`/login`
will be assumed.
*
`login_url`
- Defines the URL used to prompt users for their login information.
If no
`host`
is configured, the host application's domain will be used.
Other configuration options:
*
`port`
- The port to use for your configured CAS
`host`
*
`ssl`
- TRUE to connect to your CAS server over SSL.
*
`service_validate_url`
- The URL to use to validate a user. Defaults to
`/serviceValidate`
*
`logout_url`
- The URL to use to logout a user. Defaults to '/logout'
*
`uid_key`
- The user data attribute to use as your user's unique identifier. Defaults to
`user`
(usually their login name)
## Contributing
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment