# Welcome

This is the home of **Db4E**, the **Database 4 Everything** project — A unified Monero XMR mining dashboard for deployment, operation and real-time analytics.

Db4E aims to be simple enough for new miners and flexible enough for advanced users. It’s still under active development, but the foundations are solid — and thanks to the [Textual Rapid Application Framework](https://textual.textualize.io/), progress is astonishingly fast.

**Now available on [PyPI](https://pypi.org/project/db4e/):**  

```shell
pip install db4e
```

---

# Features Today

* 🎉 First official PyPI production release — now you can `pip install db4e`!
* 🛠️ Deployment manager with smooth vendor directory handling and update workflows.
* 🖥️ Fully integrated Textual-based TUI with interactive forms — no more manual command-line config.
* 🔒 Built-in security architecture with sudoers-based privilege management.
* 🧩 Modular design for future-proof upgrades of Monerod, P2Pool, and XMRig.
* ✅ Active development in Git branches, keeping `main` clean and stable.


The [https://xmr.osoyalce.com/](https://xmr.osoyalce.com/) site is generated by the old *Db4E* application. It houses live data from a small Monero XMR Mining farm and gives you a sense of what historical reporting can deliver.

---

# MongoDB Backend

Db4E includes a **MongoDB backend** to store historical mining data, logs, and configuration. The Db4E service runs continuously, monitors P2Pool logs and API responses, and writes structured records into MongoDB. That data powers features like [historical reports](https://xmr.osoyalce.com/pages/Reports.html) and the [interactive TUI](/pages/db4e-tui.py.html).


---

# Technology Stack

Db4E runs on [Debian Linux](https://www.debian.org/) and includes the following core components:

* [Db4E core application](https://github.com/NadimGhaznavi/Db4E) — built with the [Textual](https://textual.textualize.io/) RAD framework.
* [Monero Daemon (monerod)](https://www.getmonero.org/).
* [P2Pool daemon](https://github.com/SChernykh/p2pool).
* [XMRig](https://xmrig.com/) mining software.
* [MongoDB](https://www.mongodb.com/) for historical data storage.
* [systemd](https://en.wikipedia.org/wiki/Systemd) for service management.

---

# Coming Soon

* 📈  Rich historical data tracking for mining performance and yield.
* 🧙  Plotext-based terminal analytics directly in the TUI.
* 📢  PyPI release checking — automatic version notifications.
* 🔒  Full security architecture documentation.
* 🐞  Full unit + integration testing suite and CI/CD integration.
* 🕵️  Community building and open contributions — feedback welcomed!

---

# Community Feedback

*Questions? Ideas? Feedback?* Please go to the *db4e* project's [Discussions](https://github.com/NadimGhaznavi/db4e/discussions) page.

---

# Donations

If you find Db4E useful, please consider [donating](/pages/Donations.html) to help support its ongoing development. Every contribution helps!


