Lego

https://go-acme.github.io/lego/
Admin
Lego is an ACME client and library written in Go, offering comprehensive features for automated...
Tokens:391,569
Snippets:3,814
Trust Score:9.7
Update:1 week ago
Show doc for...
Tokens:
Raw
### Deploy-hook script for Postfix mail server

Source: https://go-acme.github.io/lego/advanced/hooks/index.print.html

A deploy-hook example that installs the new certificate for a Postfix mail server and reloads it. It uses the LEGO_HOOK_CERT_NAME, LEGO_HOOK_CERT_PATH, and LEGO_HOOK_CERT_KEY_PATH environment variables. Error checking is omitted for brevity; it is just a starting point.

```bash
#!/bin/bash

# copy certificates to a directory controlled by Postfix
postfix_cert_dir="/etc/postfix/certificates"

# our Postfix server only handles mail for @example.com domain
if [ "$LEGO_HOOK_CERT_NAME" = "example.com" ]; then
  install -u postfix -g postfix -m 0644 "$LEGO_HOOK_CERT_PATH" "$postfix_cert_dir"
  install -u postfix -g postfix -m 0640 "$LEGO_HOOK_CERT_KEY_PATH"  "$postfix_cert_dir"

  systemctl reload postfix@-service
fi

```

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

### Run lego with BookMyName provider

Source: https://go-acme.github.io/lego/dns/bookmyname/index.print.html

Example bash command using the BookMyName provider with required credentials BOOKMYNAME_USERNAME and BOOKMYNAME_PASSWORD. It requests certificates for '*.example.com' and 'example.com'.

```bash
BOOKMYNAME_USERNAME="xxx" \
BOOKMYNAME_PASSWORD="yyy" \
lego run --dns bookmyname -d '*.example.com' -d example.com
```

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

### Run lego with Selectel v2 provider

Source: https://go-acme.github.io/lego/dns/index.print.html

Example bash command using the Selectel v2 provider. Sets required environment variables and runs lego with the selectelv2 DNS provider for domains '*.example.com' and 'example.com'.

```bash
SELECTELV2_USERNAME=trex \
SELECTELV2_PASSWORD=xxxxx \
SELECTELV2_ACCOUNT_ID=1234567 \
SELECTELV2_PROJECT_ID=111a11111aaa11aa1a11aaa11111aa1a \
lego run --dns selectelv2 -d '*.example.com' -d example.com
```

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

### Example hook script to install certificate for Postfix

Source: https://go-acme.github.io/lego/advanced/hooks

Bash script that installs the new certificate for a mail server and reloads it. It checks if the certificate name matches 'example.com' and copies the certificate and key to the Postfix directory. Error checking is omitted for brevity.

```bash
#!/bin/bash

# copy certificates to a directory controlled by Postfix
postfix_cert_dir="/etc/postfix/certificates"

# our Postfix server only handles mail for @example.com domain
if [ "$LEGO_HOOK_CERT_NAME" = "example.com" ]; then
  install -u postfix -g postfix -m 0644 "$LEGO_HOOK_CERT_PATH" "$postfix_cert_dir"
  install -u postfix -g postfix -m 0640 "$LEGO_HOOK_CERT_KEY_PATH"  "$postfix_cert_dir"

  systemctl reload postfix@-service
fi
```

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

### Run lego with Dinahosting provider

Source: https://go-acme.github.io/lego/dns/dinahosting

Example bash command using the Dinahosting provider with environment variables for credentials. The command requests a certificate for '*.example.com' and 'example.com'.

```bash
DINAHOSTING_USERNAME="xxx" \
DINAHOSTING_PASSWORD="yyy" \
lego run --dns dinahosting -d '*.example.com' -d example.com
```

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

### Install lego from sources with go install

Source: https://go-acme.github.io/lego/install/index.print.html

Installs the latest version of lego from sources using Go. Requires go1.25+.

```bash
go install github.com/go-acme/lego/v5@latest
```

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

### Install lego via brew (Homebrew)

Source: https://go-acme.github.io/lego/install/index.print.html

Installs lego using the Homebrew package manager.

```bash
brew install lego
```

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

### Run lego with Abion provider

Source: https://go-acme.github.io/lego/dns/abion/index.html

Example bash command using the Abion provider with the ABION_API_KEY environment variable. The command requests certificates for '*.example.com' and 'example.com'.

