BREAKING CHANGE(smartacme): Make wildcard certificates opt-in to fix HTTP-01 only configurations
This commit is contained in:
10
readme.md
10
readme.md
@@ -196,8 +196,13 @@ async function main() {
|
||||
await smartAcmeInstance.start();
|
||||
|
||||
const myDomain = 'example.com';
|
||||
// Get certificate for domain (no wildcard)
|
||||
const myCert = await smartAcmeInstance.getCertificateForDomain(myDomain);
|
||||
console.log('Certificate:', myCert);
|
||||
|
||||
// Get certificate with wildcard (requires DNS-01 handler)
|
||||
const certWithWildcard = await smartAcmeInstance.getCertificateForDomain(myDomain, { includeWildcard: true });
|
||||
console.log('Certificate with wildcard:', certWithWildcard);
|
||||
|
||||
await smartAcmeInstance.stop();
|
||||
}
|
||||
@@ -306,7 +311,10 @@ The certificate object obtained from the `getCertificateForDomain` method has th
|
||||
|
||||
- **start()**: Initializes the SmartAcme instance, sets up the ACME client, and registers the account with Let's Encrypt.
|
||||
- **stop()**: Closes the MongoDB connection and performs any necessary cleanup.
|
||||
- **getCertificateForDomain(domainArg: string)**: Retrieves or obtains a certificate for the specified domain name. If a valid certificate exists in the database, it is returned. Otherwise, a new certificate is requested and stored.
|
||||
- **getCertificateForDomain(domainArg: string, options?: { includeWildcard?: boolean })**: Retrieves or obtains a certificate for the specified domain name. If a valid certificate exists in the database, it is returned. Otherwise, a new certificate is requested and stored.
|
||||
- By default, only a certificate for the exact domain is requested
|
||||
- Set `includeWildcard: true` to also request a wildcard certificate (requires DNS-01 handler)
|
||||
- When requesting a wildcard directly (e.g., `*.example.com`), only the wildcard certificate is requested
|
||||
|
||||
### Handling Domain Matching
|
||||
|
||||
|
||||
Reference in New Issue
Block a user