Usage - TheAppgineer/roon-extension-manager GitHub Wiki

Extension management

The Roon Extension Manager can be accessed from any Roon remote by selecting ☰→Settings→Extensions. Select its Settings button to manage extensions.

Extension selection

The extensions contained in the Extension Repository are divided in different categories. First select the Category and then select the Extension within that category.

Now the action to perform can be selected from the Action list, possible actions are:

Install

Use the Install action to install and start the selected extension.

If the selected extension has any specific settings then additional input fields are provided to supply them. For hardware devices default values are provided that should work for most configurations.

ℹ️ Refer to the extension documentation for detail about its installation settings.

Update

Use the Update action to update the selected extension to the latest version. If the selected extension is currently running then it will be updated and then restarted.

Extensions that have installation settings, e.g. a hardware device, have these settings configured during extension installation. If setting the right value was missed during installation then it can be viewed and changed as part of the update action.

ℹ️ As this type of update is explicitly requested by the user, it is also known as a manual update.

ℹ️ During a manual update an extension is always recreated, even if there is no newer version available.

Uninstall

Use the Uninstall action to stop and remove the selected extension.

Start / Restart / Stop

Use the Start, Restart or Stop action to change the execution state of the selected extension.

Pending Actions

All selected actions are collected in the Pending Actions list, meaning that multiple extensions can have an action selected. The actions are performed when the Settings dialog is closed via the Save button.

Auto update

An automatic update of all installed extensions is performed at the time that is set in the Check for Updates field. If it turns out that there is no newer version available for an extension then no further action is taken.

💡 Clear the Check for Updates field to disable automatic updates.

Extension logging

The Extension Manager has build-in logging functionality to allow the analysis of issues, might they occur. This covers issues in the Extension Manager itself but also issues encountered in one of the extensions that were installed via the manager. Each extension has its own log file to simplify the analysis.

Collecting logs is done via the Global Action in the Extension Manager Settings. This action will be put on the Pending Actions list and be performed when the Settings dialog is closed via the Save button.

The status message will show the progress and will tell when the log archive can be downloaded via the Extension Manager link.

When the download is finished the log archive can be shared with the extension developer for further analysis.

💡 The log archive is named extension-logs.tar.gz, the tar.gz format is natively supported on Linux and macOS. On Windows you can use the free 7-Zip tool.