Displays an Active Installs Dashboard and provide various visualizations

Description

This application displays information collected by the Active Installs Client API module.

How to use

Once installed, you should see an entry in the Applications Panel:

Clicking this link will get you to the Active Installs home page:

Features

8.4.1 <= XWiki

The UI displays:

• Pie chart of the various distributions ids allowing to find out what packagings users have used to install XWiki (Debian, WAR, HSQLDB/Jetty, etc.).

7.2 <= XWiki

• A new Velocity Macro has been introduced to compute the number of Active Installs having a specific Extension. For example:
  {{include reference="ActiveInstalls.ExtensionCount"/}}
  
  {{velocity}}
    #set ($extensionIds = [
      'org.xwiki.contrib:xwiki-totem-application',
      'jsimard:event-reporter-application',
      'mouhb:likeapplication'
    ])
    |=Extension Id|=Count
    #foreach($extensionId in $extensionIds)
      #countActiveInstallsUsingExtension($extensionId $count)
      |$extensionId|$count
    #end
  {{/velocity}}

6.1 <= XWiki

The UI displays:

• The total number of XWiki instances (having a distributionId of org.xwiki.enterprise:xwiki-enterprise-web, i.e. XE and for non-SNAPSHOT versions)
• The number of Active XWiki instances (instances that have sent a ping in the past day and which have a distributionId of org.xwiki.enterprise:xwiki-enterprise-web, i.e. XE and for non-SNAPSHOT versions)
• Graph of Active XWiki instances over time
• Pie chart of XWiki versions used by Active XWiki Installs
• Pie chart of Java versions used by Active XWiki Installs
• Pie chart of Databases used by Active XWiki Installs
• Pie chart of ServletContainers used by Active XWiki Installs

5.2 <= XWiki < 6.0

The UI displays:

• The total number of XWiki instances (disregarding the distributionId and including SNAPSHOT versions)
• The number of Active XWiki instances (instances that have sent a ping in the past month)

6.0 <= XWiki < 6.1

The UI displays:

• The total number of XWiki instances (having a distributionId of org.xwiki.enterprise:xwiki-enterprise-web, i.e. XE and for non-SNAPSHOT versions)
• The number of Active XWiki instances (instances that have sent a ping in the past 2 days and which have a distributionId of org.xwiki.enterprise:xwiki-enterprise-web, i.e. XE and for non-SNAPSHOT versions)

Usage Examples

You can browse collected data:

• The Active Installs page on xwiki.org
• The same data using a Kibana UI
• Querying raw data. For example the following query will collect the first 10 data for a search on non SNAPSHOT versions and for the org.xwiki.enterprise:xwiki-enterprise-web distribution id (i.e. XE):

  http://extensions.xwiki.org/activeinstalls/installs/install/_search?pretty=true&q=-distributionVersion:*SNAPSHOT%20AND%20distributionId:%22org.xwiki.enterprise:xwiki-enterprise-web%22&version=true&from=0&size=50&lowercase_expanded_terms=false

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

1. Log in the wiki with a user having Administration rights
2. Go to the Administration page and select the Import category
3. Follow the on-screen instructions to upload the downloaded XAR
4. Click on the uploaded XAR and follow the instructions
5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Dependencies

Dependencies for this extension (org.xwiki.platform:xwiki-platform-activeinstalls-server-ui 14.4.8):

• org.xwiki.platform:xwiki-platform-activeinstalls-server-api 14.4.8
• org.xwiki.platform:xwiki-platform-administration-ui 14.4.8
• org.xwiki.platform:xwiki-platform-rendering-macro-velocity 14.4.8
• org.xwiki.rendering:xwiki-rendering-macro-message 14.4.8
• org.xwiki.rendering:xwiki-rendering-macro-footnotes 14.4.8
• org.xwiki.platform:xwiki-platform-chart-macro 14.4.8
• org.xwiki.platform:xwiki-platform-rendering-macro-include 14.4.8
• org.xwiki.platform:xwiki-platform-dashboard-ui 14.4.8
• org.webjars:requirejs 2.3.6
• org.webjars:jquery 3.6.0
• org.xwiki.platform:xwiki-platform-panels-ui 14.4.8