Fork of the fork
Go to file
Nic Waller 1977912f40 First impressions of web GUI for authmgr #10 2013-06-01 23:30:15 -07:00
authmgr First impressions of web GUI for authmgr #10 2013-06-01 23:30:15 -07:00
README.md changed formatting of "default roles" to a table. 2013-05-31 23:41:07 -06:00

README.md

yourls-authmgr-plugin

This plugin adds role-based access controls (RBAC) to YOURLS. By assigning users to roles like "Editor" and "Contributor" you can limit the changes they are permitted to make.

With access controls enabled, you can safely delegate access to the admin pages.

Installation

  1. Download the latest release of yourls-authmgr-plugin.
  2. Copy the plugin folder into your user/plugins folder for YOURLS.
  3. Set up the parameters for authmgr (details below)
  4. Activate the plugin with the plugin manager in the YOURLS admin interface.

Default Roles

The default roles are set up as follows:

Role Capabilities
Administrator No Limits
Editor Cannot manage plugins
Contributor Cannot manage plugins, edit URLs, or delete URLs

Configuration

Add role assignments to your user/config.php file.

$authmgr_role_assignment = array(
  'administrator' => array(
    'your_username',
  ),
  'editor' => array(
    'your_close_friend',
  ),
  'contributor' => array(
    'your_other_friend',
  ),
);

You can also designate a range of IP addresses that will automatically be granted all capabilities. By default, all accesses from IPv4 localhost (127.0.0.0/8) are granted full access.

$authmgr_admin_ipranges = array(
    '127.0.0.0/8',
);