|
1 |
| -# MongoDB Plugin |
| 1 | +# Grafana Plugin |
2 | 2 |
|
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. |
4 | 4 |
|
5 | 5 | ## How to Activate
|
6 | 6 |
|
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`. |
8 | 8 |
|
9 | 9 | To activate this plugin, add the following reference to the `include` section of your `devbox.json` file.
|
10 | 10 |
|
11 | 11 | ```json
|
12 | 12 |
|
13 | 13 | "include": [
|
14 |
| - "github:jetpack-io/devbox-plugins?dir=mongodb" |
| 14 | + "github:jetify-com/devbox-plugins?dir=grafana" |
15 | 15 | ],
|
16 | 16 | ```
|
17 | 17 |
|
18 | 18 | ## Services
|
19 | 19 |
|
20 |
| -* mongodb |
| 20 | +* grafana |
21 | 21 |
|
22 |
| -Use `devbox services up mongodb` to start the mongodb server. |
| 22 | +Use `devbox services up grafana` to start the mongodb server. |
23 | 23 |
|
24 | 24 | ## Files
|
25 | 25 |
|
26 | 26 | This plugin creates the following helper files:
|
27 | 27 |
|
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 |
31 | 30 |
|
32 | 31 | ## Environment Variables
|
33 | 32 |
|
34 | 33 | This plugin sets the following environment variables:
|
35 | 34 |
|
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