Plugins 〉Boom Theme
The Boom Theme plugin has been deprecated and is no longer maintained.
Boom Theme
Boom Theme Panel
Theme switcher with custom styles / themes for grafana dashboards.
Features
- Theme switcher
- Multiple themes per dashboard
- Theme builder
- External stylesheets support
- Add inline styles to themes to override styles
- Add many themes as possible without rebuilding / restarting grafana
- Users can change the themes without editing the dashboard
- Dashboard specific themes
Creating Theme
Themes can be created with multiple building blocks like background image, base theme etc.
Property | Description |
---|---|
Base theme | Themes can be built on top of default/dark/light theme. Default is Default Theme |
Background image | Optional property. Can be blank. If specified more than once, last wins. Value should be valid image URL |
CSS url | External theme file. Should be valid CSS file URL |
Custom Style / CSS Override | CSS Styles. Should be valid css |
Panel container BG | Background color for the panels |
Supported Grafana version
This grafana plugin is tested with the following grafana versions, But other versions are also expected to work.
- Grafana version 8.x
- Grafana version 7.x
- Grafana version 6.x
Notes
When adding external stylesheets, make sure CORS enabled for those domains.
To make panel invisible : Modify following theme panel settings:
- transparent = true
- title = ""
- Disable Theme Picker using panel settings
- Move this panel to the bottom of the dashboard
- Adjust the height and width if required.
Known issues / Limitations
If any custom plugin is used, dark/light theme switch, base theme will not work for those custom plugins. Refer this github issue
Theme panel should be within view port. Otherwise, Grafana won't render the theme. Refer this
Installation Instructions
There are multiple ways to install this plugin into your grafana instance
Download and extract zip file
Download the zip file from github releases page and extract into your grafana plugin folder. Then restart Grafana.
Using grafana-cli
If you are using grafana-cli, execute the following command to install the plugin
grafana-cli plugins install yesoreyeram-boomtheme-panel
or for specific versions
grafana-cli --pluginUrl https://github.com/yesoreyeram/yesoreyeram-boomtheme-panel/releases/download/v0.2.1/yesoreyeram-boomtheme-panel-0.2.1.zip plugins install yesoreyeram-boomtheme-panel
Using helm chart
If you use helm chart to provision grafana, use the following config to install the plugin
plugins:
- yesoreyeram-boomtheme-panel
or for any specific versions
plugins:
- https://github.com/yesoreyeram/yesoreyeram-boomtheme-panel/releases/download/v0.2.1/yesoreyeram-boomtheme-panel-0.2.1.zip;yesoreyeram-boomtheme-panel
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
.h4 . .mb-0 }
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Installing Boom Theme on Grafana Cloud:
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
For more information, visit the docs on plugin installation.
Installing on a local Grafana:
For local instances, plugins are installed and updated via a simple CLI command. Plugins are not updated automatically, however you will be notified when updates are available right within your Grafana.
1. Install the Panel
Use the grafana-cli tool to install Boom Theme from the commandline:
grafana-cli plugins install
The plugin will be installed into your grafana plugins directory; the default is /var/lib/grafana/plugins. More information on the cli tool.
Alternatively, you can manually download the .zip file for your architecture below and unpack it into your grafana plugins directory.
Alternatively, you can manually download the .zip file and unpack it into your grafana plugins directory.
2. Add the Panel to a Dashboard
Installed panels are available immediately in the Dashboards section in your Grafana main menu, and can be added like any other core panel in Grafana.
To see a list of installed panels, click the Plugins item in the main menu. Both core panels and installed panels will appear.
CHANGELOG
Version | Changes |
---|---|
0.2.1 | Bug fixes (Thanks @koszti) |
Replace theme by variable (Thanks @koszti) | |
0.2.0 | Plugin Signed |
Tagged releases | |
Bug fixes | |
0.1.0 | First version for release |
0.0.4 | Base theme option |
Bug fixes (#4) | |
0.0.3 | Schema changes (BREAKING) |
Option to switch between default dark,light themes | |
BG Image as theme option | |
Bug fixes | |
0.0.2 | Multiple Themes, Theme picker |
0.0.1 | Base version |