SSLMate Help

https://sslmate.com/help/
Admin
SSLMate provides services for issuing and managing SSL certificates, including a command-line...
Tokens:68,240
Snippets:548
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install SSLMate from source on other systems

Source: https://sslmate.com/help/cmdline/buy

Manual installation for systems not covered by the apt or yum repositories. Steps: download and extract the tarball, install Perl dependencies, then run make install. Optionally set PREFIX to install to a custom directory.

```bash
tar xzvf sslmate-latest.tar.gz
cd sslmate-VERSION
```

```bash
cpan URI Term::ReadKey JSON::PP
```

```bash
make install
```

```bash
make install PREFIX=/path/to/directory
```

--------------------------------

### Install SSLMate on Ubuntu 20.04 via apt

Source: https://sslmate.com/help/agent

Adds the SSLMate apt repository for Ubuntu 20.04, installs the GPG key, updates package lists, and installs sslmate and sslmate-agent. Requires the ca-certificates package to be installed beforehand.

```shell
wget -O /etc/apt/sources.list.d/sslmate2.list https://sslmate.com/apt/ubuntu2004/sslmate2.list
wget -O /etc/apt/trusted.gpg.d/sslmate.gpg https://sslmate.com/apt/ubuntu2004/sslmate.gpg
apt-get update
apt-get install sslmate sslmate-agent
```

--------------------------------

### Install SSLMate on Ubuntu 16.04 via apt

Source: https://sslmate.com/help/agent

Adds the SSLMate apt repository for Ubuntu 16.04, installs the GPG key, updates package lists, and installs sslmate and sslmate-agent. Requires the ca-certificates package to be installed beforehand.

```shell
wget -O /etc/apt/sources.list.d/sslmate2.list https://sslmate.com/apt/ubuntu1604/sslmate2.list
wget -O /etc/apt/trusted.gpg.d/sslmate.gpg https://sslmate.com/apt/ubuntu1604/sslmate.gpg
apt-get update
apt-get install sslmate sslmate-agent
```

--------------------------------

### Install SSLMate on Ubuntu 22.10 via apt

Source: https://sslmate.com/help/agent

Adds the SSLMate apt repository for Ubuntu 22.10, installs the GPG key, updates package lists, and installs sslmate and sslmate-agent. Requires the ca-certificates package to be installed beforehand.

```shell
wget -O /etc/apt/sources.list.d/sslmate2.list https://sslmate.com/apt/ubuntu2210/sslmate2.list
wget -O /etc/apt/trusted.gpg.d/sslmate.gpg https://sslmate.com/apt/ubuntu2210/sslmate.gpg
apt-get update
apt-get install sslmate sslmate-agent
```

--------------------------------

### Install SSLMate on Ubuntu 22.04 via apt

Source: https://sslmate.com/help/agent

Adds the SSLMate apt repository for Ubuntu 22.04, installs the GPG key, updates package lists, and installs sslmate and sslmate-agent. Requires the ca-certificates package to be installed beforehand.

```shell
wget -O /etc/apt/sources.list.d/sslmate2.list https://sslmate.com/apt/ubuntu2204/sslmate2.list
wget -O /etc/apt/trusted.gpg.d/sslmate.gpg https://sslmate.com/apt/ubuntu2204/sslmate.gpg
apt-get update
apt-get install sslmate sslmate-agent
```

--------------------------------

### Install SSLMate on Ubuntu 20.04 via apt

Source: https://sslmate.com/help/cmdline/buy

Adds the SSLMate apt repository and installs sslmate. Requires the ca-certificates package to be installed beforehand.

```bash
wget -O /etc/apt/sources.list.d/sslmate1.list https://sslmate.com/apt/ubuntu2004/sslmate1.list
wget -O /etc/apt/trusted.gpg.d/sslmate.gpg https://sslmate.com/apt/ubuntu2004/sslmate.gpg
apt-get update
apt-get install sslmate
```

--------------------------------

### Install SSLMate on Ubuntu 14.04 via apt

Source: https://sslmate.com/help/agent

Adds the SSLMate apt repository for Ubuntu 14.04, installs the GPG key, updates package lists, and installs sslmate and sslmate-agent. Requires the ca-certificates package to be installed beforehand.

