Skip to content

Commit

Permalink
Added a section on proxying to the contributor docs (#40)
Browse files Browse the repository at this point in the history
* Added a section on proxying to the contibutor docs

* Changed wording
  • Loading branch information
kyle-sammons authored Dec 1, 2023
1 parent ef88d09 commit 68411b6
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ There are more details about processes and workflow in the [Maintainer's Guide](

### Frontend

#### Starting the frontend

1. Install dependencies

```bash
Expand All @@ -89,6 +91,19 @@ There are more details about processes and workflow in the [Maintainer's Guide](
yarn build
```

#### Proxying
Depending on your setup, it may be advantageous for you to setup a proxy from your
local machine to a KalDB query node running in a cloud environment. Below is
an example command to do that (NOTE: this may or may not work depending on
your setup):
```
ssh -N -L $LOCALHOST_PORT:localhost:$REMOTE_PORT $NODE_NAME
```

You would then be able to use `host.docker.internal:$LOCALHOST_PORT` as the
KalDB datasource URL inside your Grafana instance.


### Backend

1. Update [Grafana plugin SDK for Go](https://grafana.com/docs/grafana/latest/developers/plugins/backend/grafana-plugin-sdk-for-go/) dependency to the latest minor version:
Expand Down

0 comments on commit 68411b6

Please sign in to comment.