About MiningOS

The mining industry has long been limited by closed systems and proprietary tools. MiningOS changes that by introducing transparency, openness, and collaboration into Bitcoin infrastructure.

No black boxes. No lock-in. No limits.

Open protocols, modular design, and a global community of builders set the new standard for mining operations.

Set up your Bitcoin mining operation with state-of-the-art software that provides an intuitive user experience and professional monitoring and control capabilities at all scales—from a single device to gigawatt facilities.

---

1. What is MiningOS?

MiningOS is an open-source application for Bitcoin mining operations. Built in JavaScript, MiningOS provides a modular, scalable framework for monitoring and controlling mining infrastructure.

Main Characteristics

Feature	Description	Learn More
Portability	Runs on Windows, macOS, and Linux	Installation Guide
Modular Architecture	Worker-based components that can be deployed independently	Architecture
Device Agnostic	Supports miners, containers, sensors, power meters, and more from various brands	Supported Devices
Real-time Monitoring	Sub-minute data collection and alerting	Dashboard, Alerts Manual
Distributed Architecture	P2P networking via Hyperswarm for resilient communication	Architecture
Persistent Storage	Time-series data storage using Hyperbee for analytics and history	Architecture
Scalable	Handles everything from a single miner to thousands of devices	Rack System

Core Philosophy

MiningOS establishes a common foundation for mining software—a robust, lean operating system on which the entire industry can build. Its core is intentionally lightweight, allowing infinite expansion while maintaining reliability and security.

For details on the technical implementation, see the Architecture Guide.

---

2. Vision

MiningOS is the backbone of an open, modular future. By using MiningOS, you help build the foundation of mining infrastructure for the next century and deliver on Bitcoin's promise of truly decentralized money. With MiningOS, participating in this network is accessible to all.

---

3. Why use MiningOS?

The Problem

The mining software ecosystem is fragmented, outdated, and lags behind other industrial sectors in:

• Integration: Proprietary systems that don't communicate.

• Reliability: Closed-source solutions with limited support.

• Openness: Vendor lock-in and limited customization.

The Solution

MiningOS addresses these challenges by providing:

1. Transparency

• Fully open-source under Apache 2.0 license (see Licensing)

• Complete visibility into how your mining operation is managed

• No vendor lock-in or hidden functionality

2. Comprehensiveness

• Single platform for all mining infrastructure

• Supports multiple device types and brands (see Supported Devices)

• Unified monitoring and control interface (see Dashboard, Explorer)

3. Robustness

• Battle-tested in Tether's real-world mining operations

• Distributed architecture with no single point of failure (see Architecture)

• Persistent storage with automatic replication

4. Extensibility

• Modular design allows adding new device support (see Adding New Worker)

• Plugin architecture for custom integrations

• Community-driven development (see Contribution Workflow)

Industry standard

MiningOS aims to become the industry standard for Bitcoin mining operations.

---

4. Who is MiningOS For?

MiningOS serves everyone who mines Bitcoin:

User type	Use case
Home miners	Monitor and manage a few machines with a clean interface.
Small operations	Coordinate multiple miners across different locations.
Industrial sites	Manage thousands of ASICs with sophisticated orchestration.
Developers	Build custom tools and integrations on a solid foundation.
Service providers	Offer hosted mining management solutions.

What You Can Build

• Basic monitoring: Track hashrate, temperature, and power consumption.

• Pool management: Configure and monitor mining pool connections.

• Infrastructure control: Manage containers, cooling systems, and power distribution.

• Analytics dashboards: Build custom reporting and visualization tools.

• Automated operations: Implement alerts, auto-scaling, and optimization rules.

---

5. Next Steps

Ready to start using MiningOS?

For Developers

1. Read the Architecture Guide to understand the system design.

2. Follow the Installation Guide to set up a complete development environment.

3. Read the contribution guide to learn about the Mining OS repository and contribution workflow.

4. Explore the codebase on the MiningOS GitHub repository.

5. Join the community on Discord.

6. Look for #GoodFirstIssue tags on GitHub.

For Mining Operators

1. Evaluate your needs to identify which workers you require.

2. Follow the Installation Guide to set up the core infrastructure.

3. Configure your devices by registering your miners, containers, and sensors.

4. Use the dashboard to monitor and optimize your operation.

Resources

Resource	Link
Architecture Guide	Architecture
Installation Guide	Installation
Contributing Guide	Contribution
Holepunch documentation	Holepunch Docs
GitHub organization	Tether GitHub

---

6. Get Support

Need help getting started or have questions?

• GitHub Issues: Report bugs or request features.

• Discord: Join our community for real-time support.

• Documentation: Check the docs for detailed guides.

---

MiningOS is developed by Tether and released under the Apache 2.0 license.