```shell
wget -O /etc/apt/sources.list.d/sslmate2.list https://sslmate.com/apt/ubuntu1404/sslmate2.list
wget -O /etc/apt/trusted.gpg.d/sslmate.gpg https://sslmate.com/apt/ubuntu1404/sslmate.gpg
apt-get update
apt-get install sslmate sslmate-agent
```

--------------------------------

### Install SSLMate on Ubuntu 23.10 via apt

Source: https://sslmate.com/help/agent

Adds the SSLMate apt repository for Ubuntu 23.10, installs the GPG key, updates package lists, and installs sslmate and sslmate-agent. Requires the ca-certificates package to be installed beforehand.

```shell
wget -O /etc/apt/sources.list.d/sslmate2.list https://sslmate.com/apt/ubuntu2310/sslmate2.list
wget -O /etc/apt/trusted.gpg.d/sslmate.gpg https://sslmate.com/apt/ubuntu2310/sslmate.gpg
apt-get update
apt-get install sslmate sslmate-agent
```

--------------------------------

### Install SSLMate on Ubuntu 23.04 via apt

Source: https://sslmate.com/help/agent

Adds the SSLMate apt repository for Ubuntu 23.04, installs the GPG key, updates package lists, and installs sslmate and sslmate-agent. Requires the ca-certificates package to be installed beforehand.

```shell
wget -O /etc/apt/sources.list.d/sslmate2.list https://sslmate.com/apt/ubuntu2304/sslmate2.list
wget -O /etc/apt/trusted.gpg.d/sslmate.gpg https://sslmate.com/apt/ubuntu2304/sslmate.gpg
apt-get update
apt-get install sslmate sslmate-agent
```

--------------------------------

### Install SSLMate on Ubuntu 16.04 via apt

Source: https://sslmate.com/help/cmdline/buy

Adds the SSLMate apt repository and installs sslmate. Requires the ca-certificates package to be installed beforehand.

```bash
wget -O /etc/apt/sources.list.d/sslmate1.list https://sslmate.com/apt/ubuntu1604/sslmate1.list
wget -O /etc/apt/trusted.gpg.d/sslmate.gpg https://sslmate.com/apt/ubuntu1604/sslmate.gpg
apt-get update
apt-get install sslmate
```

--------------------------------

### Install SSLMate on Ubuntu 22.10 via apt

Source: https://sslmate.com/help/cmdline/buy

Adds the SSLMate apt repository and installs sslmate. Requires the ca-certificates package to be installed beforehand.

```bash
wget -O /etc/apt/sources.list.d/sslmate1.list https://sslmate.com/apt/ubuntu2210/sslmate1.list
wget -O /etc/apt/trusted.gpg.d/sslmate.gpg https://sslmate.com/apt/ubuntu2210/sslmate.gpg
apt-get update
apt-get install sslmate
```

--------------------------------

### Install SSLMate on Ubuntu 18.04 via apt

Source: https://sslmate.com/help/agent

Adds the SSLMate apt repository for Ubuntu 18.04, installs the GPG key, updates package lists, and installs sslmate and sslmate-agent. Requires the ca-certificates package to be installed beforehand.

```shell
wget -O /etc/apt/sources.list.d/sslmate2.list https://sslmate.com/apt/ubuntu1804/sslmate2.list
wget -O /etc/apt/trusted.gpg.d/sslmate.gpg https://sslmate.com/apt/ubuntu1804/sslmate.gpg
apt-get update
apt-get install sslmate sslmate-agent
```

--------------------------------

### Install sslmate-agent on Ubuntu 26.04

Source: https://sslmate.com/help/agent

Adds the SSLMate apt repository and installs both sslmate and sslmate-agent. Uses the .sources format.

```bash
wget -O /etc/apt/sources.list.d/sslmate2.sources https://sslmate.com/apt/ubuntu2604/sslmate2.sources
apt update
apt install sslmate sslmate-agent
```

--------------------------------

### Install sslmate-agent on Ubuntu 25.04

Source: https://sslmate.com/help/agent

Adds the SSLMate apt repository and installs both sslmate and sslmate-agent. Uses the .sources format.

```bash
wget -O /etc/apt/sources.list.d/sslmate2.sources https://sslmate.com/apt/ubuntu2504/sslmate2.sources
apt update
apt install sslmate sslmate-agent
```

--------------------------------

