diff --git a/deployhooks.md b/deployhooks.md index e124b90..16b9a6c 100644 --- a/deployhooks.md +++ b/deployhooks.md @@ -875,6 +875,29 @@ export DEPLOY_PROXMOXVE_API_TOKEN_KEY=<token_secret> acme.sh --deploy -d vm1.home.wesitcllc.com --deploy-hook proxmoxve ``` + +## 27bis. Deploy the cert on a Proxmox Backup Server (PBS). + +This deploy script is tested on Proxmox Backup Server 3.3-2. It deploys a certificate through the Proxmox Backup Server API, it requires an API key with access to the [sys.modify](https://pbs.proxmox.com/docs/api-viewer/index.html#/nodes/%7Bnode%7D/certificates/custom) permission. + +To create an API key with the sys.modify permission either create an API key as root _or_ create a new user with the sys.modify permission and create an API key for that user then, when creating the API key, ensure that the `Privilege Separation` box is unchecked (to inherit permissions from the user) _or_ assign the sys.modify permission directly to the API token. Make note of the `Token ID` as that will be used as the value for **DEPLOY_PROXMOXBS_API_TOKEN_NAME**, and make note of the token key itself as that is required and will be used for **DEPLOY_PROXMOXBS_API_TOKEN_KEY**, the API token key can only be seen _once_ at initial creation and not viewed again afterwards. When creating a new user make note of the _username_ and _realm_ (the string after the `@`). The username will be used as the value for **DEPLOY_PROXMOXBS_USER** and the realm will be used as the value for **DEPLOY_PROXMOXBS_USER_REALM**. + +**DEPLOY_PROXMOXBS_SERVER**: The hostname of the proxmox backup server. Defaults to the domain of the certificate.\ +**DEPLOY_PROXMOXBS_SERVER_PORT**: The port number the management interface is on. Defaults to 8007.\ +**DEPLOY_PROXMOXBS_USER**: The user who owns the API key. Defaults to root.\ +**DEPLOY_PROXMOXBS_USER_REALM**: The authentication realm the user authenticates with. Defaults to pam.\ +**DEPLOY_PROXMOXBS_API_TOKEN_NAME**: The name of the API token created for the user account. Defaults to acme.\ +**DEPLOY_PROXMOXBS_API_TOKEN_KEY**: The API token. Required. + +```sh +export DEPLOY_PROXMOXBS_USER=<username> +export DEPLOY_PROXMOXBS_USER_REALM=<realm> +export DEPLOY_PROXMOXBS_API_TOKEN_NAME=<token_id> +export DEPLOY_PROXMOXBS_API_TOKEN_KEY=<token_secret> + +acme.sh --deploy -d pbs.home.wesitcllc.com --deploy-hook proxmoxbs +``` + ## 28. Deploy cert on MuleSoft CloudHub 2.0 Before you can deploy your cert, you must [issue the cert first](https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert).