Skip to content

Commit

Permalink
Adds a screencast
Browse files Browse the repository at this point in the history
  • Loading branch information
derjust committed Jun 20, 2020
1 parent ae0058f commit 2d12b65
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,22 @@ A simple panel that shows only one button - to integrate with any kind of HTTP/R
* Support API key via header `X-API-Key` or query parameter `?api-key`
* Custom label text & Grafana template design

## Configuration

![Screenshot](img/screenshot.png)

## Usage

![Screencast](img/screencast.gif)

## Install

### CLI

Via the [Grafana CLI](https://grafana.com/docs/grafana/latest/administration/cli/):

```BASH
$ grafana-cli --pluginUrl https://github.com/cloudspout/cloudspout-button-panel/releases/download/7.0.0/cloudspout-button-panel.zip \
$ grafana-cli --pluginUrl https://github.com/cloudspout/cloudspout-button-panel/releases/download/7.0.1/cloudspout-button-panel.zip \
plugins install cloudspout-button-panel
```

Expand All @@ -24,8 +30,8 @@ $ grafana-cli --pluginUrl https://github.com/cloudspout/cloudspout-button-panel
Use [Grafana's environment variable](https://grafana.com/docs/grafana/latest/installation/docker/#build-and-run-a-docker-image-with-pre-installed-plugins) to add this plugin to your installation:

```BASH
$ docker run -it \
-e "GF_INSTALL_PLUGINS=https://github.com/cloudspout/cloudspout-button-panel/releases/download/7.0.0/cloudspout-button-panel.zip;cloudspout-button-panel" \
$ docker run -p 3000:3000 -it \
-e "GF_INSTALL_PLUGINS=https://github.com/cloudspout/cloudspout-button-panel/releases/download/7.0.1/cloudspout-button-panel.zip;cloudspout-button-panel" \
grafana/grafana:7.0.3
```

Expand Down
Binary file added img/screencast.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2d12b65

Please sign in to comment.