Installation and Licensing (v 3.5)
- Andreas Ebert
Installation
Installing the App
Starting with version 3.5 User Profiles for Confluence is compatible with Confluence 9.x only. See Atlassian's documentation about Confluence 9 for more details especially its breaking changes.
To benefit from all features of User Profiles for Confluence the Enhanced Profile Macro has to be enabled. See the next section for instructions.
The app is available at the Atlassian Marketplace. To install the app, log in as a system administrator and navigate to the app management in the administration console (choose Cog icon > Manage apps at the top right of the screen. In the menu on the left click the “Find new apps” link. Search for “user profiles for confluence” to display our app “User Profiles for Confluence”. Click the Buy now or Free trial button to install the app.
If the installation was successful, a new section appears on the sidebar to the left: “User Profile Configuration”. This is where the customization of the user profiles takes place. If this section is not visible, please ensure that all required modules of the app are enabled. For that purpose, select the “User Profiles for Confluence” from the list of installed apps. Of the listed modules, only the modules named “profile” are not required for the app to work. All the other modules should be enabled.
Overwriting the standard profile macro
Background-Knowledge: The standard Confluence "profile" macro is required to display user data in the hover for users and in the personal space. User Profiles for Confluence provides its own version of a profile macro, the "enhanced profile macro". This version displays additionally created user profile elements, too. To benefit from all features of the enhanced profile macro, the standard profile macro has to be overwritten. This can be done by enabling the macro "profile" that ships with our app and behaves exactly like the enhanced profile macro this is done by
Enabling the “profile” macro module of “User Profiles for Confluence”
Switch to the Confluence administration, via Cog icon > General configuration or for older systems Browse > Confluence Admin.
- Go to the section Users & Security > User Profile Configuration > Advanced Options
- Go the section Enable Enhanced Profile Macro.
- Activate the toggle button "Enable enhanced profile macro".
Licensing
The app needs a valid license to have all the provided features working. Valid licenses are either full licenses, renewal licenses, or 30-day trials and are available on the Atlassian Marketplace. The license model is the same model that Atlassian uses for its products – for further information see Atlassians docmentation.
To get a license and provide it for the app, please carry out the following instructions, (also see the screenshot below):
- Go to the license settings page (Administration Console > Atlassian Marketplace: “Manage apps”)
- Use the links to create a new license at the Atlassian Marketplace (use “Free trial” to get a new trial license or “Buy now” to purchase a full license), or copy a license you got from Communardo.
- Enter the license key in the license screen.
Image 1: License Overview in UPM (click to enlarge)
Workaround (if one of the steps above does not work or is not available – this may happen with older Confluence versions)
- Create licenses with the links that are available in the Atlassian Marketplace
Uninstalling the app
Uninstall User Profiles for Confluence via Global Administration > Manage apps.
All Versions
- Release (v 3.5)
- Release (v 3.4)
- Release (v 3.3)
- Release (v 3.2)
- Release (v 3.1)
- Release (v 3.0)
- Release (v 2.1)
- Release (v 2.0)
- Release (v 1.12)
- Release (v 1.11)
- Release (v 1.10)
- Release (v 1.9)
- Release (v 1.8)
- Release (v 1.7)
- Release (v 1.6)
- Release (v 1.5)
- Release (v 1.4)
- Release (v 1.3)
- Release (v 1.2)
- Release (v 1.1)