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.
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.
There are also various helper scripts available when using the shell inside the container which can be seen here: https://github.com/Aterfax/pbs-client-docker/tree/main/docker/src/helper_scripts
For more in depth instructions, see: Using-the-DockerHub-provided-image
- 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.
- You understand how to bind mount / volume mount in docker.
- Run the image with the provided docker-compose file after amending it and the
.envfile where needed.- i.e. bind mount the folders or volumes you wish to backup into the continer's
/backupsdirectiory. - Supply your desired
master-public.pem,master-private.pemandencryption-key.jsonfiles or allow the container to automatically generate them on first run.
- i.e. bind mount the folders or volumes you wish to backup into the continer's
- 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.pemandencryption-key.jsonfiles and passwords. - Populate the environment file with the correct
PBS_ENCRYPTION_PASSWORDvalue from the container logs or from your providedpemfiles. - Restart the container and check the logs to confirm a successful backup.
- You can start a backup with the
backupnowcommand from inside the container, i.e.docker exec -it pbs-client backupnow
- You can start a backup with the
- Review the other helper scripts from here which are also available from the container terminal.
-
Navigate to the
dockersubdirectory and run the commanddocker 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 image line to:
image: myusername/pbs-client -
You can now follow the instructions as per the Using the DockerHub provided image section.
To be filled in.
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 |
If you encounter issues, check the Troubleshooting section 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.
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.
This project is licensed under the 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.