openproject/README.md

OpenProject Global Roles Plugin
==========================

This plugin adds global roles to [OpenProject](https://www.openproject.org).
A user can have a global role allowing to perform actions outside of the scope
of a specific project normally only allowed for administrators.
By assigning the permission to create projects to a global role,
non-administrators can create top-level projects.

To create a global role, go to the Administration view, select "Roles and permissions"
and click on "New Role". Afterwards, select the checkbox "Global Role" and choose the
permissions for this role. From the plugin, only "Create project" is available.
However, there are other plugins adding more permissions to be assigned to global
roles.

The created global roles can be assigned to individual users in the added "Global Roles"
tab of the user settings.

Requirements
------------

The Global Roles plugin currently requires the [OpenProject Core](https://github.com/opf/openproject/) in
version 3.0.0 or newer.


Installation
------------

For OpenProject Global Roles itself you need to add the following line to the `Gemfile.plugins` of OpenProject (if you use a different OpenProject version than OpenProject 4.1, adapt `:branch => "stable/4.1"` to your OpenProject version):

`gem "openproject-global_roles", git: "https://github.com/finnlabs/openproject-global_roles.git", :branch => "stable/4.1"`

Afterwards, run:

`bundle install`

This plugin contains migrations. To migrate the database, run:

`rake db:migrate`

Deinstallation
--------------

Currently, a complete automatic uninstall is not supported.
Before the plugin can be removed, all global roles have to be deleted.
Afterwards, remove the line

`gem "openproject-global_roles", git: "https://github.com/finnlabs/openproject-global_roles.git", :branch => "stable/4.1"`

from the file `Gemfile.plugins` and run:

`bundle install`

Please not that this changes by the plugin in the database. Currently, we do not
support full uninstall of the plugin.

Bug Reporting
-------------

If you find any bugs, you can create a bug ticket at

https://www.openproject.org/projects/plugin-global-roles

Development
-----------

To contribute, you can create pull request on the official repository at

`https://github.com/finnlabs/openproject-global_roles`

Credits
-------

Special thanks go to

* Deutsche Telekom AG (opensource@telekom.de) for project sponsorship

License
-------

(c) 2010 - 2014 - Finn GmbH

This plugin is licensed under the GNU GPL v3. See doc/COPYRIGHT.rdoc and
doc/GPL.txt for details.