Skip to content

feat(grafana): optional .grafana.env via GRAFANA_ENV_FILE, overridable GF_GITHUB_PLUGINS #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
i-love-to-code wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat(grafana): optional .grafana.env via GRAFANA_ENV_FILE, overridable GF_GITHUB_PLUGINS #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7758158
feat(grafana): optional .grafana.env via GRAFANA_ENV_FILE, overridabl…
i-love-to-code Feb 14, 2026
b36bea8
Fix quoting in GF_GITHUB_PLUGINS default value
i-love-to-code Feb 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .env.tmp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,9 @@ DISCORD_WEBHOOK_URL=

# Slack Integration
SLACK_WEBHOOK_URL=

# Optional Extensions to Grafana
# Comma separated list of URLs to GitHub plugins to install. See grafana/entrypoint.sh for details
# GF_GITHUB_PLUGINS=
# Extended Grafana configuration file
# GRAFANA_ENV_FILE=.grafana.env
4 changes: 3 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
.env
.env
.grafana.env
.DS_Store
4 changes: 4 additions & 0 deletions .grafana.env.tmp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Set custom parameters for Grafana
# https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/#override-configuration-with-environment-variables
# GF_SERVER_ROOT_URL=
# GF_SERVER_SERVE_FROM_SUB_PATH=
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,29 @@ DISCORD_WEBHOOK_URL=<your-discord-webhook-url>

# Slack Integration
SLACK_WEBHOOK_URL=<your-slack-webhook-url>

# Optional Extensions to Grafana
# Comma separated list of URLs to GitHub plugins to install. See [grafana/entrypoint.sh](./grafana/entrypoint.sh) for details
# GF_GITHUB_PLUGINS=
# Extended Grafana configuration file
# GRAFANA_ENV_FILE=.grafana.env
```

> **Note:** If your targets (`WALRUS_NODE_TARGET`, `WALRUS_AGGREGATOR_TARGET`, `WALRUS_PUBLISHER_TARGET`) are HTTPS endpoints, make sure to include the `https://` protocol explicitly in the variable, e.g., `WALRUS_NODE_TARGET=https://node.example.com`.

---

#### (Optional) Grafana Customisation

```bash
cp .grafana.env.tmp .grafana.env
```

In your `.env` file, set `GRAFANA_ENV_FILE=.grafana.env` so that Compose loads it. Then edit the `.grafana.env` file to configure additional Grafana settings.

Refer to the [Grafana configuration documentation](https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/#override-configuration-with-environment-variables) for details.


### **4. Start the Services**

```bash
Expand Down
4 changes: 3 additions & 1 deletion docker-compose.macos.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,15 @@ services:
GF_SECURITY_ADMIN_USER: ${GF_SECURITY_ADMIN_USER}
GF_SECURITY_ADMIN_PASSWORD: ${GF_SECURITY_ADMIN_PASSWORD}
GF_SERVER_HTTP_PORT: ${GF_PORT:-3000}
GF_GITHUB_PLUGINS: "https://github.com/grafana/grafana-infinity-datasource/releases/download/v2.11.4/yesoreyeram-infinity-datasource-2.11.4.zip"
GF_GITHUB_PLUGINS: ${GF_GITHUB_PLUGINS:-https://github.com/grafana/grafana-infinity-datasource/releases/download/v2.11.4/yesoreyeram-infinity-datasource-2.11.4.zip}
PROMETHEUS_URL: "http://${PROMETHEUS_TARGET:-localhost:9090}"
ALERTMANAGER_URL: "http://${ALERTMANAGER_TARGET:-localhost:9093}"
WALRUS_NODE_TARGET: ${WALRUS_NODE_TARGET:-}
WALRUS_AGGREGATOR_TARGET: ${WALRUS_AGGREGATOR_TARGET:-}
WALRUS_PUBLISHER_TARGET: ${WALRUS_PUBLISHER_TARGET:-}
WALRUS_NODE_URL: ${WALRUS_NODE_URL}
env_file:
- ${GRAFANA_ENV_FILE:-/dev/null}
volumes:
- ./grafana/dashboards:/tmp/dashboards
- ./grafana/provisioning:/etc/grafana/provisioning
Expand Down
4 changes: 3 additions & 1 deletion docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,15 @@ services:
GF_SECURITY_ADMIN_USER: ${GF_SECURITY_ADMIN_USER}
GF_SECURITY_ADMIN_PASSWORD: ${GF_SECURITY_ADMIN_PASSWORD}
GF_SERVER_HTTP_PORT: ${GF_PORT:-3000}
GF_GITHUB_PLUGINS: "https://github.com/grafana/grafana-infinity-datasource/releases/download/v2.11.4/yesoreyeram-infinity-datasource-2.11.4.zip"
GF_GITHUB_PLUGINS: ${GF_GITHUB_PLUGINS:-https://github.com/grafana/grafana-infinity-datasource/releases/download/v2.11.4/yesoreyeram-infinity-datasource-2.11.4.zip}
PROMETHEUS_URL: "http://${PROMETHEUS_TARGET:-localhost:9090}"
ALERTMANAGER_URL: "http://${ALERTMANAGER_TARGET:-localhost:9093}"
WALRUS_NODE_TARGET: ${WALRUS_NODE_TARGET:-}
WALRUS_AGGREGATOR_TARGET: ${WALRUS_AGGREGATOR_TARGET:-}
WALRUS_PUBLISHER_TARGET: ${WALRUS_PUBLISHER_TARGET:-}
WALRUS_NODE_URL: ${WALRUS_NODE_URL}
env_file:
- ${GRAFANA_ENV_FILE:-/dev/null}
volumes:
- ./grafana/dashboards:/tmp/dashboards
- ./grafana/provisioning:/etc/grafana/provisioning
Expand Down