{"id":13587410,"url":"https://github.com/flightaware/fa-grafana","last_synced_at":"2025-04-12T16:16:46.984Z","repository":{"id":43424398,"uuid":"252774822","full_name":"flightaware/fa-grafana","owner":"flightaware","description":"Grafana dashboards for PiAware","archived":false,"fork":false,"pushed_at":"2023-06-29T16:51:05.000Z","size":1512,"stargazers_count":40,"open_issues_count":1,"forks_count":4,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-12T16:16:20.371Z","etag":null,"topics":["piaware"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/flightaware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-03T15:44:57.000Z","updated_at":"2025-02-22T06:59:15.000Z","dependencies_parsed_at":"2024-08-01T16:43:33.296Z","dependency_job_id":null,"html_url":"https://github.com/flightaware/fa-grafana","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flightaware%2Ffa-grafana","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flightaware%2Ffa-grafana/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flightaware%2Ffa-grafana/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flightaware%2Ffa-grafana/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flightaware","download_url":"https://codeload.github.com/flightaware/fa-grafana/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248594191,"owners_count":21130316,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["piaware"],"created_at":"2024-08-01T15:06:11.942Z","updated_at":"2025-04-12T16:16:46.963Z","avatar_url":"https://github.com/flightaware.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"# fa-grafana\nSuite of Grafana dashboards for PiAware\n\nThis is a multi-container Docker application that runs Grafana, Prometheus, and the Prometheus exporter containers below to monitor your PiAware's flight tracking and system health\n- [Claws's dump1090-exporter](https://github.com/claws/dump1090-exporter)\n- [piaware_exporter](https://github.com/flightaware/piaware-exporter)\n- [node_exporter](https://github.com/prometheus/node_exporter)\n\n\n### **Minimum System Requirements:**\n- Raspberry Pi 3B+ or Pi 4\n- Raspberry Pi Zero 2 W\n\nThe docker containers used in this application are built for ARMv7 CPU architectures.\n\n![Image of fa-grafana](https://github.com/flightaware/fa-grafana/blob/master/fa-grafana-graphs.png)\n\n![Image of fa-grafana](https://github.com/flightaware/fa-grafana/blob/master/fa-grafana-system-metrics.png)\n\n\n## Setup ##\n\u003cdetails\u003e\n \n \u003csummary\u003eNew Installations\u003c/summary\u003e\n\n\u003cbr /\u003e\nThese steps will install required dependencies, pull all the Docker images from Docker Hub, and start up the containers\n \n#### 1. Install pre-requisite programs:\n\nConvenient script to install git, docker compose, and docker.\n\n```\nsudo bash -c \"$(curl -sS https://raw.githubusercontent.com/flightaware/fa-grafana/master/install.sh)\"\n```\n\n#### 2. Checkout the fa-grafana git repository and cd into the directory\n\n```\ngit clone https://github.com/flightaware/fa-grafana.git\ncd fa-grafana\n```\n\n#### 3. Rename the .env.sample file to .env \n\n```\nmv .env.sample .env\n```\n\n#### 4. Set the HOST_IP to your Pi's local IP address (required) and set other Grafana configuration if desired\n\n```\nnano .env\nHOST_IP=\u003cset IP address\u003e\n```\n\n#### 5. Start up containers\n\n```\nsudo docker compose up -d\n```\n\n#### 6. Open Grafana in a web browser by entering your Pi's local IP address and the configured Grafana port number\n```\n\u003cIP address\u003e:3000\n```\n\n\u003c/details\u003e\n \n \n\u003cdetails\u003e\n \n \u003csummary\u003eUpdating Existing Installations\u003c/summary\u003e\n\n \u003cbr /\u003e\n These steps will stop the running fa-grafana containers, pull the latest images from Docker Hub, clean up volumes, and start up the new containers\n\n#### 1. Stop fa-grafana docker containers\n```\ncd fa-grafana\nsudo docker compose down\n```\n#### 2. Pull latest source code\n```\ngit pull\n```\n#### 3. Make sure the .env file has HOST_IP and other configuration variables set. Rename the provided .env.sample file to .env if needed. \u003cbr /\u003e\n\n#### 4. Delete existing fa-grafana_grafana_data Docker volume\n```\nsudo docker volume rm fa-grafana_grafana_data\n```\n#### 5. Start up containers\n```\nsudo docker compose up -d\n```\n  \n\n\u003c/details\u003e\n\n ## Configuration\n\nYou configure the Grafana interface using the .env file shown below. This is what Grafana will use when you start its container.\n\n```\n# This file contains environment variables referenced in the docker-compose.yml\n\n# Set HOST_IP to your Pi's local IP (no quotes)\nHOST_IP=\n\n######## Grafana Settings - configurable settings #########\n\n# enable/disable login\nDISABLE_LOGIN=false\n\n# default Grafana port\nGRAFANA_PORT=3000\n\n# username and password\nGRAFANA_USERNAME=admin\nGRAFANA_PASSWORD=flightaware\n\n# light or dark mode\nGRAFANA_THEME=dark\n```\n \n \n## Reference ##\n\n\u003c/details\u003e\n \n\u003cdetails\u003e\n \u003csummary\u003eCleaning up unused Docker images to free up disk space\u003c/summary\u003e\n \u003cbr /\u003e\n \n ```\n sudo docker image prune -a\n ```\n\u003c/details\u003e\n \n\n\u003cdetails\u003e\n \n \u003csummary\u003eUseful Docker commands\u003c/summary\u003e\n  \n#### To stop all Docker containers, cd into the fa-grafana directory and use the following command:\n```\nsudo docker compose down\n```\n#### List all running Docker containers\n```\nsudo docker ps\n```\n#### List all Docker images installed\n```\nsudo docker images\n```\n#### Delete a Docker image\n```\nsudo docker rmi \u003cIMAGE_ID\u003e\n```\n \n#### Delete unused and dangling Docker images\n```\nsudo docker image prune -a\n```\n  \n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflightaware%2Ffa-grafana","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflightaware%2Ffa-grafana","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflightaware%2Ffa-grafana/lists"}