Update README.md

This commit is contained in:
Aterfax 2024-07-21 14:21:49 +01:00 committed by GitHub
parent ded7fc16ec
commit beacb6c692
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -41,6 +41,7 @@ For more in depth instructions, see: [Using-the-DockerHub-provided-image](#Using
### Using the DockerHub provided image ### Using the DockerHub provided image
* Run the image with the provided docker-compose file after amending it and the ``.env`` file where needed. * Run the image with the provided docker-compose file after amending it and the ``.env`` file where needed.
* The required permissions for the API key will be "DatastoreBackup" and "DatastoreReader" on the appropriate path.
* i.e. 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!**