On this page

After you have installed the add-on using UPM

  1. Create a new page
  2. Use Insert -> Markup
  3. Copy the following markup to the dialog, modify to your Confluence environment, and then hit enter
  4. Press Preview to see the results (avoid saving the page, see next steps below)
Wiki markup example
{cli:product=confluence|server=https://<your Confluence server>|user=<your Confluence user id>|password=<your Confluence user password>}
--action getServerInfo
{cli}

The result should look similar to this

Output
Confluence version: 5.5.0, build: 5609, url: https://bobswift.atlassian.net/wiki

Next steps

We recommend setting up a profile in your add-on configuration to store your server, user, and password information for security and re-use.

  1. Go to UPM
  2. Find the CLI add-on
  3. Press Configure
  4. Add a profile entry with the details of your server environment - see the following picture
  5. Now use {cli:profile=my-profile-entry} instead in the steps above (or use the Macro browser to modify your original example)

Profiles

Profiles allow administrators to save commonly used parameter sets for easy maintenance. This is especially important for accessing servers including server addresses, user ids, and passwords. Furthermore, by putting user ids and passwords in profiles, the password cannot be seen by normal users, only administrators that have access to add-on configuration can view the configuration.

It is important to understand the Security considerations for using profiles.


Profile NameUsed as the reference by the profile parameter
Profile ValueParameter values in wiki format - a pipe (|) separated list of key value pairs where the key is a parameter name from the CLI Macro parameter list.

Local Server

Use server=%base_url% in the profile to reference the current Confluence system. %base_url% can also be used in actions.

Security

The above section explains how to avoid putting passwords on pages. However, the configured profile can be used by anyone that can edit content on your site. If all you users are trusted, then you are good. However, in most cases you will want to restrict access to a group of users that are trusted to use this capability. This is accomplished by using Macro Security for Confluence and configuring access to the macro and perhaps to individual profiles. Go to the documentation for Macro Security for more information.