```bash
ABION_API_KEY="xxxxxxxxxxxx" \
lego run --dns abion -d '*.example.com' -d example.com
```

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

### Install lego via pkg (OpenBSD)

Source: https://go-acme.github.io/lego/install/index.print.html

Installs lego using the pkg package manager on OpenBSD.

```bash
pkg_add lego
```

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

### Run lego with Leaseweb provider

Source: https://go-acme.github.io/lego/dns/leaseweb/index.html

Example bash command using the Leaseweb provider with the LEASEWEB_API_KEY environment variable. The command runs lego with the --dns leaseweb flag for domains *.example.com and example.com.

```bash
LEASEWEB_API_KEY="xxxxxxxxxxxxxxxxxxxxx" \
lego run --dns leaseweb -d '*.example.com' -d example.com
```

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

### OVH provider example bash command with three authentication methods

Source: https://go-acme.github.io/lego/dns/index.print.html

Shows how to run lego with the OVH provider using Application Key, Access Token, or OAuth2 authentication. Each method requires specific environment variables and the OVH_ENDPOINT. The command uses the --dns ovh flag and requests certificates for '*.example.com' and 'example.com'.

```bash
# Application Key authentication:

OVH_APPLICATION_KEY=1234567898765432 \
OVH_APPLICATION_SECRET=b9841238feb177a84330febba8a832089 \
OVH_CONSUMER_KEY=256vfsd347245sdfg \
OVH_ENDPOINT=ovh-eu \
lego run --dns ovh -d '*.example.com' -d example.com

# Or Access Token:

OVH_ACCESS_TOKEN=xxx \
OVH_ENDPOINT=ovh-eu \
lego run --dns ovh -d '*.example.com' -d example.com

# Or OAuth2:

OVH_CLIENT_ID=yyy \
OVH_CLIENT_SECRET=xxx \
OVH_ENDPOINT=ovh-eu \
lego run --dns ovh -d '*.example.com' -d example.com
```

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

### Install lego via pkg (FreeBSD)

Source: https://go-acme.github.io/lego/install/index.print.html

Installs lego using the pkg package manager on FreeBSD.

```bash
pkg install lego
```

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

### Install lego-bin via yay (Arch)

Source: https://go-acme.github.io/lego/install/index.print.html

Installs the lego-bin package using the yay AUR helper.

```bash
yay -S lego-bin
```

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

### Run lego with Hosting.de provider

Source: https://go-acme.github.io/lego/dns/hostingde

Example bash command using the Hosting.de provider. Requires the HOSTINGDE_API_KEY environment variable. The command requests certificates for '*.example.com' and 'example.com'.

```bash
HOSTINGDE_API_KEY=xxxxxxxx \
lego run --dns hostingde -d '*.example.com' -d example.com
```

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

### Run lego with Namecheap provider

Source: https://go-acme.github.io/lego/dns/namecheap/index.print.html

Example bash command using the Namecheap provider. Requires NAMECHEAP_API_USER and NAMECHEAP_API_KEY environment variables. The command requests certificates for '*.example.com' and 'example.com'.

```bash
NAMECHEAP_API_USER=user \
NAMECHEAP_API_KEY=key \
lego run --dns namecheap -d '*.example.com' -d example.com
```

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

### Install lego via pacman (Arch)

Source: https://go-acme.github.io/lego/install/index.print.html

Installs lego using the pacman package manager on Arch Linux.

```bash
pacman -S lego
```

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

### Run lego with Beget.com provider

Source: https://go-acme.github.io/lego/dns/beget/index.html

Example bash command using the Beget.com provider with the `lego` CLI. Requires `BEGET_USERNAME` and `BEGET_PASSWORD` environment variables.

```bash
BEGET_USERNAME=xxxxxx \
BEGET_PASSWORD=yyyyyy \
lego run --dns beget -d '*.example.com' -d example.com
```

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

### Technitium provider example bash command

Source: https://go-acme.github.io/lego/dns/index.print.html

Example bash command using the Technitium provider with TECHNITIUM_SERVER_BASE_URL and TECHNITIUM_API_TOKEN.

```bash
TECHNITIUM_SERVER_BASE_URL="https://localhost:5380" \
TECHNITIUM_API_TOKEN="xxxxxxxxxxxxxxxxxxxxx" \
lego run --dns technitium -d '*.example.com' -d example.com
```
Tokens:
Raw