Portabase.Agent/README.md

<br />
<div align="center">
  <a href="https://portabase.io">
    <img src="/.github/assets/logo.png" alt="Logo" width="80" height="80">
  </a>

<h3 align="center">Portabase Agent (Rust)</h3>

  <p align="center" style="margin-top: 20px; font-style: italic;">
    <i>Portabase Agent is use with Portabase Server. This service is for backup/restore db instances.
    <a href="https://github.com/Portabase/portabase">Portabase Server</a></i>
  </p>

[![License: Apache](https://img.shields.io/badge/License-apache-yellow.svg)](LICENSE)
[![Docker Pulls](https://img.shields.io/docker/pulls/solucetechnologies/agent-portabase-rust?color=brightgreen)](https://hub.docker.com/r/solucetechnologies/agent-portabase)
[![Platform](https://img.shields.io/badge/platform-linux%20%7C%20macos%20%7C%20windows-lightgrey)](https://github.com/Portabase/portabase)

[![PostgreSQL](https://img.shields.io/badge/python-3.13-blue.svg)](https://www.python.org/downloads/release/python-3120/)
[![PostgreSQL](https://img.shields.io/badge/PostgreSQL-336791?logo=postgresql&logoColor=white)](https://www.postgresql.org/)
[![MySQL](https://img.shields.io/badge/MySQL-4479A1?logo=mysql&logoColor=white)](https://www.mysql.com/)
[![MariaDB](https://img.shields.io/badge/MariaDB-003545?logo=mariadb&logoColor=white)](https://mariadb.org/)
[![MongoDB](https://img.shields.io/badge/-MongoDB-13aa52?logo=mongodb&logoColor=white)](https://www.mongodb.com/)
[![Self Hosted](https://img.shields.io/badge/self--hosted-yes-brightgreen)](https://github.com/Portabase/portabase)
[![Open Source](https://img.shields.io/badge/open%20source-❤️-red)](https://github.com/Portabase/portabase)

[![Rust][Rust]][Rust-url]
[![Tokio][Tokio]][Tokio-url]
[![Redis][Redis]][Redis-url]
[![Docker][Docker]][Docker-url]

  <p>
    <strong>
        <a href="https://portabase.io">Website</a> •
        <a href="https://portabase.io/docs">Documentation</a> •
        <a href="https://www.youtube.com/watch?v=hvLbX5LN1UE">Demo</a> •
        <a href="https://portabase.io/docs/agent/setup">Installation</a> •
        <a href="https://github.com/Portabase/agent-portabase/issues/new?labels=bug&template=bug-report---.md">Report Bug</a> •
        <a href="https://github.com/Portabase/agent-portabase/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
    </strong>
  </p>

</div>

## Installation

You have 4 ways to install Portabase Agent:

- Automated CLI (recommended) - [details](https://portabase.io/docs/agent/setup#cli)
- Docker Compose setup - [details](https://portabase.io/docs/agent/setup#docker)
- Kubernetes with Helm (soon)
- Development setup - [details](https://portabase.io/docs/agent/setup#development)

**Ensure Docker is installed on your machine before getting started.**

## Contributors

<a href="https://github.com/Portabase/agent-portabase/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=Portabase/agent-portabase" alt="contrib.rocks image" />
</a>

## License

Distributed under the Apache License. See `LICENSE.txt` for more information.

[Rust]: https://img.shields.io/badge/rust-000000?style=for-the-badge&logo=rust&logoColor=white

[Tokio]: https://img.shields.io/badge/Tokio-09d3ac?style=for-the-badge&logo=tokio&logoColor=white

[Docker]: https://img.shields.io/badge/Docker-2496ED?logo=docker&logoColor=fff&style=for-the-badge

[Redis]: https://img.shields.io/badge/Redis-DC382D?style=for-the-badge&logo=redis&logoColor=white

[Rust-url]: https://www.rust-lang.org/

[Tokio-url]: https://tokio.rs/

[Redis-url]: https://redis.io/

[Docker-url]: https://www.docker.com/