### Install SSLMate on Ubuntu 22.04 via apt

Source: https://sslmate.com/help/cmdline/buy

Adds the SSLMate apt repository and installs sslmate. Requires the ca-certificates package to be installed beforehand.

```bash
wget -O /etc/apt/sources.list.d/sslmate1.list https://sslmate.com/apt/ubuntu2204/sslmate1.list
wget -O /etc/apt/trusted.gpg.d/sslmate.gpg https://sslmate.com/apt/ubuntu2204/sslmate.gpg
apt-get update
apt-get install sslmate
```

--------------------------------

### Install SSLMate on Ubuntu 14.04 via apt

Source: https://sslmate.com/help/cmdline/buy

Adds the SSLMate apt repository and installs sslmate. Requires the ca-certificates package to be installed beforehand.

```bash
wget -O /etc/apt/sources.list.d/sslmate1.list https://sslmate.com/apt/ubuntu1404/sslmate1.list
wget -O /etc/apt/trusted.gpg.d/sslmate.gpg https://sslmate.com/apt/ubuntu1404/sslmate.gpg
apt-get update
apt-get install sslmate
```

--------------------------------

### Install SSLMate on Ubuntu 23.04 via apt

Source: https://sslmate.com/help/cmdline/buy

Adds the SSLMate apt repository and installs sslmate. Requires the ca-certificates package to be installed beforehand.

```bash
wget -O /etc/apt/sources.list.d/sslmate1.list https://sslmate.com/apt/ubuntu2304/sslmate1.list
wget -O /etc/apt/trusted.gpg.d/sslmate.gpg https://sslmate.com/apt/ubuntu2304/sslmate.gpg
apt-get update
apt-get install sslmate
```

--------------------------------

### Install SSLMate on Ubuntu 18.04 via apt

Source: https://sslmate.com/help/cmdline/buy

Adds the SSLMate apt repository and installs sslmate. Requires the ca-certificates package to be installed beforehand.

```bash
wget -O /etc/apt/sources.list.d/sslmate1.list https://sslmate.com/apt/ubuntu1804/sslmate1.list
wget -O /etc/apt/trusted.gpg.d/sslmate.gpg https://sslmate.com/apt/ubuntu1804/sslmate.gpg
apt-get update
apt-get install sslmate
```

--------------------------------

### Install sslmate-agent on Ubuntu 25.10

Source: https://sslmate.com/help/agent

Adds the SSLMate apt repository and installs both sslmate and sslmate-agent. Uses the .sources format.

```bash
wget -O /etc/apt/sources.list.d/sslmate2.sources https://sslmate.com/apt/ubuntu2510/sslmate2.sources
apt update
apt install sslmate sslmate-agent
```

--------------------------------

### Install sslmate on Ubuntu 26.04

Source: https://sslmate.com/help/cmdline/buy

Adds the sslmate apt repository and installs the sslmate package on Ubuntu 26.04.

```bash
wget -O /etc/apt/sources.list.d/sslmate1.sources https://sslmate.com/apt/ubuntu2604/sslmate1.sources
apt update
apt install sslmate
```

--------------------------------

### Install sslmate-agent on Ubuntu 24.04

Source: https://sslmate.com/help/agent

Adds the SSLMate apt repository and GPG key, then installs sslmate and sslmate-agent. Requires the ca-certificates package.

```bash
wget -O /etc/apt/sources.list.d/sslmate2.list https://sslmate.com/apt/ubuntu2404/sslmate2.list
wget -O /etc/apt/trusted.gpg.d/sslmate.gpg https://sslmate.com/apt/ubuntu2404/sslmate.gpg
apt-get update
apt-get install sslmate sslmate-agent
```

--------------------------------

### Install sslmate on Ubuntu 25.04

Source: https://sslmate.com/help/cmdline/buy

Adds the sslmate apt repository and installs the sslmate package on Ubuntu 25.04.

```bash
wget -O /etc/apt/sources.list.d/sslmate1.sources https://sslmate.com/apt/ubuntu2504/sslmate1.sources
apt update
apt install sslmate
```

--------------------------------

### Install sslmate-agent on Ubuntu 24.10

Source: https://sslmate.com/help/agent

Adds the SSLMate apt repository and GPG key, then installs sslmate and sslmate-agent. Requires the ca-certificates package.

