Skip to content

Commit d475755

Browse files
committed
Update README
1 parent 4a24761 commit d475755

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

grafana/README.md

+18-11
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,44 @@
1-
# MongoDB Plugin
1+
# Grafana Plugin
22

3-
Plugin for the [`mongodb`](https://www.nixhub.io/packages/mongodb) package. This plugin configures MonogoDB to use a local config file and data directory for this project, and configures a mongodb service.
3+
Plugin for the [`grafana`](https://www.nixhub.io/packages/grafana) package. This plugin configures MonogoDB to use a local config file and data directory for this project, and configures the grafana server as a service.
44

55
## How to Activate
66

7-
To install MongoDB, run `devbox add mongodb@latest`. We also recommend installing the [`mongosh`](https://nixhub.io/packages/mongosh) client with `devbox add mongosh@latest`.
7+
To install Grafana, run `devbox add grafana@latest`.
88

99
To activate this plugin, add the following reference to the `include` section of your `devbox.json` file.
1010

1111
```json
1212

1313
"include": [
14-
"github:jetpack-io/devbox-plugins?dir=mongodb"
14+
"github:jetify-com/devbox-plugins?dir=grafana"
1515
],
1616
```
1717

1818
## Services
1919

20-
* mongodb
20+
* grafana
2121

22-
Use `devbox services up mongodb` to start the mongodb server.
22+
Use `devbox services up grafana` to start the mongodb server.
2323

2424
## Files
2525

2626
This plugin creates the following helper files:
2727

28-
* **devbox.d/mongodb/mongod.conf** - MongoDB configuration file
29-
* **.devbox/virtenv/mongodb/data** - empty directory for holding your mongodb database
30-
* **.devbox/virtenv/mongodb/process-compose.yaml** - Defines the process to start the MongoDB server
28+
* **devbox.d/grafana/conf/defaults.ini** - a default grafana config
29+
* **.devbox/virtenv/grafana/process-compose.yaml** - Defines the process to start the Grafana server
3130

3231
## Environment Variables
3332

3433
This plugin sets the following environment variables:
3534

36-
* **MONGODB_CONFIG** = {{.DevboxDir}}/mongod.conf
37-
* **MONGODB_DATA** = {{.Virtenv}}/data
35+
* **$GRAFANA_DATA_DIR**: ".devbox/virtenv/grafana/lib",
36+
* **$GRAFANA_LOG_DIR**: ".devbox/virtenv/grafana/log",
37+
* **$GRAFANA_PLUGIN_DIR**: "devbox.d/grafana/plugins",
38+
* **$GRAFANA_HOMEPATH**: ".devbox/virtenv/grafana",
39+
* **$GRAFANA_CONFIG_DIR**: "devbox.d/grafana/conf",
40+
* **$GRAFANA_PROVISIONING_DIR**: ".devbox/virtenv/grafana/conf/provisioning"
41+
42+
## Other Details
43+
44+
This plugin will copy the Grafana server's public files to `.devbox/virtenv/grafana/public` when you start your shell

0 commit comments

Comments
 (0)