Skip to content
This repository was archived by the owner on Aug 4, 2025. It is now read-only.

Commit 354b647

Browse files
committed
update readme for proxy mode
1 parent 166af9c commit 354b647

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Nodegraph API Plugin for Grafana
22

3-
[![Build](https://github.com/grafana/grafana-starter-datasource/workflows/CI/badge.svg)](https://github.com/grafana/grafana-starter-datasource/actions?query=workflow%3A%22CI%22)
3+
[![License](https://img.shields.io/github/license/hoptical/nodegraph-api-plugin)](LICENSE)
4+
[![CI](https://github.com/hoptical/nodegraph-api-plugin/actions/workflows/ci.yml/badge.svg)](https://github.com/hoptical/nodegraph-api-plugin/actions/workflows/ci.yml)
5+
[![Release](https://github.com/hoptical/nodegraph-api-plugin/actions/workflows/release.yml/badge.svg)](https://github.com/hoptical/nodegraph-api-plugin/actions/workflows/release.yml)
46

57
This plugin provides a data source to connect a REST API to [nodegraph](https://grafana.com/docs/grafana/latest/visualizations/node-graph/) panel of Grafana. It is [signed and published by Grafana](https://grafana.com/grafana/plugins/hamedkarbasi93-nodegraphapi-datasource/).
68

@@ -29,17 +31,17 @@ Alternatively, you can manually download the [latest](https://github.com/hoptica
2931

3032
You can now add the data source. Just enter the URL of your API app and push "Save & Test." You will get an error in case of connection failure.
3133

32-
> Important note: The browser should have access to the application, not the Grafana server.
33-
3434
![Add Datasource](https://raw.githubusercontent.com/hoptical/nodegraph-api-plugin/f447b74ecefd827b388e791a34792730e9a9a11d/src/img/add-datasource.png)
3535

3636
In the Grafana dashboard, pick the Nodegraph panel and visualize the graph.
3737

38-
## API Configuration
38+
> Note on Application Access:
39+
> - Versions 0.x.x work in *direct* mode. i.e., The browser must have access to the API application.
40+
> - Versions 1.x.x+ work in *proxy* mode. i.e., The Grafana server should have access to the API application.
3941
40-
The REST API application should return data in the following format:
42+
## API Configuration
4143

42-
> Note: Your API application should handle CORS policy. Otherwise, you will face a CORS-Policy error in Grafana.
44+
The REST API application should handle three requests: *fields*, *data*, and *health*. They are described below.
4345

4446
### Fetch Graph Fields
4547

@@ -174,7 +176,6 @@ In the `example` folder, you can find a simple API application in Python Flask.
174176
### Requirements:
175177

176178
- flask
177-
- flask-cors
178179

179180
### Run
180181

0 commit comments

Comments
 (0)