Skip to content

Commit

Permalink
chore: Update docs and test env
Browse files Browse the repository at this point in the history
Signed-off-by: Mahendra Paipuri <mahendra.paipuri@gmail.com>
  • Loading branch information
mahendrapaipuri committed Mar 8, 2024
1 parent 3c5176d commit 1a9bf1c
Show file tree
Hide file tree
Showing 5 changed files with 814 additions and 338 deletions.
4 changes: 2 additions & 2 deletions .config/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@ ENV GF_DEFAULT_APP_MODE "development"
USER root
RUN sed -i 's/<\/body><\/html>/<script src=\"http:\/\/localhost:35729\/livereload.js\"><\/script><\/body><\/html>/g' /usr/share/grafana/public/views/index.html

# Install texlive
RUN apk add texlive
# Install chromium
RUN apk add chromium
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,24 @@
# Grafana Dashboard Reporter App

This Grafana plugin app can create PDF reports of a given dashboard using `pdflatex`
This Grafana plugin app can create PDF reports of a given dashboard using headless `chromium`
and [`grafana-image-renderer`](https://github.com/grafana/grafana-image-renderer).

This plugin is based on the original work
[grafana-reporter](https://github.com/IzakMarais/reporter).
The core of the plugin app uses the same code base as the above stated work with some
improvements and modernization. The current plugin app exposes the reporter as a
custom API end point without needing to run the
[grafana-reporter](https://github.com/IzakMarais/reporter)
as a separate web service. The advantage of the plugin approach is the authenticated access
to the reporter app is guaranteed by Grafana auth.
The core of the plugin is heavily inspired from the above stated work with some
improvements and modernization.

- The current plugin uses HTML templates and headless chromium to generate reports
instead of LaTeX. `grafana-image-renderer` is a prerequisite for both current and
original plugins.

- The current plugin app exposes the reporter as a custom API end point without
needing to run the [grafana-reporter](https://github.com/IzakMarais/reporter)
as a separate web service. The advantage of the plugin approach is the authenticated
access to the reporter app is guaranteed by Grafana auth.

- The plugin can be configured by Admins and users either from
[Configuration Page](./src/img/light.png) or query parameters to the report API.

## Documentation

Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ services:
- GF_AUTH_ANONYMOUS_ENABLED=true
- GF_AUTH_ANONYMOUS_ORG_ROLE=Admin
# skip login page
- GF_AUTH_DISABLE_LOGIN_FORM=true
# - GF_AUTH_DISABLE_LOGIN_FORM=true
# disable alerting because it vomits logs
- GF_ALERTING_ENABLED=false
- GF_UNIFIED_ALERTING_ENABLED=false
Expand Down
Loading

0 comments on commit 1a9bf1c

Please sign in to comment.