Grafana#

Grafana is a Time Series Database graphing application.

amd64
arm64
armv7

Information#

Docker Image: !!! LINK TO DOCKER IMAGE/ DOCKER HUB !!!
Current Image Version: latest

SETUP#

Enabling grafana#

Command:#

vlab set grafana.enable True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

grafana
enable: True

Finalising changes:#

run: vlab update_one service=grafana

FIRST RUN#

!!! DEVELOPERS: make sure that you include any information that the user requires to get started, below. !!!
!!! Below are some examples with headings, and with some example instructions !!!

ADMINISTRATOR SETUP#

You can use it to visualize the Weather data imported by influxdb_darksky, power, activity, and other data from Home Assistant, and general server information via Telegraf.

Grafana comes configured with a Dashboard and Datasource connected for you out of the box. This default dash and datasource will only with if you have the TICK stack enabled.

You can login with the default user and pass you setup for VivumLab.

To reset the admin password run docker exec -it grafana_grafana_1 grafana-cli admin reset-admin-password 12345.

SMTP/ MAIL#

  1. run vlab decrypt to decrypt the vault.yml file
  2. make some changes

SMTP Settings#

smtp:
host:
port:
user:
pass:
from_email:
from_name:
  1. run vlab update_one service=grafana to complete the changes

ACCESS#

grafana (HTTPS) link: https://grafana.vivumlab.xyz/ grafana (HTTP) link: http://grafana.vivumlab.xyz/

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set grafana.https_only True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

grafana
https_only: True
Finalising changes:#

run: vlab update_one service=grafana

AUTH#

Default: False
Options: True/False

Command:#

vlab set grafana.auth True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

grafana
auth: True
Finalising changes:#

run: vlab update_one service=grafana

DOMAIN#

Default: False
NOTE: include the sitename and top level domain suffix. eg. name.com, site.net

Command:#

vlab set grafana.domain grafana.com

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

grafana
domain: grafana.com
Finalising changes:#

run: vlab update_one service=grafana

SUBDOMAIN#

Default: grafana
NOTE: Periods/ delimiters are not required. eg. 'media' will set the full URL as 'media.vivumlab.xyz'

Command:#

vlab set grafana.subdomain media

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

grafana
subdomain: media
Finalising changes:#

run: vlab update_one service=grafana

VERSION#

Default: latest
NOTE: Ensure that the version exists

Command:#

vlab set grafana.version 2.7

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

grafana
version: 2.7
Finalising changes:#

run: vlab update_one service=grafana

Need more help?#

Further information regarding services can be found.
General Information can be found in the documentation.
Additional assistance can be found on our Contact Us page.