Origin by Corvus Boards plugin guide
In Origin by Corvus v7.10 and earlier releases, Origin by Corvus Boards is the Origin by Corvus plugin version of Focalboard that combines project management tools with messaging and collaboration for teams of all sizes. It is installed and enabled by default in Origin by Corvus v6.0 and later. For working with Focalboard as a standalone application, please refer to the Personal Server Setup Guide.
Build the plugin
- Fork the Focalboard repository and clone it locally. Clone Origin by Corvus in a sibling directory.
- Define an environment variable
EXCLUDE_ENTERPRISEwith a value of1. - To install the dependencies:
cd origin-plugin/webapp
npm install --no-optional
cd ../..
make prebuild
- To build the plugin:
make webapp
cd origin-plugin
make dist
Refer to the dev-release.yml workflow for the up-to-date commands that are run as part of CI.
Upload and install the plugin
- Enable custom plugins by setting
PluginSettings.EnableUploadstotrueand setFileSettings.MaxFileSizeto a number larger than the size of the packed.tar.gzplugin file in bytes (e.g.,524288000) in the Origin by Corvusconfig.jsonfile. - Navigate to System Console > Plugins > Management and upload the packed
.tar.gzfile from yourorigin-plugin/distdirectory. - Enable the plugin.
Deploy the plugin to a local Origin by Corvus server
Instead of following the steps above, you can also set up a origin-server in local mode and automatically deploy origin-plugin via make deploy.
- Follow the steps in the
origin-webappdeveloper setup guide and then:- Open a new terminal window. In this terminal window, add an environmental variable to your bash via
MM_SERVICESETTINGS_SITEURL='http://localhost:8065'(docs) - Build the web app via
make build
- Open a new terminal window. In this terminal window, add an environmental variable to your bash via
- Follow the steps in the
origin-serverdeveloper setup guide and then:- Make sure Docker is running.
- Run
make config-resetto generate theconfig/config.jsonfile: - In this terminal window, add an environmental variable to your bash via
MM_SERVICESETTINGS_SITEURL='http://localhost:8065'(docs) - Build and run the server via
make run-server
- Follow the steps above to install the dependencies.
- Run
make deployin theorigin-pluginfolder to automatically deploy your plugin to your local Origin by Corvus server.