appliedis/grafana repository overview

⁠Grafana Docker image

This project builds a Docker image with the latest master build of Grafana.

⁠Running your Grafana container

Start your container binding the external port 3000.

docker run -d --name=grafana -p 3000:3000 grafana/grafana

Try it out, default admin user is admin/admin.

In case port 3000 is closed for external clients or you there is no access to the browser - you may test it by issuing: curl -i localhost:3000/login Make sure that you are getting "...200 OK" in response. After that continue testing by modifying your client request to grafana.

⁠Configuring your Grafana container

All options defined in conf/grafana.ini can be overriden using environment variables by using the syntax GF_<SectionName>_<KeyName>. For example:

docker run \
  -d \
  -p 3000:3000 \
  --name=grafana \
  -e "GF_SERVER_ROOT_URL=http://grafana.server.name" \
  -e "GF_SECURITY_ADMIN_PASSWORD=secret" \
  grafana/grafana

You can use your own grafana.ini file by using environment variable GF_PATHS_CONFIG.

More information in the grafana configuration documentation: http://docs.grafana.org/installation/configuration/⁠

⁠Grafana container with persistent storage (recommended)

# create /var/lib/grafana as persistent volume storage
docker run -d -v /var/lib/grafana --name grafana-storage busybox:latest

# start grafana
docker run \
  -d \
  -p 3000:3000 \
  --name=grafana \
  --volumes-from grafana-storage \
  grafana/grafana

⁠Installing plugins for Grafana 3

Pass the plugins you want installed to docker with the GF_INSTALL_PLUGINS environment variable as a comma seperated list. This will pass each plugin name to grafana-cli plugins install ${plugin}.

docker run \
  -d \
  -p 3000:3000 \
  --name=grafana \
  -e "GF_INSTALL_PLUGINS=grafana-clock-panel,grafana-simple-json-datasource" \
  grafana/grafana

⁠Building a custom Grafana image with pre-installed plugins

Dockerfile:

FROM grafana/grafana:5.0.0
ENV GF_PATHS_PLUGINS=/opt/grafana-plugins
RUN mkdir -p $GF_PATHS_PLUGINS
RUN grafana-cli --pluginsDir $GF_PATHS_PLUGINS plugins install grafana-clock-panel

Add lines with RUN grafana-cli ... for each plugin you wish to install in your custom image. Don't forget to specify what version of Grafana you wish to build from (replace 5.0.0 in the example).

Example of how to build and run:

docker build -t grafana:5.0.0-custom . 
docker run \
  -d \
  -p 3000:3000 \
  --name=grafana \
  grafana:5.0.0-custom

⁠Running specific version of Grafana

# specify right tag, e.g. 2.6.0 - see Docker Hub for available tags
docker run \
  -d \
  -p 3000:3000 \
  --name grafana \
  grafana/grafana:2.6.0

⁠Configuring AWS credentials for CloudWatch support

docker run \
  -d \
  -p 3000:3000 \
  --name=grafana \
  -e "GF_AWS_PROFILES=default" \
  -e "GF_AWS_default_ACCESS_KEY_ID=YOUR_ACCESS_KEY" \
  -e "GF_AWS_default_SECRET_ACCESS_KEY=YOUR_SECRET_KEY" \
  -e "GF_AWS_default_REGION=us-east-1" \
  grafana/grafana

You may also specify multiple profiles to GF_AWS_PROFILES (e.g. GF_AWS_PROFILES=default another).

Supported variables:

• GF_AWS_${profile}_ACCESS_KEY_ID: AWS access key ID (required).
• GF_AWS_${profile}_SECRET_ACCESS_KEY: AWS secret access key (required).
• GF_AWS_${profile}_REGION: AWS region (optional).

⁠Changelog

⁠v4.2.0

• Plugins are now installed into ${GF_PATHS_PLUGINS}
• Building the container now requires a full url to the deb package instead of just version
• Fixes bug caused by installing multiple plugins

⁠v4.0.0-beta2

• Plugins dir (/var/lib/grafana/plugins) is no longer a separate volume

⁠v3.1.1

• Make it possible to install specific plugin version https://github.com/grafana/grafana-docker/issues/59#issuecomment-260584026⁠