Installing and using plugins

Installing and using plugins

There are many plugins included in Sal, and there are also lots of additional ones that are available on the GitHub organization. Each set of plugins will have their own instructions (naming of the directory etc.), but the general procedure is as follows.

This assumes you have installed Sal using Docker. If you have not, and have followed the Ubuntu installation instructions, replace /usr/local/sal_data/plugins with /usr/local/sal_install/sal/plugins.

Downloading the plugins

$ mkdir -p /usr/local/sal_data/plugins
$ cd /usr/local/sal_data/plugins
$ git clone https://github.com/pluginauthor/sal-plugins pluginauthor

Mounting the plugins directory

This is only required if you are using Docker (it is recommended that you replace latest with the version you want to run).

$ docker run -d --name="sal"\
  -p 80:8000 \
  --link postgres-sal:db \
  -v /usr/local/sal_data/plugins:/home/docker/sal/plugins \
  -e ADMIN_PASS=pass \
  -e DB_NAME=sal \
  -e DB_USER=admin \
  -e DB_PASS=password \
  macadmins/sal:latest

Activating the plugins in Sal

Click on the 'person' icon in the toolbar and choose:

• Settings
• Plugins

There are currently three forms of plugin: widgets, which appear on the dashboard screens and can be re-ordered, reports which are full page, and machine detail widgets - these show information about one machine on the machine detail page.