mirror of
https://github.com/edv-pi/pbs-client-docker.git
synced 2025-04-20 05:52:55 +02:00
105 lines
5.0 KiB
Markdown
105 lines
5.0 KiB
Markdown
# Proxmox Backup Server: Client Docker
|
|
|
|
[](https://github.com/Aterfax/pbs-client-docker/actions/workflows/docker-publish.yml)
|
|
|
|
|
|
|
|
## **tl;dr?**
|
|
|
|
**Q:** What does this Docker image do?
|
|
|
|
**A:** It lets you run the Proxmox Backup Server client and backup things from any directory mounted within /backups inside the container.
|
|
|
|
## Longer summary
|
|
|
|
This container is still a work in progress but the main feature (cronjob'd backups) now works.
|
|
|
|
Reading and using the ``docker-compose\docker-compose.yml`` and example ``.env.example`` file should be illustrative on how to use this container. See also: [Using-the-DockerHub-provided-image](#Using-the-DockerHub-provided-image)
|
|
|
|
## Table of Contents
|
|
|
|
- [Quickstart](#Quickstart)
|
|
- [Configuration](#Configuration)
|
|
- [FAQ](#FAQ)
|
|
- [Troubleshooting](#Troubleshooting)
|
|
- [Contributing](#Contributing)
|
|
- [License](#License)
|
|
|
|
## Quickstart
|
|
|
|
### Prerequisites
|
|
|
|
* You are running a platform which supports Docker and you have Docker installed on your system. i.e. a Linux machine or cloud VM. You can download it from [here](https://www.docker.com/get-started).
|
|
* You understand how to bind mount / volume mount in docker.
|
|
|
|
|
|
### Using the DockerHub provided image
|
|
|
|
* Run the image with the provided docker-compose file amending where needed.
|
|
* Bind mount the folders or volumes you wish to backup into the continer's ``/backups`` directiory.
|
|
* Supply your desired ``master-public.pem``, ``master-private.pem`` and ``encryption-key.json`` files or allow the container to automatically generate them on first run.
|
|
* If you do allow automatic generation passwords will be echoed to the container logs only once during first run!
|
|
* Backup the ``master-public.pem``, ``master-private.pem`` and ``encryption-key.json`` files and passwords.
|
|
* Populate the environment file with the correct ``PBS_ENCRYPTION_PASSWORD`` value.
|
|
* Restart the container and check the logs to confirm a successful backup.
|
|
|
|
|
|
### Using a self built image
|
|
|
|
* Navigate to the ``docker`` subdirectory and run the command ``docker build -t $USER/pbs-client .``
|
|
* Take a note of the final line of this command's output e.g. :
|
|
|
|
=> => naming to docker.io/myusername/pbs-client
|
|
|
|
* Amend the [docker-compose/docker-compose.yml](docker-compose/docker-compose.yml) image line to:
|
|
|
|
image: myusername/pbs-client
|
|
|
|
* You can now follow the instructions as per the [Using the DockerHub provided image](#Using-the-DockerHub-provided-image) section.
|
|
|
|
|
|
## Configuration
|
|
|
|
### Common post installation configuration actions
|
|
|
|
To be filled in.
|
|
|
|
### Table of available container environment variables
|
|
|
|
To be filled in.
|
|
|
|
The following environment variables can be configured to customize the behavior of the Docker container:
|
|
|
|
| Variable Name | Default Docker Compose Value | Valid Values | Description |
|
|
|--------------------|------------------------------|------------------------|-----------------------------------------------------------------------------------------------------------------------|
|
|
| Variable Name | Default Docker Compose Value | Valid Values | Description |
|
|
|
|
|
|
|
|
## FAQ
|
|
|
|
## Troubleshooting
|
|
|
|
If you encounter issues, check the [Troubleshooting section](TROUBLESHOOTING.md) for solutions to common problems.
|
|
|
|
If this section is lacking steps to resolve your issue please take a look in the Github discussions to see if someone else has already resolved your issue or
|
|
please start a thread.
|
|
|
|
If you have a problem or feature request and you know this related directly to the code implemented by this repo please file an issue detailing the nature of the problem or feature and any steps for implementation within a pull request.
|
|
|
|
## Contributing
|
|
|
|
If you'd like to contribute to this project, follow these steps:
|
|
|
|
* Fork the repository.
|
|
* Create a new branch for your feature: git checkout -b feature-name.
|
|
* Make your changes and commit them e.g. : git commit -m "Add feature".
|
|
* Push to the branch: git push origin feature-name.
|
|
* Create a pull request explaining your changes.
|
|
|
|
## License
|
|
|
|
This project is licensed under the [GNU General Public License v3 (GPL-3)](https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3).
|
|
|
|
In short: You may copy, distribute and modify the software as long as you track changes/dates in source files. Any modifications to or software including (via compiler) GPL-licensed code must also be made available under the GPL along with build & install instructions.
|