From bdf6ce9cef0e673f67bffc4eb58a0f3e7e3286bc Mon Sep 17 00:00:00 2001
From: Christophe Jaillet MDStoreDir
)
- and provide it, on next restart, to mod_ssl.
+ and provide it, on next restart, to mod_ssl
.
This happens while the server is already running. All other hosts will continue to work as before. While a certificate is not available, requests for the managed @@ -152,7 +152,7 @@
Description: | Type of ACME challenge used to prove domain ownership. | ||
---|---|---|---|
Syntax: | MDCAChallenges name [ name ... ] | ||
Syntax: | MDCAChallenges name [ name ... ] | ||
Default: | MDCAChallenges tls-sni-01 http-01 | ||
Context: | server config | ||
Status: | Extension |
Description: | The URL of the Terms-of-Service document, that the CA server requires you to accept. | ||
---|---|---|---|
Syntax: | MDCertificateAgreement url-of-terms-of-service | ||
Syntax: | MDCertificateAgreement url-of-terms-of-service | ||
Context: | server config | ||
Status: | Extension | ||
Module: | mod_md |
Description: | The URL of the ACME Certificate Authority service. | ||
---|---|---|---|
Syntax: | MDCertificateAuthority url | ||
Syntax: | MDCertificateAuthority url | ||
Default: | MDCertificateAuthority https://acme-v01.api.letsencrypt.org/directory | ||
Context: | server config | ||
Status: | Extension |
Description: | The protocol to use with the Certificate Authority. | ||
---|---|---|---|
Syntax: | MDCertificateProtocol protocol | ||
Syntax: | MDCertificateProtocol protocol | ||
Default: | MDCertificateProtocol ACME | ||
Context: | server config | ||
Status: | Extension |
Description: | Define a proxy for outgoing connections. | ||
---|---|---|---|
Syntax: | MDHttpProxy url | ||
Syntax: | MDHttpProxy url | ||
Context: | server config | ||
Status: | Extension | ||
Module: | mod_md |
Description: | Additional hostname for the managed domain. |
---|---|
Syntax: | MDMember hostname |
Syntax: | MDMember hostname |
Context: | server config |
Status: | Extension |
Module: | mod_md |
Instead of listing all dns names on the same line, you may use
- MDMember
to add such names
+ MDMember
to add such names
to a managed domain.
<MDomainSet example.org> @@ -320,7 +320,7 @@ MDCertificateAgreement https://letsencrypt.org/documents/LE-SA-v1.2-November-15-Defines if newly requested certificate should have the OCSP Must Staple flag set or not. If a certificate has this flag, the server is required to send a OCSP stapling response to every client. This only works if you configure - mod_ssl to generate this (see
@@ -329,7 +329,7 @@ MDCertificateAgreement https://letsencrypt.org/documents/LE-SA-v1.2-November-15-SSLUseStapling
+mod_ssl
to generate this (seeSSLUseStapling
and friends).MDNotifyCmd Directive
- Description: Run a program when Managed Domain are ready. + Syntax: MDNotifyCmd path
Syntax: MDNotifyCmd path
Context: server config Status: Extension @@ -352,7 +352,7 @@ MDCertificateAgreement https://letsencrypt.org/documents/LE-SA-v1.2-November-15- Module: mod_md All the names in the list are managed as one Managed Domain (MD). - mod_md will request one single certificate that is valid for all these names. This +
mod_md
will request one single certificate that is valid for all these names. This directive uses the global settings (see other MD directives below). If you need specific settings for one MD, use the<MDomainSet>
. @@ -417,7 +417,7 @@ MDomain example2.org auto In this example, the domain 'www.example.org' is automatically added to the MD 'example.org'. Similarly for 'example2.org' where 'auto' is configured explicitly. Whenever you add more ServerAlias names to this - virtual host, they will be added as well to the Manged Domain. + virtual host, they will be added as well to the Managed Domain.If you prefer to explicitly declare all the domain names, use 'manual' mode. An error will be logged if the names do not match with the expected ones. @@ -454,14 +454,14 @@ MDomain example2.org auto
MDPortMap Directive
- Description: Map external to internal ports for domain ownership verification. + Syntax: MDPortMap map1 [ map2 ]
Syntax: MDPortMap map1 [ map2 ]
Default: MDPortMap 80:80 443:443
Context: server config Status: Extension Module: mod_md - The ACME protocol provides two method to verify domain ownership: one that uses + The ACME protocol provides two methods to verify domain ownership: one that uses port 80 and one for port 443. If your server is not reachable by at least one of the two, ACME will not work for you.
@@ -474,8 +474,8 @@ MDomain example2.org auto another one. Your server might only listen on ports 5001 and 5002, but be reached on ports 443 and 80. How should
mod_md
figure that one out?- With MDPortMap you can tell it which 'Internet port' corresponds to which local - port. + With
MDPortMap
you can tell it which 'Internet port' + corresponds to which local port.@@ -489,7 +489,7 @@ MDomain example2.org autoExample
MDPortMap 80:- 443:5002MDPrivateKeys Directive
- Description: Set type and size of the private keys generated. + Syntax: MDPrivateKeys type [ params... ]
Syntax: MDPrivateKeys type [ params... ]
Default: MDPrivateKeys RSA 2048
Context: server config @@ -520,17 +520,17 @@ MDomain example2.org auto Status: Extension MDRenewWindow Directive
- Description: Control when a certificate will be renewed. + Syntax: MDRenewWindow duration
Syntax: MDRenewWindow duration
Default: MDRenewWindow 33%
Context: server config Status: Extension Module: mod_md - If the validity of the certificate falls below duration, mod_md will get a - new signed certificate. + If the validity of the certificate falls below duration,
mod_md
+ will get a new signed certificate.- Normally, certificates are valid for around 90 days and mod_md will renew + Normally, certificates are valid for around 90 days and
mod_md
will renew them the earliest 33% of their complete lifetime before they expire (so for 90 days validity, 30 days before it expires). If you think this is not what you need, you can specify either the exact time, as in: @@ -591,10 +591,11 @@ MDRenewWindow 10% you cannot simply take it back again. -You can achieve the same with mod_alias and some Redirect configuration, +
You can achieve the same with
mod_alias
and some +Redirect
configuration, basically. If you do it yourself, please make sure to exclude the paths - /.well-known/* from your redirection, otherwise mod_md might have trouble - signing on new certificates. + /.well-known/* from your redirection, otherwisemod_md
+ might have trouble signing on new certificates.If you set this globally, it applies to all managed domains. If you want it for a specific domain only, use: diff --git a/docs/manual/mod/quickreference.html.en b/docs/manual/mod/quickreference.html.en index 705e8017fa..1f5390c29b 100644 --- a/docs/manual/mod/quickreference.html.en +++ b/docs/manual/mod/quickreference.html.en @@ -673,21 +673,21 @@ simultaneously
MaxSpareThreads number s M Maximum number of idle threads MaxThreads number 2048 s M Set the maximum number of worker threads MDBaseServer on|off off s E - Control if base server may be managed or only virtual hosts. MDCAChallenges name [ name ... ] tls-sni-01 http-01 s E - Type of ACME challenge used to prove domain ownership. MDCertificateAgreement url-of-terms-of-service s E - The URL of the Terms-of-Service document, that the CA server requires you to accept. MDCertificateAuthority url https://acme-v01.ap + s E - The URL of the ACME Certificate Authority service. MDCertificateProtocol protocol ACME s E + The protocol to use with the Certificate Authority. MDCAChallenges name [ name ... ] tls-sni-01 http-01 s E + Type of ACME challenge used to prove domain ownership. MDCertificateAgreement url-of-terms-of-service s E + The URL of the Terms-of-Service document, that the CA server requires you to accept. MDCertificateAuthority url https://acme-v01.ap + s E + The URL of the ACME Certificate Authority service. MDCertificateProtocol protocol ACME s E The protocol to use with the Certificate Authority. MDDriveMode always|auto|manual auto s E - Control when it is allowed to obtain/renew certificates. MDHttpProxy url s E - Define a proxy for outgoing connections. MDMember hostname s E + Additional hostname for the managed domain. MDHttpProxy url s E + Define a proxy for outgoing connections. MDMember hostname s E Additional hostname for the managed domain. MDMembers auto|manual auto s E Control if the alias domain names are automatically added. MDMustStaple on|off off s E - Control if new certificates carry the OCSP Must Staple flag. MDNotifyCmd path s E + Run a program when Managed Domain are ready. MDNotifyCmd path s E Run a program when Managed Domain are ready. MDomain dns-name [ other-dns-name... ] [auto|manual] s E Define list of domain names that belong to one group. <MDomainSet dns-name [ other-dns-name... ]>...</MDomainSet> s E - Container for directives applied to the same managed domains. MDPortMap map1 [ map2 ] 80:80 443:443 s E - Map external to internal ports for domain ownership verification. MDPrivateKeys type [ params... ] RSA 2048 s E - Set type and size of the private keys generated. MDRenewWindow duration 33% s E + Control when a certificate will be renewed. MDPortMap map1 [ map2 ] 80:80 443:443 s E + Map external to internal ports for domain ownership verification. MDPrivateKeys type [ params... ] RSA 2048 s E + Set type and size of the private keys generated. MDRenewWindow duration 33% s E Control when a certificate will be renewed. MDRequireHttps off|temporary|permanent off s E Redirects http: traffic to https: for Managed Domains. MDStoreDir path md s E Path on the local file system to store the Managed Domains data. MemcacheConnTTL num[units] 15s sv E -- 2.40.0 Keepalive time for idle connections