Welcome

Welcome to Db4E — The Database 4 Everything
A unified Monero (XMR) mining platform for deployment, operation, and real-time analytics.

Db4E is designed to be simple enough for new miners and powerful enough for advanced users.
It’s still under active development, but the foundations are solid — and thanks to the Textual Rapid Application Framework, progress has been remarkably fast.

🚀 Features

🎉 PyPI releases — Install instantly with pip install db4e.
🛠️ Deployment manager — Smooth vendor directory handling and update workflows.
🖥️ Integrated Textual-based TUI — Interactive forms and dashboards; no manual config files.
🔒 Privilege-aware security — Built on a sudoers-based permission model.
🧩 Modular architecture — Ready for future upgrades of Monerod, P2Pool, and XMRig.
✅ Active development — Git branching keeps main clean and stable.
📚 Unified log access — View Monero, P2Pool, and XMRig logs directly in the TUI.
📈 Historical plots — Miner, pool, and chain hashrate visualizations.
📊 Shares and blocks tracking — Real-time and historical metrics.
⚙️ Pre-populated configuration forms — Quick setup for Monero, P2Pool, and XMRig.
🔍 Uptime analytics — Start/stop logs and cumulative uptime tracking.
🚀 Seamless integration — Works with systemd and logrotate.

🧭 Getting Started

See the Getting Started Guide for a step-by-step walkthrough of deploying Db4E.

🖧 Client/Server Architecture

Db4E implements a modern client/server architecture powered by Uvicorn.

The Db4E Server runs the mining services — Monerod, P2Pool, and XMRig — and maintains the central operations database.
The Db4E Client (a Textual TUI) connects over TCP/IP to the server, retrieves real-time data, and provides an interactive dashboard for deployment, control, and analytics.

From the client, you can:

Create and configure Monero, P2Pool, and XMRig deployments.
Start and stop mining processes remotely.
View logs, metrics, and uptime reports in real time.

🗃️ SQLite Backend

Db4E uses a SQLite backend to store all configuration, runtime events, and historical mining data.

The Db4E service continuously monitors P2Pool logs and API responses, structuring and writing updates into the local database.
See the Schema Documentation for details on tables and relationships.

🔁 Release Management

For insight into how development and releases are handled, see:

⚙️ Technology Stack

Db4E runs on Debian Linux and integrates the following core components:

Db4E Core — built with Textual.
Monero Daemon (Monerod)
P2Pool
XMRig
SQLite — deployment, operations, and mining records.
Uvicorn — RESTful communication between TUI and server.
systemd — service management.
logrotate — log file maintenance.
Textual — interactive Terminal UI framework.

🧭 Roadmap

Coming soon:

📢 Automatic version checks via PyPI.
🔒 Expanded security documentation.
🐞 Full test suite and CI/CD integration.
🕵️ Community engagement and open contributions.

💬 Community & Feedback

Have ideas or suggestions?
Join the conversation on the Db4E Discussions page or visit the Blog.

💰 Donations

If Db4E helps you, please consider donating to support ongoing development.
Every contribution helps keep the project growing!