From aa01190ef6d0298a8bcb2291d7dd1c8570c9fe25 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?s=E1=B4=A7=E1=B4=8D=E1=B4=9C=E1=B4=87=CA=9F=20=E1=B4=8D?= Date: Wed, 14 Feb 2024 00:50:04 +0000 Subject: [PATCH] Update README.md --- README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 49 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 31a434c..3374591 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,49 @@ -# docker-brudi-rclone -Add Rclone dependencies to Brudi +````markdown +# Brudi Docker Image (with rclone, mariadb, postgres) + +This repository provides a Docker image based on Alpine Linux that includes Brudi along with related dependencies such as Restic, Rclone, MariaDB/MySQL, and PostgreSQL binaries. + +## Features + +- **Brudi**: A powerful tool for managing your personal data and documents securely. +- **Restic**: Fast, secure, efficient backup program. +- **Rclone**: Command-line program for managing files on cloud storage. +- **MariaDB/MySQL and PostgreSQL Binaries**: Popular relational database management systems. + +## Usage + +### Pulling the Docker Image + +You can pull the latest version of the Docker image from Docker Hub using the following command: + +```bash +docker pull sami/brudi-rclone +``` + +### Running the Container + +To run a container with the Brudi image, you can use the following command: + +```bash +docker run -d --name brudi-container sami/brudi-rclone +``` + +### Environment Variables + +The following environment variables can be used to configure the container: + +- **TODO**: Document any relevant environment variables here. + +### Volumes + +You may want to mount volumes to persist data or configuration files. The following directories are commonly used: + +- **TODO**: Document any relevant volumes here. + +## Contributing + +If you find any issues with this Docker image or have suggestions for improvements, please feel free to open an issue or submit a pull request. + +## License + +This project is licensed under the [MIT License](LICENSE).