Skip to main content
ACME Certificates
Access & SecuritySourceAPIChangelog

Reference

Settings​

Admin​

Set by an admin in Settings, under the plugin's name. It applies to everyone.

SettingTypeDefaultWhat it does
Renew automaticallybooleanfalseCheck twice a day and get a new certificate when there is none, it does not cover the domain, or it expires within 30 days.
DomainstringThe public domain name for the certificate.
EmailstringContact email for the ACME account and expiry notices.
Certificate authorityselect"letsencrypt"Where to get the certificate. Use staging to test without hitting Let's Encrypt rate limits.
ACME directory URLstringOnly for a custom certificate authority. Must be an https URL.
Challenge typeselect"http-01"How to prove you own the domain.
Cloudflare API tokensecretScoped token with Zone:DNS:Edit permission for your domain.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
acme-ssl.manageadminSee the certificate status and request a new certificate now.

Actions​

Run these from Operations Center, Automations, the CLI (termix ops), the phone app or the API. See actions.

ActionRuns onRiskInputs
acme-ssl.certificate
HTTPS certificate
The serverRead only
acme-ssl.request
Request a certificate now
The serverChanges

Capabilities​

What the plugin's code is allowed to do. Termix shows this list before you install it. See capabilities for all of them.

CapabilityRiskWhat it means
system:tlsCriticalManage certificates. It can replace the certificate Termix serves over HTTPS and answer domain checks from certificate authorities.
users:impersonateHighAct as other users. Runs background work with another user's access, such as scheduled jobs. Every use is written to the audit log.
network:outboundMediumReach the internet. It can send requests to outside services.
network:serveMediumAccept connections. It opens a port on the Termix server.
notify:sendMediumSend alerts. To you or other users, and through the channels they set up.
operations:provideMediumOffer actions. Its actions can be run from Automations, the CLI, the phone app and other places, by people allowed to use them.
kv:ownLowRemember small settings. Kept separate from other plugins.
secrets:ownLowStore its own secrets. Encrypted by Termix. The plugin never holds the key.
ui:surfaceLowAdd its own screens. Tabs, panels and settings you can hide later.

Services​

Services are how plugins call each other. Plugin authors can use these.

UsesVersionOptional
dns.records^1.0.0yes

API​

The plugin's HTTP routes are in the API reference.

Platforms​

Linux, Windows, macOS