farm-monitor

# Braiins Farm Monitor

Comprehensive skill for Braiins Farm Monitor - free monitoring solution for Bitcoin mining operations using Prometheus and Grafana.

## Description

Braiins Farm Monitor is a free, open-source monitoring solution for Bitcoin mining farms. It encompasses three primary components:
- **Metrics Exporter** - Collects metrics from miners
- **Prometheus** - Time-series database for metrics storage
- **Grafana** - Visualization and dashboarding

**Repository:** [braiins/farm-monitor](https://github.com/braiins/farm-monitor)
**Official Documentation:** [Braiins Academy](https://academy.braiins.com/en/farm-monitor/about)
**Languages:** CSS, Shell
**Stars:** 17
**License:** None

## When to Use This Skill

Use this skill when you need to:
- Set up Braiins Farm Monitor for mining fleet monitoring
- Configure device discovery and IP address ranges
- Understand Prometheus and Grafana integration
- Troubleshoot Farm Monitor installation issues
- Review recent releases and known issues
- Learn Farm Monitor best practices

## Quick Reference

### Quick Start
```bash
# 1. Clone the repository
git clone https://github.com/braiins/farm-monitor.git
cd farm-monitor

# 2. Configure IP ranges in metrics_exporter.toml
# Edit: ./monitoring/metrics_exporter/metrics_exporter.toml

# 3. Run with Docker Compose
docker compose up -d

# 4. Open Grafana
# http://localhost:3000
```

### System Requirements
- **Platforms**: Linux (AMD 64bit, ARM 64bit, ARMv7)
- **Prerequisites**: Docker, Docker Compose, Git

### Configuration Example
```toml
[scraping]
stock_fw_scrape_interval = "1m"

[ranges]
Building_A = ["1.2.0.*","1.2.*.2"]
Building_B = ["1.3.0.*","1.3.*.2"]
```

### Repository Info
- **Stars:** 17 | **Open Issues:** 6
- **Latest Release:** v1.2.6 (2024-12-09)

## Available References

- `references/README.md` - Complete setup guide and configuration
- `references/releases.md` - 6 documented releases with changelogs
- `references/issues.md` - Recent GitHub issues and discussions
- `references/file_structure.md` - Repository structure
- `references/getting_started.md` - Installation and quick start

## Notes

- **GitHub Source**: Documentation extracted from repository README
- **Academy Limitation**: Braiins Academy uses JavaScript rendering (SPA), preventing automated content extraction
  - Manual addition of Academy docs recommended for comprehensive coverage
- **Active Development**: 6 releases in 2024, actively maintained

## Updating

To refresh this skill:
1. Re-scrape GitHub repository: `skill-seekers github --repo braiins/farm-monitor`
2. Manually add Academy documentation pages
3. Consider using browser automation for Academy content extraction

---

**Generated by Skill Seeker** | GitHub Repository Scraper
**Last Updated:** 2025-12-28