6.4 Built-in Deploy Templates

Deployment recipes for common software

CertKit includes a library of built-in deployment templates for common services and platforms. These templates pre-fill deployment configurations with optimized certificate formats and post-deployment update scripts.

Windows Templates

Basic Starters

Standard templates for common certificate formats with no pre-configured post-deployment scripts.

Template Format Variables Provided
Custom Windows Certificate Store Template windows-cert-store $thumbprint, $certificate (X509Certificate2)
Custom PFX Template pfx $certPath, $pfxPasswordFilePath
Custom PFX with Password pfx Copies the PFX to PFX Destination, protected with PFX Password.
Custom PEM Template pem-key $certPath, $keyPath, $chainPath
Custom Java KeyStore Template jks $certPath (to .jks file)

Service Specific

Windows roles and services

These run on the Windows server that hosts the service.

Applications

These run on the server that hosts the application.

Network appliances

The agent pushes the certificate to the appliance over its management API or SSH. Templates for the same product are listed together.

Cloud services and platforms

The agent pushes the certificate to the service over its API.

  • Azure Key Vault: Imports the certificate as a PFX into the vault you choose, signing in with a service principal. See the Azure Key Vault guide.
  • Microsoft Entra Application Proxy (beta): Client Secret Auth and Managed Identity Auth update the SSL certificate on App Proxy apps that use your own domain. See the Entra Application Proxy guide.
  • Boomi: Runtime: Shared Web Server Certificate, API Gateway Certificate, and Developer Portal Certificate update a Boomi X.509 certificate component in place. The gateway and portal templates need one manual click in Boomi per renewal. See the Boomi guide.
  • IBM i (AS/400) RSE API (beta): Imports the certificate into the DCM *SYSTEM store, assigns it to the applications you list, and restarts IBM HTTP Server instances. RSA keys only. See the IBM i guide.

Generic

  • Restart a Windows service: Restarts a Windows service after deployment.
  • Log only (no side effects): Logs the deployment and changes nothing. Useful for testing.

Linux Templates

Basic Starters

Template Format Variables Provided
Custom PEM Template pem-key $CERT_PATH, $KEY_PATH, $CHAIN_PATH
Custom PFX Template pfx $CERT_PATH, $PFX_PASSWORD_FILE_PATH
Custom Java KeyStore Template jks $CERT_PATH (to .jks file)

Service Specific

Services on the agent host

  • nginx: Runs nginx -t followed by nginx -s reload.
  • Apache HTTP Server: Runs apachectl configtest followed by apachectl graceful.
  • HAProxy: Validates the configuration and reloads the service.
  • Traefik: Reloads Traefik so it picks up the new certificate from disk.
  • PostgreSQL: Reloads the service to pick up new certificate material.
  • MySQL / MariaDB: Performs a service restart (required for TLS certificate updates).
  • Postfix: Validates the configuration and reloads the service.
  • Dovecot: Reloads Dovecot with doveadm reload.
  • Prometheus: Reloads the Prometheus configuration.
  • Elasticsearch: Writes the PEM files, sets their group and permissions, and restarts Elasticsearch.
  • Kibana: Writes the PEM files, sets their permissions, and restarts Kibana.
  • PM2 (Node.js process manager): Runs pm2 reload all as root by default. See the PM2 guide to use a different account.
  • OpenVPN Community Edition Server: Replaces the certificate and key in the server config, restarts OpenVPN, and rolls back if it fails to start. See the OpenVPN guide.
  • OpenVPN Access Server: Web Services Certificate: Applies the certificate to the Access Server web interfaces with sacli. VPN sessions stay connected. See the OpenVPN guide.
  • Sisense (beta): Replaces the TLS secret used by the Sisense ingress controller. See the Sisense guide.
  • Docker container (SIGHUP): Sends SIGHUP to a specific container to trigger a configuration reload.

Remote targets

The agent pushes the certificate to another system over its API.

Generic

  • Restart a systemd service: Reloads a systemd-managed service after deployment.
  • Log only (no side effects): Logs the deployment and changes nothing. Useful for testing.

For appliance and platform requirements, see the Deployment Knowledge Base. It has a guide for every network appliance and cloud template on this page.

For services not listed here, you can create a Custom Deploy Template.

Platform requirements and troubleshooting

Templates that require vendor API access, external tools, special permissions, or one-time trust configuration have permanent setup and troubleshooting notes in the Deployment Knowledge Base. The template chooser remains the source for the current script and its input fields. The knowledge base explains the surrounding platform configuration.