DBCalm Open Source
==================

Welcome to DBCalm Open Source documentation. Self-host your own MySQL backup solution with full control over your data.

.. toctree::
   :maxdepth: 2
   :caption: Components:
   :hidden:

   api/index
   frontend/index

Backend API
-----------

Comprehensive backend API for database backup management.

* **Automated Backups**: Schedule regular backups of your MariaDB/MySQL databases
* **Secure API**: OAuth2-based authentication with JWT tokens
* **Restore Management**: Easy restoration of backups to any point in time
* **API Client Management**: Support for multiple API clients to securely access the backup system

:doc:`View API Documentation → <api/index>`

Frontend
----------------------

Web-based interface for monitoring and managing your backups.

* Dashboard for backup status monitoring
* Easy restore interface
* Client configuration management
* Real-time process tracking

:doc:`View Frontend Documentation → <frontend/index>`

Getting Started
---------------

1. **Installation**: :doc:`api/installation`
2. **Configuration**: :doc:`api/configuration`
3. **API Reference**: :doc:`api/api-specification`
4. **Development Guide**: :doc:`api/developer-guide`

Support
-------

* **GitHub**: `github.com/mschot/dbcalm-open-backend <https://github.com/mschot/dbcalm-open-backend>`_
* **Issues**: Report bugs and request features on GitHub
* **Community**: Join discussions in GitHub Discussions