Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Open-source, cross-platform miner management software for ASIC and mobile miners**

Built by [OverBuild Labs](https://proofofprints.com) | [Support: support@overbuildlabs.com](mailto:support@overbuildlabs.com)
Built by [OverBuild Labs](https://overbuildlabs.com) | [Support: support@overbuildlabs.com](mailto:support@overbuildlabs.com)

## Overview

Expand Down Expand Up @@ -107,7 +107,7 @@ OverManager includes an embedded HTTP server that receives push-based telemetry
- Historical farm data with auto-pruning (7-day retention)
- Troubleshooting logs with configurable log levels

### Cloud Sync *(PoPCloud — $5/month)*
### Cloud Sync *(OverCloud — $5/month)*
- **Remote monitoring** — view your farm from anywhere via the web portal or companion app
- **Push notifications** — get alerts on your phone when miners go offline, overheat, or stop submitting shares
- **Remote commands** — start, stop, restart miners and push pool configurations from your phone or browser
Expand All @@ -134,11 +134,11 @@ See [docs/CLOUD_SYNC.md](docs/CLOUD_SYNC.md) for setup guide and [docs/CLOUD_TRO
- Reports telemetry every 30 seconds: hashrate, CPU temp, battery, throttle state, pool stats
- Works offline — queued commands are delivered on reconnect

The app is currently in development. Follow the [GitHub repo](https://github.com/proofofprints/PoPManager) for release announcements.
The app is currently in development. Follow the [GitHub repo](https://github.com/overbuildlabs/OverManager) for release announcements.

## Installation

Download the latest installer for your platform from [Releases](https://github.com/proofofprints/PoPManager/releases):
Download the latest installer for your platform from [Releases](https://github.com/overbuildlabs/OverManager/releases):

| Platform | Format | Notes |
|---|---|---|
Expand All @@ -147,7 +147,7 @@ Download the latest installer for your platform from [Releases](https://github.c
| **macOS** (Intel) | `.dmg` (x64) | Community-tested. |
| **Linux** (x64) | `.deb` or `.AppImage` | Community-tested. Requires `webkit2gtk 4.1` and related system libraries. |

> **Note:** Windows is the primary development and testing platform. macOS and Linux builds are provided and should work, but have not been as extensively tested. Please [open an issue](https://github.com/proofofprints/PoPManager/issues) if you encounter platform-specific problems.
> **Note:** Windows is the primary development and testing platform. macOS and Linux builds are provided and should work, but have not been as extensively tested. Please [open an issue](https://github.com/overbuildlabs/OverManager/issues) if you encounter platform-specific problems.

### Building from Source

Expand All @@ -157,8 +157,8 @@ Prerequisites:
- [Visual Studio Build Tools](https://visualstudio.microsoft.com/downloads/) (Windows, with C++ workload)

```bash
git clone https://github.com/proofofprints/PoPManager.git
cd PoPManager
git clone https://github.com/overbuildlabs/OverManager.git
cd OverManager
npm install
npm run tauri dev
```
Expand Down Expand Up @@ -205,7 +205,7 @@ See [docs/SUPPORTED_MINERS.md](docs/SUPPORTED_MINERS.md) for the full list of su

All configuration is stored locally on your machine. On Windows, data is split across two locations:

**App data (`%LOCALAPPDATA%\PoPManager\`)** — most operational state:
**App data (`%LOCALAPPDATA%\OverManager\`)** — most operational state:
- `miners.json` — saved ASIC miners
- `mobile_miners.json` — registered mobile miners
- `mobile_miner_commands.json` — pending remote commands
Expand Down Expand Up @@ -238,6 +238,6 @@ Contributions welcome! If you have a miner model not currently supported, please

## Contact

- **Website:** [proofofprints.com](https://proofofprints.com)
- **Website:** [overbuildlabs.com](https://overbuildlabs.com)
- **Email:** [support@overbuildlabs.com](mailto:support@overbuildlabs.com)
- **GitHub:** [github.com/proofofprints/PoPManager](https://github.com/proofofprints/PoPManager)
- **GitHub:** [github.com/overbuildlabs/OverManager](https://github.com/overbuildlabs/OverManager)
4 changes: 2 additions & 2 deletions docs/ADD_NEW_COIN.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Adding a New Coin to PoPManager
# Adding a New Coin to OverManager

Fill out this template and give it to Claude (or a developer) to implement support for a new cryptocurrency in PoPManager.
Fill out this template and give it to Claude (or a developer) to implement support for a new cryptocurrency in OverManager.

---

Expand Down
12 changes: 6 additions & 6 deletions docs/CLOUD_ARCHITECTURE.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Cloud Sync — Technical Architecture

Internal reference for developers working on PoPManager's cloud integration. For user-facing docs see [CLOUD_SYNC.md](./CLOUD_SYNC.md).
Internal reference for developers working on OverManager's cloud integration. For user-facing docs see [CLOUD_SYNC.md](./CLOUD_SYNC.md).

## Overview

PoPManager Cloud Sync is an opt-in feature that connects the desktop app to PoPCloud (cloud.proofofprints.com). Data flows outbound from the desktop to the cloud via REST pushes and a persistent WebSocket for receiving remote commands.
OverManager Cloud Sync is an opt-in feature that connects the desktop app to OverCloud (cloud.overbuildlabs.com). Data flows outbound from the desktop to the cloud via REST pushes and a persistent WebSocket for receiving remote commands.

```
PoPManager Desktop PoPCloud API
OverManager Desktop OverCloud API
┌──────────────────┐ ┌──────────────────┐
│ │ POST /ingest/* │ │
│ sync.rs ────────│───────────────────>│ Fastify + │
Expand Down Expand Up @@ -117,7 +117,7 @@ CREATE TABLE cloud_sync_queue (
);
```

Stored in `%LOCALAPPDATA%/PoPManager/cloud_queue.db` (SQLite with WAL mode).
Stored in `%LOCALAPPDATA%/OverManager/cloud_queue.db` (SQLite with WAL mode).

### Retry policy

Expand Down Expand Up @@ -175,7 +175,7 @@ Commands arrive via WebSocket as:
}}
```

`command_exec.rs` maps this to existing PoPManager functions:
`command_exec.rs` maps this to existing OverManager functions:

| targetType | commandType | Calls |
|---|---|---|
Expand Down Expand Up @@ -223,7 +223,7 @@ Positioned between Preferences and Email Configuration sections.
- Email input
- Password input
- "Sign In" button
- "Don't have an account? Sign up at cloud.proofofprints.com" link
- "Don't have an account? Sign up at cloud.overbuildlabs.com" link

**Signed in state:**
- Status indicator: green dot "Connected" / yellow "Syncing" / red "Disconnected"
Expand Down
50 changes: 25 additions & 25 deletions docs/CLOUD_SYNC.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# PoPManager Cloud Sync
# OverManager Cloud Sync

Connect your PoPManager desktop app to PoPCloud for remote monitoring, push notifications, and remote miner control from anywhere.
Connect your OverManager desktop app to OverCloud for remote monitoring, push notifications, and remote miner control from anywhere.

## What Cloud Sync Does

Expand All @@ -12,16 +12,16 @@ Connect your PoPManager desktop app to PoPCloud for remote monitoring, push noti
| Push notifications to phone | No | Yes |
| Remote monitoring from anywhere | No | Yes |
| Remote start/stop/config from phone | No | Yes |
| Multiple PoPManager installations | N/A | Yes |
| Web portal (cloud.proofofprints.com) | No | Yes |
| Multiple OverManager installations | N/A | Yes |
| Web portal (cloud.overbuildlabs.com) | No | Yes |
| Companion app (iOS + Android) | No | Yes |
| Ad-free desktop | Ads after 5 devices | Yes |

## Getting Started

### 1. Create a PoPCloud account
### 1. Create a OverCloud account

Visit [cloud.proofofprints.com](https://cloud.proofofprints.com) and create an account. You'll need:
Visit [cloud.overbuildlabs.com](https://cloud.overbuildlabs.com) and create an account. You'll need:
- Email address
- Password (minimum 8 characters)

Expand All @@ -31,15 +31,15 @@ Account creation is free. You can explore the web portal before subscribing.

From the web portal, go to **Account → Subscription** and choose the Cloud Basic plan ($5/month). Payment is handled securely via Stripe.

### 3. Connect PoPManager
### 3. Connect OverManager

In PoPManager desktop:
In OverManager desktop:

1. Open **Settings**
2. Find the **Cloud Sync** section (near the top, below Preferences)
3. Enter your email and password
4. Click **Sign In**
5. PoPManager will create an "instance" for this installation and begin syncing
5. OverManager will create an "instance" for this installation and begin syncing

You should see:
- **Status:** Connected (green dot)
Expand All @@ -48,7 +48,7 @@ You should see:

### 4. Verify data is flowing

After signing in, wait 60 seconds, then open [cloud.proofofprints.com](https://cloud.proofofprints.com) in your browser. You should see:
After signing in, wait 60 seconds, then open [cloud.overbuildlabs.com](https://cloud.overbuildlabs.com) in your browser. You should see:
- Your farm's current hashrate
- Online/offline miner counts
- The miners you have configured locally
Expand All @@ -57,29 +57,29 @@ After signing in, wait 60 seconds, then open [cloud.proofofprints.com](https://c

### Data flow

PoPManager pushes three types of data to the cloud:
OverManager pushes three types of data to the cloud:

1. **Farm snapshots** (every 60 seconds) — total hashrate, online count, per-coin earnings
2. **Miner states** (on change) — individual miner status, hashrate, temperature, pool info
3. **Alert events** (when they fire) — offline alerts, temperature warnings, share alerts

All data flows **outbound** from your desktop to the cloud. PoPManager never exposes any ports to the internet — it's always your app initiating the connection.
All data flows **outbound** from your desktop to the cloud. OverManager never exposes any ports to the internet — it's always your app initiating the connection.

### Remote commands

When you (or someone you authorize) sends a command from the web portal or companion app:

1. The command is queued in the cloud
2. PoPManager picks it up via a persistent WebSocket connection
3. PoPManager executes it locally (same as clicking the button in the UI)
4. PoPManager sends an acknowledgment back to the cloud
2. OverManager picks it up via a persistent WebSocket connection
3. OverManager executes it locally (same as clicking the button in the UI)
4. OverManager sends an acknowledgment back to the cloud
5. The web portal / companion app shows the result

If PoPManager is offline when a command is queued, it will execute when PoPManager reconnects.
If OverManager is offline when a command is queued, it will execute when OverManager reconnects.

### Offline behavior

PoPManager continues working fully offline. When cloud connectivity is lost:
OverManager continues working fully offline. When cloud connectivity is lost:

- Local monitoring, alerts, and miner management continue normally
- Snapshots and alerts are queued locally (stored in a SQLite database)
Expand All @@ -92,10 +92,10 @@ PoPManager continues working fully offline. When cloud connectivity is lost:

| Field | Description |
|---|---|
| **Email** | Your PoPCloud account email |
| **Password** | Your PoPCloud account password (only needed for initial login) |
| **Email** | Your OverCloud account email |
| **Password** | Your OverCloud account password (only needed for initial login) |
| **Status** | Connection state: Connected / Disconnected / Syncing / Error |
| **Instance Name** | A name for this PoPManager installation (e.g. "Home Farm", "Office Rig") — editable |
| **Instance Name** | A name for this OverManager installation (e.g. "Home Farm", "Office Rig") — editable |
| **Last Sync** | Timestamp of the last successful data push |
| **Queue Size** | Number of pending items in the offline queue (only shown when > 0) |
| **Sign Out** | Disconnects from cloud and removes stored credentials |
Expand All @@ -110,11 +110,11 @@ Your cloud credentials are stored securely in your operating system's native cre
| macOS | macOS Keychain |
| Linux | Secret Service (GNOME Keyring / KDE Wallet) |

PoPManager never stores your password. After initial login, only an API key and a refresh token are stored. The refresh token expires after 30 days of inactivity — if you don't open PoPManager for 30+ days, you'll need to sign in again.
OverManager never stores your password. After initial login, only an API key and a refresh token are stored. The refresh token expires after 30 days of inactivity — if you don't open OverManager for 30+ days, you'll need to sign in again.

## Multiple Instances

One PoPCloud account can have multiple PoPManager installations connected. Each installation is a separate "instance" with its own name and API key.
One OverCloud account can have multiple OverManager installations connected. Each installation is a separate "instance" with its own name and API key.

Common use cases:
- Home mining farm + hosted facility
Expand All @@ -135,10 +135,10 @@ If you cancel your subscription, your cloud data is retained for 30 days. After

## Privacy & Security

- **No miner credentials leave your machine.** PoPManager never sends miner passwords, wallet private keys, or pool credentials to the cloud. Only performance metrics (hashrate, temperature, share counts, pool URLs, uptime) are synced.
- **All communication is encrypted.** PoPManager connects to the cloud over HTTPS (TLS 1.3) and WSS (WebSocket Secure).
- **No miner credentials leave your machine.** OverManager never sends miner passwords, wallet private keys, or pool credentials to the cloud. Only performance metrics (hashrate, temperature, share counts, pool URLs, uptime) are synced.
- **All communication is encrypted.** OverManager connects to the cloud over HTTPS (TLS 1.3) and WSS (WebSocket Secure).
- **Your API key is unique to your installation.** It can be regenerated at any time from the web portal if you suspect it's been compromised.
- **Remote commands are relayed, not executed by the cloud.** The cloud never connects to your miners directly — PoPManager desktop is always the execution layer.
- **Remote commands are relayed, not executed by the cloud.** The cloud never connects to your miners directly — OverManager desktop is always the execution layer.

## Bandwidth Usage

Expand Down
Loading
Loading