```bash
wget -O /etc/apt/sources.list.d/sslmate2.list https://sslmate.com/apt/ubuntu2410/sslmate2.list
wget -O /etc/apt/trusted.gpg.d/sslmate.gpg https://sslmate.com/apt/ubuntu2410/sslmate.gpg
apt-get update
apt-get install sslmate sslmate-agent
```

--------------------------------

### Install sslmate-agent on Debian 13 (Trixie)

Source: https://sslmate.com/help/agent

Adds the SSLMate apt repository and installs both sslmate and sslmate-agent. Uses the .sources format.

```bash
wget -O /etc/apt/sources.list.d/sslmate2.sources https://sslmate.com/apt/trixie/sslmate2.sources
apt update
apt install sslmate sslmate-agent
```

--------------------------------

### Install SSLMate on Amazon Linux 2023 via yum

Source: https://sslmate.com/help/agent

Adds the SSLMate yum repository for Amazon Linux 2023, installs the GPG key, and installs sslmate and sslmate-agent. After installation, enable and start the agent with chkconfig and service commands.

```shell
wget -O /etc/yum.repos.d/SSLMate2.repo https://sslmate.com/yum/amzn2023/SSLMate2.repo
wget -O /etc/pki/rpm-gpg/RPM-GPG-KEY-SSLMate https://sslmate.com/yum/amzn2023/RPM-GPG-KEY-SSLMate
yum install sslmate sslmate-agent
```

--------------------------------

### sslmate-agent configuration example

Source: https://sslmate.com/help/reference/sslmate-agent.conf

Complete sslmate-agent configuration example showing api_key, cluster, order, and default sections. Demonstrates on_update commands, temp certificates, key_facls, and files configuration for combined certificates.

```plaintext
# API key found at https://sslmate.com/account/api_credentials
api_key = "123_AKRCEYZdHUrjegJ19oyI"

# Cluster configuration generated by running `sslmate clusters add webservers`
cluster "webservers" {
        secret = "examplesecret:faC4ffCDuEaCv4SFn7mCHTLCqGGaEDrhBB7DI0PRCM8"
}

order "mail.example.com" {
        # Restart Postfix and Dovecot when mail.example.com is updated:
        on_update = [
                "service postfix restart",
                "service dovecot restart",
        ]

        # Enable temporary certificates for mail.example.com, so Postfix and Dovecot
        # can start even if real certificates haven't been issued yet:
        temp = true
}

order "chat.example.com" {
        # Restart Prosody when chat.example.com is updated:
        on_update = [
                "service prosody restart",
        ]

        # Allow prosody user to read private key files for chat.example.com:
        key_facls = [
                "u:prosody:r",
        ]
}

default {
        # Install combined certificate files to an haproxy certificates directory:
        files {
                combined = "/etc/haproxy/certs/${ORDER_NAME}.pem"
        }

        # Reload haproxy when certificate files are updated:
        on_update = [
                "service haproxy reload",
        ]

}
```

--------------------------------

### Install SSLMate on RHEL/CentOS/Rocky/Alma (7, 8, 9) via yum

Source: https://sslmate.com/help/agent

Adds the SSLMate yum repository for RHEL-based distributions, installs the GPG key, and installs sslmate and sslmate-agent. Requires wget and ca-certificates packages. After installation, enable and start the agent with systemctl commands.

```shell
wget -O /etc/yum.repos.d/SSLMate2.repo https://sslmate.com/yum/centos/SSLMate2.repo
wget -O /etc/pki/rpm-gpg/RPM-GPG-KEY-SSLMate https://sslmate.com/yum/centos/RPM-GPG-KEY-SSLMate
yum install sslmate sslmate-agent
```

--------------------------------

### Install SSLMate on Amazon Linux 2 via yum

Source: https://sslmate.com/help/agent

Adds the SSLMate yum repository for Amazon Linux 2, installs the GPG key, and installs sslmate and sslmate-agent. Requires wget and ca-certificates packages. After installation, enable and start the agent with chkconfig and service commands.

```shell
wget -O /etc/yum.repos.d/SSLMate2.repo https://sslmate.com/yum/amzn2/SSLMate2.repo
wget -O /etc/pki/rpm-gpg/RPM-GPG-KEY-SSLMate https://sslmate.com/yum/amzn2/RPM-GPG-KEY-SSLMate
yum install sslmate sslmate-agent
```

