Example Configurations

Example #1 - Restrict to Administrators Only

This properties file is a good starting point for new installations of Confluence. It restricts all macros and parameters to confluence-administrators. You can gradually open up capabilities on a macro-by-macro basis as needed.

Example #2 - No Restrictions

Use this properties file temporarily when adding Macro Security to a Confluence site that is already using macros that implement Macro Security. This gives administrator time to implement page restrictions and do testing before full implementation.

Example #3 - Moderate Restrictions

This properties file restricts most macros to members of the confluence-administrators group, but allows *ANY for many of the capabilities that a typical internal (employee-only) site would likely allow.

These macros are partially or fully restricted:

  • Beanshell
  • CLI
  • Code Pro
  • CSV* 
  • Excel 
  • Flash
  • Future*
  • Gant
  • Groovy
  • HTML
  • Html-bobswift (from HTML for Confluence version 5.7.0)
  • Include Remote
  • JSON Table *
  • Javascript
  • Jython
  • Markdown
  • Run*
  • Run Now*
  • SQL
  • SQL Query
  • XSLT

These macros are not restricted:

  • Cache
  • SQL FIle

* = The only restrictions relate to the use of certain parameters (aka Parameter Restrictions).

If you are just starting out:

  1. Select one of the examples above that most closely matches your requirements.
  2. Download the example properties file.
  3. Edit the properties file to suit your needs. For instance, you can either remove entries for macros you do not currently use or leave them in there in case they get added in the future.
  4. Save your changes.
  5. Go to a convenient location in Confluence and add the file as an attachment. Using an attachment is convenient as it is automatically versioned by Confluence for future reference and change control.
  6. From the Manage Add-ons admin page, expand the Macro Security for Confluence item and then click Configure.
  7. Specify the location of the properties file, in the format of spacekey:pagetitle^attachment.filename and then click Load to load the attachment that you previously added.

Configuration page, after loading the properties file that defines the security configuration.

Log a request with our support team.

Confluence®, Jira®, Atlassian Bamboo®, Bitbucket®, Fisheye®, and Atlassian Crucible® are registered trademarks of Atlassian®
Copyright © 2005 - 2024 Appfire | All rights reserved. Appfire™, the 'Apps for makers™' slogan and Bob Swift Atlassian Apps™ are all trademarks of Appfire Technologies, LLC.