Draft: Publish Plugin to Cloud - Labs
Every MOD Duo has a Plugin Store which is connected to the cloud API. So when a new plugin is published by the MOD Team any user can install it directly from the MOD UI. As part of the MOD Labs initiative a new environment has been created to allow developers to publish their creations so MOD Duo users can also install and use them.
This article will explain how developers can publish plugins in the labs cloud environment and also how users can change their Duo configuration to consume them.
In order to create a plugin you have to:
- Develop the source code of an LV2 plugin
- Add a GUI
- Compile it
- Publish to your Duo (locally)
If you're not familiar with some of the steps above you can look at How To Build and Deploy LV2 Plugin to MOD Duo.
Compile and Publish
MOD command line interface
For building and publishing a plugin in the cloud, the modcli is used. This is a small python tool that will communicate with the cloud API. To build and publish a plugin the following steps are needed:
- Install the mod command line interface(modcli). This is a small python tool that will communicate with the cloud API.
- Prepare a descriptor file that is needed by the modcli.
- Use the modcli for to compile and publish the plugin in cloud.
Please see MOD command line interface, for detailed information about the descriptor file and on how to use the modcli for publishing plugins to LABS.
To publish a plugin to the cloud, the following command is used:
$ modcli bundle publish lv2-example.json Submitting release process for project ./lv2-examples.json using file lv2-examples.tar.gz URL: https://pipeline-labs.moddevices.com/bundle Release process created: xxx Uploading buildroot package lv2-examples.tar.gz ... Checksum match ok! Cleaning up... Process url: https://pipeline-labs.moddevices.com/bundle/xxx/?pretty=true Done
Please see the section about the mod license interface above for more information on how to set this up.
At the end you'll see a process url. You can load it with curl:
$ curl "https://pipeline-labs.moddevices.com/bundle/xxx/?pretty=true"
That's the publishing process that has been created in the cloud. Keep refreshing it until the status changes to
You can check the logs opening the logs_href URL in case there any issues. Once the status changes to
finished the plugin is available in the labs cloud API.
To verify the published bundles you can call the cloud API:
$ curl "https://api-labs.moddevices.com/v2/lv2/plugins?pretty=true&budle_name=eg-amp.lv2"
Changing your Duo to point to the labs API
Any user interested in using your published plugin can point their MOD Duo to the labs environment.
Important Note: by following the steps below your device will only see the plugins published in labs. After installing plugins from labs you have to revert the changes to point to the original production environment. Any plugin installed will continue to exist even after changing the environment in your device.
SSH to your Duo
pc$ ssh email@example.com
The default root password is mod. The prompt pc$ means you have to type the following on the command line of your computer. Then duo$ indicates the following must be typed while logged in on the Duo.
Remount / in RW mode
duo$ mount / -o remount,rw
Edit API addresses
First lets backup the original file so you can restore the factory values later.
duo$ cp /etc/mod-api-addresses /etc/mod-api-addresses.bkp
/etc/mod-api-addresses to look like:
export MOD_CLOUD_HTTP_ADDRESS="https://api-labs.moddevices.com/v2" export MOD_PEDALBOARDS_HTTP_ADDRESS="https://pedalboards-labs.moddevices.com"
duo$ systemctl restart mod-ui
You are done. Exit the Duo with
Open Plugin Store
Now if you open the Plugin Store in your MOD UI (http://modduo.localhost) you should see the plugins from the labs environment.