-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Running a private vaultwarden instance with Let's Encrypt certs
Suppose you want to run an instance of vaultwarden that can only be accessed from your local network, but you want your instance to be HTTPS-enabled with certs signed by a widely-accepted CA instead of managing your own private CA (to avoid the hassle of having to load private CA certs into all of your devices).
This article demonstrates how to create such a setup using the Caddy web server, which has built-in ACME support for various DNS providers. We'll configure Caddy to obtain Let's Encrypt certs via the ACME DNS challenge -- using the more common HTTP challenge would be problematic here, since it would rely on Let's Encrypt servers being able to reach your internal web server.
(Note that this article covers the DNS challenge setup in more generic terms, but many users will probably find it easiest to use Docker Compose to integrate Caddy and vaultwarden. See Using Docker Compose for an example specific to that.)
Two DNS providers are covered:
-
Duck DNS -- This gives you a subdomain under
duckdns.org
(e.g.,my-vw.duckdns.org
). This option is simplest if you don't already own a domain. - Cloudflare -- This lets you put your vaultwarden instance under a domain you own or control. Note that Cloudflare can be used as just a DNS provider (i.e., without the proxying functionality that Cloudflare is best known for). If you don't currently own a domain, you may be able to get a free one at Freenom.
It's certainly possible to create a similar setup using other combinations of web server, ACME client, and DNS provider, but you'll have to work out the differences in details.
DNS challenge support is not built into Caddy by default, as most people don't use this challenge method, and it requires a custom implementation for each DNS provider.
The easiest way to get a version of Caddy with the necessary DNS challenge modules is via https://caddyserver.com/download. Select your platform, check the box for github.com/caddy-dns/cloudflare
(for Cloudflare support) and/or github.com/caddy-dns/duckdns
(for Duck DNS support), and then click Download
.
If you prefer to build from source, you can use xcaddy
. For example, to create a build that includes both Cloudflare and Duck DNS support:
xcaddy build --with github.com/caddy-dns/cloudflare --with github.com/caddy-dns/duckdns
Move the caddy
binary to /usr/local/bin/caddy
or some other appropriate directory in your path. Optionally, run sudo setcap cap_net_bind_service=+ep /usr/local/bin/caddy
to allow caddy
to listen on privileged ports (< 1024) without running as root.
If you don't already have an account, create one at https://www.duckdns.org/. Create a subdomain for your vaultwarden instance (e.g., my-vw.duckdns.org
), setting its IP to your vaultwarden host's private IP (e.g., 192.168.1.100
). Make note of your account's token (a string in UUID format). Caddy will need this token to solve the DNS challenge.
Create a file named Caddyfile
with the following content:
{$DOMAIN}:443 {
tls {
dns duckdns {$DUCKDNS_TOKEN}
}
reverse_proxy localhost:8080
reverse_proxy /notifications/hub localhost:3012
}
Create a file named caddy.env
with the following content (replacing each value as appropriate):
DOMAIN=my-vw.duckdns.org
DUCKDNS_TOKEN=00112233-4455-6677-8899-aabbccddeeff
Start caddy
by running
caddy run -envfile caddy.env
Start vaultwarden
by running
export ROCKET_PORT=8080
export WEBSOCKET_ENABLED=true
./vaultwarden
You should now be able to reach your vaultwarden instance at https://my-vw.duckdns.org.
If you don't already have an account, create one at https://www.cloudflare.com/; you'll also have to go to your domain registrar to set your nameservers to the ones assigned to you by Cloudflare. Create a subdomain for your vaultwarden instance (e.g., vw.example.com
), setting its IP to your vaultwarden host's private IP (e.g., 192.168.1.100
). For example:
Create an API token for the DNS challenge (for more background, see https://github.com/libdns/cloudflare/blob/master/README.md):
- In the upper right, click the person icon and navigate to
My Profile
, and then select theAPI Tokens
tab. - Click the
Create Token
button, and thenUse template
onEdit zone DNS
. - Edit the
Token name
field if you prefer a more descriptive name. - Under
Permissions
, theZone / DNS / Edit
permission should already be populated. Add another permission:Zone / Zone / Read
. - Under
Zone Resources
, setInclude / Specific zone / example.com
(replacingexample.com
with your domain). - Under
TTL
, set an End Date for when your token will become inactive. You might want to choose one far in the future. - Create the token and copy the token value.
Your token list should look like:
Create a file named Caddyfile
with the following content:
{$DOMAIN}:443 {
tls {
dns cloudflare {$CLOUDFLARE_API_TOKEN}
}
reverse_proxy localhost:8080
reverse_proxy /notifications/hub localhost:3012
}
Create a file named caddy.env
with the following content (replacing each value as appropriate):
DOMAIN=vw.example.com
CLOUDFLARE_API_TOKEN=<your-api-token>
Start caddy
by running
caddy run -envfile caddy.env
Start vaultwarden
by running
export ROCKET_PORT=8080
export WEBSOCKET_ENABLED=true
./vaultwarden
You should now be able to reach your vaultwarden instance at https://vw.example.com.
In the DuckDNS example above, Caddy used the lego
library to get certs via DNS challenge.
lego
also has a CLI that you can use to get certs directly, e.g. if you want to use a reverse proxy other than Caddy.
(Note: This example uses lego
, but there are other standalone ACME clients that support the DNS challenge method (see the DNS Challenge section.)
Here's an example of how to do this:
- Download a pre-built
lego
binary for your system from https://github.com/go-acme/lego/releases. Extract the contents to some directory, say,/usr/local/lego
. - From that directory, run
DUCKDNS_TOKEN=<token> ./lego -a --dns duckdns -d my-vw.duckdns.org -m me@example.com run
, substituting appropriate values for the token, domain, and email address. This registers you with Let's Encrypt and fetches a certificate for your domain. - Set up a weekly cron job to run
DUCKDNS_TOKEN=<token> ./lego --dns duckdns -d my-vw.duckdns.org -m me@example.com renew
. This renews your certificate as it nears expiration.
(Note: lego
requests ECC/ECDSA certs by default. If you are using the Rocket HTTPS server built into vaultwarden, you will need to request RSA certs instead. In the lego
commands above, add the option --key-type rsa2048
.)
In this example, the generated outputs you need to configure your reverse proxy with are:
-
/usr/local/lego/.lego/certificates/my-vw.duckdns.org.crt
(certificate) -
/usr/local/lego/.lego/certificates/my-vw.duckdns.org.key
(private key)
If you get a DNS resolution error for your subdomain (e.g., DNS_PROBE_FINISHED_NXDOMAIN
or ERR_NAME_NOT_RESOLVED
), your DNS resolver is probably blocking resolution because:
- It blocks dynamic DNS services for security reasons.
- It blocks domains that resolve to private (RFC 1918) IP addresses to prevent DNS rebinding attacks, or for some other reason.
In either case, you might try using another DNS resolver, such as Google's 8.8.8.8
or Cloudflare's 1.1.1.1
. In the second case, if you're running behind a local DNS server like dnsmasq or Unbound, you may be able to configure it to either disable DNS rebind protection entirely, or allow certain domains to return private addresses.
- Which container image to use
- Starting a container
- Updating the vaultwarden image
- Using Docker Compose
- Using Podman
- Building your own docker image
- Building binary
- Pre-built binaries
- Third-party packages
- Deployment examples
- Proxy examples
- Logrotate example
- Overview
- Disable registration of new users
- Disable invitations
- Enabling admin page
- Disable the admin token
- Enabling WebSocket notifications
- Enabling Mobile Client push notification
- Enabling U2F and FIDO2 WebAuthn authentication
- Enabling YubiKey OTP authentication
- Changing persistent data location
- Changing the API request size limit
- Changing the number of workers
- SMTP configuration
- Translating the email templates
- Password hint display
- Disabling or overriding the Vault interface hosting
- Logging
- Creating a systemd service
- Syncing users from LDAP
- Using an alternate base dir (subdir/subpath)
- Other configuration