mirror of
https://github.com/s83/docker-brudi-rclone.git
synced 2024-11-23 06:19:00 +00:00
Update README.md
This commit is contained in:
parent
4dea25ff8b
commit
aa01190ef6
51
README.md
51
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).
|
||||
|
Loading…
Reference in New Issue
Block a user