Plugins

What is a plugin?

A plugin is software running on top of Linkurious Enterprise extending its capabilities. For example, a plugin that adds the functionality of importing your data to Linkurious Enterprise via CSV files.

What is an official Linkurious Enterprise plugin?

Official plugins are plugins built, distributed, and maintained by Linkurious team. Customers and 3rd party developers can easily create their own plugins using our detailed Plugins Development Guide.

What are the currently available official Linkurious Enterprise Plugins?

• Plugin Manager (plugin-manager): A tool to easily manage plugins in Linkurious Enterprise.
• CSV Importer (csv-importer): A tool for importing data into your data source quickly from a CSV file.
• Data Table (data-table): Get results of a query in a table.
• Image Export (image-export): Export visualization as an image file for printing or presentations.

How do I install plugins?

The preferred way is to perform the installation through the Plugin Manager web interface (by default accessible from /plugins/plugin-manager). It requires an admin account.

In case you need to perform a manual installation, you can proceed as follow:

Make sure to have write access to the Linkurious Enterprise installation folder of as well as an application admin account.

1. Obtain the .lke file of the plugin you need to install, for official plugins you can download it from the Releases section of the plugin page
2. Copy the .lke file to the following path <linkurious>/data/plugins
3. From the Linkurious Enterprise dashboard, go to Admin -> Global configuration
4. Scroll to the Plugins settings field
5. Add a space at the end of the Plugins settings section
6. Click "Save". This will restart all the plugins to apply the new configurations.

How do I automatically install official plugins?

If you want the system to automatically install official plugins, you can set the LKE_PLUGINS environment variable as an array of strings for every plugin to be deployed. The valid strings are available in the list of official plugins.

If you are using Docker, the environment variable needs to be set for the container.

If the variable is not defined, the system will consider the below as default (deploying the Plugin Manager and the Image Export plugins).

LKE_PLUGINS=["plugin-manager","image-export"]

The version that will be installed depends on your Linkurious Enterprise version. Be sure to keep the system up to date to have the latest version of the plugins installed.

How do I configure plugins?

1. From the Linkurious Enterprise dashboard, go to Admin -> Global configuration
2. Scroll to the Plugins settings field
3. Find the name of your plugin in the Plugins settings section (if the plugin has never started before you will not find it, you can either add the configuration manually or start the plugin first)
4. Add the relevant configurations, for official plugins you can find details in the plugin page
5. Click "Save". This will restart all the plugins to apply the new configurations.

You can configure multiple instances of a single plugin by adding a new JSON object to the plugin's array.

Configuration keys supported by all the plugins:

The following example will deploy:

• An instance of my-plugin that will be accessible by its default path /plugins/my-plugin (the plugin name)
• An instance of my-second-plugin that will be accessible from the custom path /plugins/my-path
• A second instance of my-second-plugin that will be accessible from the custom path /plugins/my-other-path

{
  "my-plugin": [
  ],
  "my-second-plugin": [
    {
      "basePath": "my-path"
    },
    {
      "basePath": "my-other-path",
    }
  ]
}

How do I uninstall plugins?

To completely uninstall a plugin from the system (i.e. all the deployed instances), you can either use the Plugin Manager or remove the file manually added through the manual installation.

After the above procedure, any configuration for to the removed plugin will be ignored by the system. If you are not foreseeing to reuse the plugin in the future, you may want to clear the related plugin's configurations to only keep active ones.

If you have deployed several instances of a plugin and want to uninstall some of them, edit the plugins configuration and remove the entries for the instances you want to remove.

What do I need to be able to use the plugin?

Once installed and configured, any Linkurious Enterprise authenticated user can use the plugin. Additional restrictions may be imposed by the plugin itself.

We recommend configuring a custom action in Linkurious Enterprise to avoid building the link to the plugin manually.

Are plugins compatible with all versions of Linkurious Enterprise?

Compatibility is mentioned on the download page of each plugin. You can easily identify that by looking at the minimal and maximal supported Linkurious Enterprise version.

What can I expect about maintenance and bug fixes?

If you are facing problems with a plugin follow the next steps:

• Make sure you are running the latest supported version of Linkurious Enterprise.
• Make sure you are running the latest version of the plugin.

If you are still facing problems, please get in touch with support while keeping this in mind:

• Compare your Linkurious Enterprise version to the min-max allowed versions for the plugin.
• If the version is within the supported range, the policy will be:
  • Beta version: best effort.
  • Stable version: fix functionally impacting bugs (timeliness depends on the severity).
  • Maintenance version: fix only critical bugs.