Skip to content

Commit

Permalink
Complete src/README.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
fmassot committed Jul 14, 2023
1 parent 6f92ca2 commit f880d95
Showing 1 changed file with 36 additions and 2 deletions.
38 changes: 36 additions & 2 deletions src/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,39 @@
<!-- This README file is going to be the one displayed on the Grafana.com website for your plugin -->

# Datasource Http Backend
# Quickwit data source for Grafana

The Quickwit data source plugin allows you to query and visualize logs, traces, and indexed data in Quickwit within Grafana.

## Requirements
You need a Quickwit standalone server or cluster.

## Configuration
1. Add a new data source in Grafana
2. Select the Quickwit data source plugin
3. Enter your Quickwit server URL
4. Enter your index ID and related information.
5. Save and test the datasource.

## Features
The Quickwit data source plugin works with dashboards and explore views.
Alerts are also available.

## Installation

### Installation on Grafana Cloud

For more information, visit the docs on [plugin installation](https://grafana.com/docs/grafana/latest/plugins/installation/).

### Installation with Grafana CLI

```
grafana-cli plugins install quickwit-quickwit-datasource
```

### Installation with Docker

1. Add the plugin to your `docker-compose.yml` or `Dockerfile`
2. Set the environment variable `GF_INSTALL_PLUGINS` to include the plugin

```
GF_INSTALL_PLUGINS="quickwit-quickwit-datasource"
```

0 comments on commit f880d95

Please sign in to comment.