--------------------------------

### Buy a certificate with sslmate buy

Source: https://sslmate.com/help/cmdline/buy

Run `sslmate buy` with one or more domain arguments. For wildcard domains, use the `*.example.com` format. The auto-renewal setting defaults to your account default unless overridden with `--auto-renew` or `--no-auto-renew`.

```bash
sslmate buy DOMAIN...
```

--------------------------------

### sslmate help

Source: https://sslmate.com/help/reference/cli2

Display help for the given command, or an overview of all commands if no command is specified.

```APIDOC
## sslmate help

### Description
Display help for the given command, or an overview of all commands if no command is specified.

### Syntax
`sslmate help [COMMAND]`

```

--------------------------------

### Minimal sslmate-agent.conf example

Source: https://sslmate.com/help/reference/sslmate-agent.conf

A minimal /etc/sslmate-agent/sslmate-agent.conf file. It requires your own API key from https://sslmate.com/account/api_credentials and cluster details generated by `sslmate clusters add webservers`. The default section lists commands to restart services that use your certificates.

```plaintext
# Replace with your own API key found at https://sslmate.com/account/api_credentials
api_key = "123_AKRCEYZdHUrjegJ19oyI"

# Replace with your own cluster details generated by running `sslmate clusters add webservers`
cluster "webservers" {
        secret = "examplesecret:faC4ffCDuEaCv4SFn7mCHTLCqGGaEDrhBB7DI0PRCM8"
}

default {
        # Replace with a list of commands to restart the services which use your certificates
        on_update = [
                "service nginx restart",
                "service postfix restart",
        ]
}
```

--------------------------------

### Example order object

Source: https://sslmate.com/help/reference/apiv3

Shows a complete SSLMate order object with fields like dns_names, cluster, product, key_type, revision, and current_cert_download. The current_cert field is omitted because it is null in this example.

```json
{ "name": "example.com", "dns_names": ["example.com", "www.example.com"], "approver_emails": {}, "cluster": "webservers", "auto_renew": true, "muted": false, "paused": false, "product": "sectigo", "key_type": "rsa", "revision": 1024, "current_cert_download": "https://certs.sslmate.com/tZwf1MOnfY8AVdXUeHhM/example.com.rsa.pem", "pubkey_sha256": "13550350a8681c84c861aac2e5b440161c2b33a3e4f302ac680ca5b686de48de" }
```

--------------------------------

### Install SSLMate on RHEL/CentOS/Rocky/Alma via yum

Source: https://sslmate.com/help/cmdline/buy

Adds the SSLMate yum repository and installs sslmate. Requires the wget and ca-certificates packages to be installed beforehand.

```bash
wget -O /etc/yum.repos.d/SSLMate1.repo https://sslmate.com/yum/centos/SSLMate1.repo
wget -O /etc/pki/rpm-gpg/RPM-GPG-KEY-SSLMate https://sslmate.com/yum/centos/RPM-GPG-KEY-SSLMate
yum install sslmate
```

--------------------------------

### Install SSLMate on Amazon Linux 1 via yum

Source: https://sslmate.com/help/cmdline/buy

Adds the SSLMate yum repository and installs sslmate. Requires the wget and ca-certificates packages to be installed beforehand.

```bash
wget -O /etc/yum.repos.d/SSLMate1.repo https://sslmate.com/yum/amzn1/SSLMate1.repo
wget -O /etc/pki/rpm-gpg/RPM-GPG-KEY-SSLMate https://sslmate.com/yum/amzn1/RPM-GPG-KEY-SSLMate
yum install sslmate
```

--------------------------------

### Install SSLMate on Amazon Linux 2 via yum

Source: https://sslmate.com/help/cmdline/buy

Adds the SSLMate yum repository and installs sslmate. Requires the wget and ca-certificates packages to be installed beforehand.

```bash
wget -O /etc/yum.repos.d/SSLMate1.repo https://sslmate.com/yum/amzn2/SSLMate1.repo
wget -O /etc/pki/rpm-gpg/RPM-GPG-KEY-SSLMate https://sslmate.com/yum/amzn2/RPM-GPG-KEY-SSLMate
yum install sslmate
```
Tokens:
Raw