Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jclaveau/railwayapp-grafana
https://github.com/jclaveau/railwayapp-grafana
Last synced: 2 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/jclaveau/railwayapp-grafana
- Owner: jclaveau
- License: mit
- Created: 2023-09-11T03:26:59.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-08T10:06:31.000Z (11 months ago)
- Last Synced: 2024-12-20T08:03:46.345Z (3 days ago)
- Language: Dockerfile
- Size: 97.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Grafana for railway.app
Deploy Grafana Community Edition on railway with one click.
Grafana is a multi-platform, feature rich metrics dashboard and graph editor for Graphite, InfluxDB & Prometheus. It is most commonly used for visualizing time series data.
[](https://railway.app/template/anURAt?referralCode=2_sIT9)
## ✨ Features
* Grafana with automated setup
* Grafana UI
* Password Authentication (Set username & password in environment variables)
## 🐍 How to Deploy
1. Click Deploy on Railway and setup your credentials in the environment variables
```bash
GF_DEFAULT_INSTANCE_NAME=my-instance
GF_SECURITY_ADMIN_USER=yourusername
GF_SECURITY_ADMIN_PASSWORD=yourpassword
GF_INSTALL_PLUGINS=grafana-piechart-panel,grafana-worldmap-panel,grafana-clock-panel,grafana-simple-json-datasource
GF_LOG_MODE=console
GF_VERSION=latest
PORT=3000
```
2. Wait for Build & Deployment to Finish
3. Open the custom URL an enter your credentials
## 👩💻 How to Use
1. When you configure your Grafana connection, use your custom URL as the host.
2. Use the token in the environment variables to authenticate
3. Setup bucket name and organization name in the environment variables
4. Use grafana version 2.0 or above
## 🪲 Bug Reporting
If you find a bug in the template for railway, you can [submit an issue](https://github.com/vergissberlin/railwayapp-grafana/issues/new) to the GitHub Repository. Even better you can submit a Pull Request with a fix.
## 🐳 Local Development
```bash
docker compose build
docker compose up -d
```
Connect to http://localhost:3000 use setup username & password from docker-compose file to login to grafana.