Skip to content

Commit

Permalink
Update README based on documentation (#86)
Browse files Browse the repository at this point in the history
* Update README based on documentation

* Update README.md
  • Loading branch information
mikhail-vl authored Sep 9, 2023
1 parent e1b2fae commit 808eb98
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 25 deletions.
47 changes: 24 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,55 +10,56 @@

## Introduction

The Base64 Image/Video/Audio/PDF visualization panel is a plugin for Grafana that displays Base64 encoded files in PNG, JPG, GIF, MP4, WEBM, MP3, OGG, and PDF formats.
Base64 Image/Video/Audio/PDF Panel is a Grafana plugin that renders PNG, JPG, GIF, MP4, WEBM, MP3, OGG, and PDF files encoded in the Base64 format.

[![Images, PDFs, Video, Live Camera Feed on Grafana Dashboard! You will need Base64 Image/PDF Plugin](https://raw.githubusercontent.com/volkovlabs/volkovlabs-image-panel/main/img/video.png)](https://youtu.be/1_bgLSehjhg)

### Requirements
## Requirements

- **Grafana 9** and **Grafana 10** are required for major version 4.
- **Grafana 8.5** and **Grafana 9** are required for major version 3.
- **Grafana 8** is required for major version 2.
- **Grafana 7.1** is required for major version 1.
The Base64 Image/Video/Audio/PDF Panel version requirements for Grafana are as follows:

- Version 4.X requires **Grafana 9** or **Grafana 10**.
- Version 3.X requires **Grafana 8.5** or **Grafana 9**.
- Version 2.X requires **Grafana 8**.
- Version 1.X requires **Grafana 7.1**.

## Getting Started

Base64 Image/Video/Audio/PDF visualization panel can be installed from the [Grafana Catalog](https://grafana.com/grafana/plugins/volkovlabs-image-panel/) or utilizing the Grafana command line tool.
You can install Base64 Image/Video/Audio/PDF Panel from the [Grafana Plugins catalog](https://grafana.com/grafana/plugins/volkovlabs-image-panel/) or using the Grafana command line tool.

For the latter, use the following command.
For the latter, please use the following command.

```bash
grafana-cli plugins install volkovlabs-image-panel
```

## Highlights

- The returned value can contain base64 with or without definition (`data:image/jpg;base64,ENCODED-CONTENT` or `data:application/pdf;base64,ENCODED-CONTENT`).
- The file type is determined automatically based on the first Base64 symbol if the definition is not provided.
- If the data source returns more than one field with a type `string`, you can select the **Field Name** in the panel's display options.
- If the data source returns multiple rows, the panel will display the image from the last row.
- Image height and width can be auto-adjusted to the panel's size, kept original or customized base on the field's value.
- Allows adding URL with title to navigate to other dashboards when clicking on the image. URL supports dashboard variables.
- Support MP4, WEBM video files with definition (`data:video/mp4;base64,ENCODED-CONTENT` and `data:video/webm;base64,ENCODED-CONTENT`)
- Support MP3, OGG audio files with definition (`data:audio/mp3;base64,ENCODED-CONTENT` and `data:audio/ogg;base64,ENCODED-CONTENT`)
- Provides a toolbar to download, zoom and navigate between multiple images.
- The returned value can include base64 encoded content with or without a specified definition. The formats for the definition can look like `data:image/jpg;base64,ENCODED-CONTENT` or `data:application/pdf;base64,ENCODED-CONTENT`.
- The file type is automatically determined based on the first Base64 symbol if no definition is provided.
- If the data source returns more than one field of the `string` type, you can select the Field Name in the panel's display options.
- You can fit image dimensions to the panel size, keep the original values, or adjust dimensions based on the manually supplied values.
- Allows adding a URL with a title to navigate to other dashboards when clicking the image. URL supports dashboard variables.
- Support for MP4 and WEBM video files with the definitions (`data:video/mp4;base64,ENCODED-CONTENT` and `data:video/webm;base64,ENCODED-CONTENT`)
- Support for MP3 and OGG audio files with the efinitions (`data:audio/mp3;base64,ENCODED-CONTENT` and `data:audio/ogg;base64,ENCODED-CONTENT`)
- Provides a toolbar to download, zoom, and navigate between multiple images.

## Documentation

| Section | Description |
| ---------------------------- | ------------------------------------------------------------------- |
| [Supported formats](https://volkovlabs.io/plugins/volkovlabs-image-panel/formats/) | Explains what formats are supported and how to display media files. |
| [Features](https://volkovlabs.io/plugins/volkovlabs-image-panel/features/) | Demonstrates panel features. |
| [Features](https://volkovlabs.io/plugins/volkovlabs-image-panel/features/) | Demonstrates panel capabilities. |
| [Release Notes](https://volkovlabs.io/plugins/volkovlabs-image-panel/release/) | Stay up to date with the latest features and updates. |

## Feedback

We love to hear from you. There are various ways to get in touch with us.
We're looking forward to hearing from you. You can use different ways to get in touch with us.

- Ask a question, request a new feature, and file a bug with [GitHub issues](https://github.com/volkovlabs/volkovlabs-image-panel/issues/new/choose).
- Subscribe to our [YouTube Channel](https://www.youtube.com/@volkovlabs) and add a comment.
- Sponsor our open-source plugins for Grafana with [GitHub Sponsor](https://github.com/sponsors/VolkovLabs).
- Star the repository to show your support.
- Ask a question, request a new feature, or report an issue at [GitHub issues](https://github.com/volkovlabs/volkovlabs-image-panel/issues/new/choose).
- Subscribe to our [YouTube Channel](https://www.youtube.com/@volkovlabs) and leave your comments.
- Sponsor our open-source plugins for Grafana at [GitHub Sponsor](https://github.com/sponsors/VolkovLabs).
- Support our project by starring the repository.

## License

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 808eb98

Please sign in to comment.