tmueller/pbs-client-docker
1
0
Fork 0
mirror of https://github.com/edv-pi/pbs-client-docker.git synced 2025-04-20 07:52:56 +02:00
Code Issues Actions Packages repo.project_board Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Aterfax 2024-04-18 23:36:54 +01:00 committed by GitHub
parent ef33143458
commit 1a42c094f0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -14,7 +14,12 @@
This container is still a work in progress but the main feature (cronjob'd backups) now works. 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) 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](#Using-the-DockerHub-provided-image)
## Table of Contents ## Table of Contents
@ -35,13 +40,15 @@ Reading and using the ``docker-compose\docker-compose.yml`` and example ``.env.e
### Using the DockerHub provided image ### Using the DockerHub provided image
* Run the image with the provided docker-compose file amending where needed. * Run the image with the provided docker-compose file after amending it and the ``.env`` file where needed.
* Bind mount the folders or volumes you wish to backup into the continer's ``/backups`` directiory. * i.e. 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. * 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! * **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. * 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. * Populate the environment file with the correct ``PBS_ENCRYPTION_PASSWORD`` value from the container logs or from your provided ``pem`` files.
* Restart the container and check the logs to confirm a successful backup. * Restart the container and check the logs to confirm a successful backup.
* You can start a backup with the ``backupnow`` command from inside the container, i.e. ``docker exec -it pbs-client backupnow``
* Review the other helper scripts [from here](https://github.com/Aterfax/pbs-client-docker/tree/main/docker/src/helper_scripts) which are also available from the container terminal.
### Using a self built image ### Using a self built image