This repository has been archived on 2023-02-21. You can view files and clone it, but cannot push or open issues or pull requests.
redmine_cas/README.md

41 lines
1.6 KiB
Markdown

# Redmine CAS plugin
Plugin to CASify your Redmine installation.
## Compatibility
Tested with Redmine 2.2.x, 2.3.x, 2.4.x and 2.5.x but it should work fine with Redmine 2.x and possibly 1.x.
We use [CASino](http://casino.rbcas.com) as CAS server, but it might work with others as well.
## Installation
1. Download or clone this repository and place it in the Redmine `plugins` directory as `redmine_cas`
2. Restart your webserver
3. Open Redmine and check if the plugin is visible under Administration > Plugins
4. Follow the "Configure" link and set the parameters
5. Party
## Notes
### Usage
If your installation has no public areas ("Authentication required") and you are not logged in, you will be
redirected to the CAS-login page. The default login page will still work when you access it directly
(http://example.com/path-to-redmine/login).
If your installation is not "Authentication required", the login page will show a link that lets you login
with CAS.
### Single Sign Out, Single Logout
The sessions have to be stored in the database to make Single Sign Out work.
You can achieve this with a tiny plugin: [redmine_activerecord_session_store](https://github.com/pencil/redmine_activerecord_session_store)
### Auto-create users
By enabling this setting, successfully authenticated users will be automatically added into Redmine if they do not already exist. You *must* define the attribute mapping for at least firstname, lastname and mail attributes for this to work.
## Copyright
Copyright (c) 2013-2014 Nine Internet Solutions AG. See LICENSE.txt for further details.