diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 7dc5922951b..5e99db71bdf 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -86,6 +86,8 @@ pages: - ['http_api/snapshot.md', 'API', 'Snapshot API'] - ['http_api/other.md', 'API', 'Other API'] +- ['plugins/plugins.md', 'Plugins', 'Plugins'] + - ['tutorials/index.md', 'Tutorials', 'Tutorials'] - ['tutorials/hubot_howto.md', 'Tutorials', 'How To integrate Hubot and Grafana'] diff --git a/docs/sources/plugins/installation.md b/docs/sources/plugins/installation.md new file mode 100644 index 00000000000..8a84d1851cd --- /dev/null +++ b/docs/sources/plugins/installation.md @@ -0,0 +1,31 @@ +--- +page_title: Plugin installation +page_description: Plugin installation for Grafana +page_keywords: grafana, plugins, documentation +--- + +# Plugins + +## Installing plugins + +The easiest way to install plugins is by using the CLI tool grafana-cli which is bundled with grafana. + +To list available plugins +``` +grafana-cli list-remove +``` + +To install a plugin type +``` +grafana-cli install +``` + +To list installed plugins +``` +grafana-cli ls +``` + +to upgrade all installed plugins +``` +grafana-cli upgrade-all +``` diff --git a/docs/sources/reference/plugins.md b/docs/sources/reference/plugins.md deleted file mode 100644 index 8ed4e30853d..00000000000 --- a/docs/sources/reference/plugins.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -page_title: Plugin guide -page_description: Plugin guide for Grafana -page_keywords: grafana, plugins, documentation ---- - -# Plugins - -!Plugin support for panels is only available in nightly! - -Adding support for all datasources and suggested panels would bloat grafana and make it impossible to maintain. That's why we implemented a plugin system that makes it possible for anyone to develop support for a datasource or custom panel without adding it to Grafana itself. - -## Installing plugins - -Installing a plugin is very simple. Just download it and place it in the Grafana plugins folder and restart grafana. - -The default plugin folder is configurable under paths.plugins - -It's also possible to add one specific plugin by linking to its folder. - -``` -[plugin.mirror] -path = /home/evil-queen/datasource-plugin-mirror -``` - -## Plugin implementation ## - -Each plugin is defined in plugin.json file in the plugin folder. - -Instead of massive documentation about how it works we created a reference implementation of a plugin. -You can find each reference implementation further down on this page. - -## Datasource plugins - -Datasource have three responsibilities. - - * UI for configuring its settings - * Datasource object that can send queries, metricqueries and healthcheck the datasource - * Query editor within panels - -https://github.com/grafana/datasource-plugin-genericdatasource - -## Panel plugins - -Panel plugins are responsible for - - * UI for Panel options. - * Creating a directive that can render something based on datasource data. - -We currently dont have a reference implementation for panel plugins but you can checkout https://github.com/grafana/panel-plugin-piechart