Skip to content
local-cert
Browse the documentation

Quick start

local-cert gets Let's Encrypt certificates for machines that can't be reached from the Internet: NAS boxes, hypervisors, internal services. Validation goes through DNS (DNS-01), so only local-cert needs access to your zone.

The full path

  1. Declare a DNS provider. This is the account at the host of your zone, with its credentials: AWS, OVHcloud, Gandi, GoDaddy or Google Cloud. See the Providers page and the DNS providers guides.
  2. Add a domain. Pick a zone from the provider; local-cert generates the IAM policy to paste, tests the permissions, then saves. See the Domains page and the Add a domain guide.
  3. Grant access. In Keys & access, create an API key (scripts, agents) or an EAB credential (ACME clients: Traefik, Caddy, certbot…), depending on what you need.
  4. Issue. Through the ACME server or the API — see below.

Which route to pick

ACME serverREST API
Fora reverse proxy or a tool that already speaks ACMEa script, a tool without ACME, an agent (MCP)
AccessEAB credentialAPI key
Private keygenerated and kept by the clientgenerated by local-cert, encrypted in the database
Renewalby the clientby local-cert (auto_renew)

ACME route, in one command

With an EAB credential authorized on the domain, any ACME client can get a certificate. Example with certbot:

certbot
certbot certonly --standalone -d nas.home.example.com \
  --server https://certs.example.com/acme/directory \
  --eab-kid eab_XXXXXXXXXXXXXXXX --eab-hmac-key CLE_HMAC

How it works, and the per-tool guides, are in ACME server.

API route, in one request

curl
curl -X POST https://certs.example.com/api/v1/certificates \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'content-type: application/json' \
  -d '{
    "domains": ["nas.home.example.com"],
    "key_type": "ec-256",
    "auto_renew": true,
    "dns": { "create_record": true, "target_ip": "192.168.1.50" }
  }'

The response is immediate (202); issuance takes one to three minutes. All routes are described under API.

Examples use https://certs.example.com as the address of your instance: replace it with yours. The Docs page of your console shows every guide with your own URLs.