Files
grafana/docs/sources/shared/tutorials/set-up-environment.md
Jack Baldry 4563111180 Move Grafana tutorials from grafana/tutorials repository (#62309)
* Add Grafana tutorials originally from tutorials repository

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Replace tutorials/step shortcode with ordinary headings

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix typos reported by codespell

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix doc-validator linting and run prettier

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Specify version in tutorials lookup as non-rendered pages do not have a relative permalink used to infer the version

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Use latest version

Ensures CI passes and only breaks one website build as the backport to
v9.3.x will solve the missing "latest" pages on publishing.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-01-27 17:53:50 +00:00

35 lines
1.2 KiB
Markdown

---
title: Set up Environment
---
Before you can get started building plugins, you need to set up your environment for plugin development.
To discover plugins, Grafana scans a _plugin directory_, the location of which depends on your operating system.
1. Create a directory called `grafana-plugins` in your preferred workspace.
1. Find the `plugins` property in the Grafana configuration file and set the `plugins` property to the path of your `grafana-plugins` directory. Refer to the [Grafana configuration documentation](/docs/grafana/latest/installation/configuration/#plugins) for more information.
```ini
[paths]
plugins = "/path/to/grafana-plugins"
```
1. Restart Grafana if it's already running, to load the new configuration.
### Alternative method: Docker
If you don't want to install Grafana on your local machine, you can use [Docker](https://www.docker.com).
To set up Grafana for plugin development using Docker, run the following command:
```
docker run -d -p 3000:3000 -v "$(pwd)"/grafana-plugins:/var/lib/grafana/plugins --name=grafana grafana/grafana:7.0.0
```
Since Grafana only loads plugins on start-up, you need to restart the container whenever you add or remove a plugin.
```
docker restart grafana
```