Skip to content
Snippets Groups Projects

Improved the readability of the README file.

1 file
+ 27
20
Compare changes
  • Side-by-side
  • Inline
+ 27
20
@@ -7,38 +7,45 @@ configuration.
## Status and Weight
The status and weight are used by Config Filter. Only active filters are
applied and they are sorted by weight: Smaller (or negative) weights first
applied, and they are sorted by weight: Smaller (or negative) weights first
bigger weights last (they sink to the bottom of the list.)
## Modes
The following modes are currently implemented:
The module supports the following modes for handling role permissions during
configuration synchronization:
### Split
The roles and permissions are removed from the export and maintained only in
the configuration of the role split filter. When importing, the permissions
defined in the role are merged with the ones defined in the filter. When
exporting the permissions are *split* and the role will not have the permission
all the while the role in the active configuration will have it.
**Import behavior**: On import, permissions from both the role and the role
split filter are merged into the active configuration. The active role ends up
with the combined set of permissions, even though the export omits the ones
managed by the filter.
**Export behavior**: Permissions assigned to roles are removed from the
export and managed exclusively through the role split filter configuration.
This means exported roles will appear to lack those permissions.
### Fork
The permissions defined in the filter configuration are merged when importing.
But when exporting the exported role is cheched first and permissions that
are already exported will not be removed from the export. Permissions that
are active in the sites configuration and defined in the filter but not in
the role in the sync directory are not added to the role in the sync directory.
**Import behavior**: Permissions defined in the role split filter are merged
into the role during import.
**Export behavior**: When exporting, existing permissions in the exported
role are preserved. Permissions present in the site's active configuration
and the filter—but not already in the exported role—are not added.
Essentially, only what's already in the sync directory is retained.
### Exclude
The permissions that are attached to a role in the sync directory that are
defined in a exclude filter are removed and will not be part of the active
configuration when importing. When exporting the permissions which have been
exluded will be added back to the role in the sync directory, provided it
already has them there.
**Import behavior**: Permissions listed in the exclude filter and assigned to
a role in the sync directory are removed during import and won’t be part of
the active configuration.
**Export behavior**: During export, any previously excluded permissions
that exist in the sync directory's role definition are re-added to the role.
## Roles
Currently the form for entering the role configuration is very crude but works.
Currently, the form for entering the role configuration is very crude but works.
The roles configuration should be an array of roles with and array of
The roles configuration should be an array of roles with nested arrays of
permissions. Not all the sites roles or all the active permissions need to be
listed, only the ones the filter should interact with.
@@ -51,5 +58,5 @@ authenticated:
- 'access user profiles'
```
The roles should be the id of the role and the permissions should be the same
The roles should be the id of the role, and the permissions should be the same
string as the permission id.
Loading