Restrict the export functionality in spaces and for user groups
As a System Administrator or Confluence Administrator, you can choose which spaces and/or user groups have the option to export content with Scroll HTML Exporter.
To do this, simply navigate to Confluence administration > Scroll Runtime > Advanced Plugin Settings > select Scroll HTML Exporter from the dropdown. You can then edit the specific advanced plugin settings depending on the restrictions that you want to apply.
Advanced plugin settings
The advanced plugins work together and their values are case-sensitive which means they must match the defined values set in Confluence. Their parameters are described below:
The values for the advanced plugins are case-sensitive and must match the defined values set in Confluence.
Applying export restrictions in a space
| Key | Value | Description |
|---|---|---|
| export.restricted.to.spaces | * (default) | If the value is set to *, all spaces will have the option to export |
(empty) | If no value is set, every space will be restricted from exporting | |
SPACEKEY1,SPACEKEY2 | By defining a space key for this value, it is possible to whitelist a space so that the option to export is available. Multiple space keys can be entered in this field by using a comma separated list. | |
| export.disallowed.in.spaces | (empty) (default) | If the value is left empty, all spaces will have the option to export |
| * | If the value is set to *, all spaces will not have the option to export | |
| SPACEKEY1,SPACEKEY2 | By defining a space key for this value, it is possible to blacklist a space so that the option to export is unavailable. Multiple space keys can be entered in this field by using a comma separated list. |
Please note that the blacklist advanced plugin setting export.disallowed.in.spaces will take precedence over the whitelisting advanced plugin setting export.restricted.to.spaces. For example, if you were to define the same value for different plugin settings:
- export.restricted.to.spaces = * (all spaces have the option to export)
- export.disallowed.in.spaces = * (all spaces do not have the option to export)
This would result in all spaces not having the option to export.
Applying export restrictions for user groups
| Key | Value | Description |
|---|---|---|
| export.restricted.to.groups.global | * | If the value is set to *, all users will have the option to export |
| (empty) | If no value is set, every user group will be restricted from exporting | |
| USER-GROUP1,USER-GROUP2 | By defining a user group for this value, it is possible to whitelist a user group so that the associated users can export. Multiple user groups can be entered in this field by using a comma separated list. | |
| export.disallowed.for.groups.global | (empty) (default) | If the value is left empty, all users will have the option to export |
| * | If the value is set to *, the option to export will be unavailable for all users | |
| USER-GROUP1,USER-GROUP2 | By defining a user group for this value, it is possible to blacklist a user group from being able to export. Multiple user groups can be entered in this field by using a comma separated list. |
Please note that the blacklist advanced plugin setting export.disallowed.for.groups.global will take precedence over the whitelisting advanced plugin setting export.restricted.to.groups.global. For example, if you were to define the same value for different plugin settings:
- export.restricted.to.groups.global = * (all user groups have the option to export)
- export.disallowed.for.groups.global = * (all user groups do not have the option to export)
This would result in all user groups not having the option to export.
Furthermore, when blacklisting is not used and the whitelist setting is configured, only the defined whitelisted groups will be allowed to export, and all other non-whitelisted groups will be unable to to export (effectively becoming automatically blacklisted). This means if a Confluence user is included in multiple groups with different whitelist restrictions, the user will not have access to export because the restriction on the non-whitelisted group takes precedence.
For instance, with the following whitelisting setup:
- Group A - is whitelisted
- Group B - is not whitelisted
The following restrictions will be applied to the users;
- User-1 is included in Group A and is allowed to export
- User-2 is included in Group B and is not allowed to export
- User-3 is included in Group A & B and is not allowed to export