Portainer Templates logo

Portainer Templates

Grafana Grafana

Stack

MonitorTools

Grafana Dashboard anything. Observe everything. Query, visualize, alert on, and understand your data no matter where it’s stored. With Grafana you can create, explore, and share all of your data through beautiful, flexible dashboards.

Image details

Pulls: 5.3B
Architecture: amd64, arm64, arm/v7
Image size: 324 MB
Latest: 13.0-slim
User: grafana
Created: Feb 06, 2015
Updated: 2 days ago
Status: active

Source details

Repo: grafana/grafana
Stars: 76.3k
Forks: 14.6k
Language: TypeScript
License: AGPL-3.0
Latest: v13.1.3 · 9 days ago
Updated: 4 hours ago
Website: grafana.com/

Configuration

Type
Compose
Platform
linux
Image
grafana/grafana:latest
Ports
3030:3000
Volumes
/var/lib/grafana : /portainer/Files/AppData/Config/grafana/data/etc/grafana/grafana.ini : /portainer/Files/AppData/Config/grafana/grafana.ini/etc/grafana/provisioning : /portainer/Files/AppData/Config/grafana/provisioning
Env vars
GF_USERS_ALLOW_SIGN_UP=falseGF_PATHS_CONFIG=/etc/grafana/grafana.iniGF_PATHS_DATA=/var/lib/grafanaGF_PATHS_HOME=/usr/share/grafanaGF_PATHS_LOGS=/var/log/grafanaGF_PATHS_PLUGINS=/var/lib/grafana/pluginsGF_PATHS_PROVISIONING=/etc/grafana/provisioning
Restart
unless-stopped
Source
Repo

Template by novaspirit·Source

Notes

Template created by Pi-Hosted Series
Check our Github page: https://github.com/pi-hosted/pi-hosted

Official Webpage: https://grafana.com/grafana/
Official Docker Documentation: https://grafana.com/docs/grafana/v9.0/setup-grafana/installation/docker/

Pre-installation script must be RAN before you install: wget -qO- https://raw.githubusercontent.com/pi-hosted/pi-hosted/master/tools/install_grafana.sh | bash



Standalone Install

Select an install method, to see config/commands for deploying Grafana

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Grafana, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

version: "2.4"
services:
  grafana:
    container_name: grafana
    environment:
      - GF_USERS_ALLOW_SIGN_UP=false
      - GF_PATHS_CONFIG=/etc/grafana/grafana.ini
      - GF_PATHS_DATA=/var/lib/grafana
      - GF_PATHS_HOME=/usr/share/grafana
      - GF_PATHS_LOGS=/var/log/grafana
      - GF_PATHS_PLUGINS=/var/lib/grafana/plugins
      - GF_PATHS_PROVISIONING=/etc/grafana/provisioning
    hostname: grafana
    image: grafana/grafana:latest
    ports:
      - 3030:3000
    restart: unless-stopped
    volumes:
      # to be modified depending on your needs
      - /portainer/Files/AppData/Config/grafana/data:/var/lib/grafana
      - /portainer/Files/AppData/Config/grafana/grafana.ini:/etc/grafana/grafana.ini
      - /portainer/Files/AppData/Config/grafana/provisioning:/etc/grafana/provisioning

Or deploy it directly from the source:

git clone https://github.com/pi-hosted/pi-hosted
cd pi-hosted
docker compose -f stack/grafana.yml up -d

More install options in our documentation, or see grafana/grafana for app-specific guidance.

Grafana Docker image

Run the Grafana Docker container

Start the Docker container by binding Grafana to external port 3000.
docker run -d --name=grafana -p 3000:3000 grafana/grafana

Try it out, default admin user credentials are admin/admin.
Further documentation on how to run Docker can be found at http://docs.grafana.org/installation/docker/.

Changelog

You can find information about Grafana in our docs, or find out what's new in the latest release here!

Serve Grafana on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying grafana.example.com to http://grafana:3000

Add this to your Caddyfile

grafana.example.com {
	reverse_proxy http://grafana:3000
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:3030 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :3030
  • Stop the other service, or pick a different host port. In 3030:3000 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:3030. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, grafana can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 3030

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/grafana/data (and the same for the other mapped folders)

Image won't pull

Test the pull directly on the host: docker pull grafana/grafana:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64, arm/v7
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Grafana is a Compose stack, a set of containers defined in one file and brought up together by Portainer, then started and stopped as a single app.

The app image

An image is the app packed up ready to go, everything Grafana needs bundled into one download. This template pulls grafana/grafana:latest, which Docker fetches once (about 324 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Grafana's comes from Docker Hub, published by grafana.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 13.0-slim. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 3030:3000 means it's reachable on port 3030 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:3030 in a browser. It opens:

  • 3030:3000, likely the web interface

Volumes

A volume is where Grafana keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /var/lib/grafana from /portainer/Files/AppData/Config/grafana/data on the host
  • /etc/grafana/grafana.ini from /portainer/Files/AppData/Config/grafana/grafana.ini on the host
  • /etc/grafana/provisioning from /portainer/Files/AppData/Config/grafana/provisioning on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Grafana takes 7 of them, all with defaults you can leave alone or tweak:

  • GF_USERS_ALLOW_SIGN_UP, defaults to false
  • GF_PATHS_CONFIG, defaults to /etc/grafana/grafana.ini
  • GF_PATHS_DATA, defaults to /var/lib/grafana
  • GF_PATHS_HOME, defaults to /usr/share/grafana
  • GF_PATHS_LOGS, defaults to /var/log/grafana
  • GF_PATHS_PLUGINS, defaults to /var/lib/grafana/plugins
  • GF_PATHS_PROVISIONING, defaults to /etc/grafana/provisioning

Restart policy

The restart policy here is unless-stopped, so Docker restarts Grafana after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Nothing custom is set, so Grafana sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container grafana. That's what you'll spot in the containers list and use in commands like docker logs grafana.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

Grafana is open source, released under the AGPL-3.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Grafana up. Add the template list to Portainer once, then deploying Grafana is a click rather than a wall of config.