Skip to content

Commit

Permalink
fix(acme) bump lua-resty-acme to get better error handling (#17)
Browse files Browse the repository at this point in the history
update readme to avoid confusion with plugin config
  • Loading branch information
fffonion authored Apr 24, 2020
1 parent 5797a30 commit 438ae6f
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ $ curl http://localhost:8001/plugins \
-d name=acme \
-d [email protected] \
-d config.tos_accepted=true \
-d config.domains[]=my.secret.domains.com
-d config.domains[]=my.secret.domains.com \
-d config.domains[]=my.anoother.secret.domains.com
```

Note by setting `tos_accepted` to *true* implies that you have read and accepted
Expand Down Expand Up @@ -65,7 +66,7 @@ $ curl https://mydomain.com
Name | Required | Default | Description
-------------------:|------------|------------|------------
config.account_email| Yes | | The account identifier, can be reused in different plugin instance.
config.api_uri | | `"https://acme-v02.api.letsencrypt.org"` | The ACMEv2 API endpoint to use, user might use [Let's Encrypt staging environemnt](https://letsencrypt.org/docs/staging-environment/) during testing. Kong doesn't automatically delete staging certificates, if you use same domain to test and use in production, you will need to delete those certificates manaully after test.
config.api_uri | | `"https://acme-v02.api.letsencrypt.org"` | The ACMEv2 API endpoint to use, the url should only contain root path. User might use [Let's Encrypt staging environemnt](https://letsencrypt.org/docs/staging-environment/)(`https://acme-staging-v02.api.letsencrypt.org`) during testing. Kong doesn't automatically delete staging certificates, if you use same domain to test and use in production, you will need to delete those certificates manaully after test.
config.cert_type | | `"rsa"` | The certificate type to create, choice of `"rsa"` for RSA certificate or `"ecc"` for EC certificate.
config.domains | | `[]` | The list of domains to create certificate for. To match subdomains under `example.com`, use `*.example.com`. Regex pattern is not supported. Note this config is only used to match domains, not to specify the Common Name or Subject Alternative Name to create certifcates; each domain will have its own certificate.
config.renew_threshold_days| | `14` | Days before expire to renew the certificate.
Expand Down
4 changes: 2 additions & 2 deletions kong-plugin-acme-0.2.2-1.rockspec
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
package = "kong-plugin-acme"
version = "0.2.2-1"
version = "0.2.2-2"
source = {
url = "git+https://github.com/Kong/kong-plugin-acme.git"
}
Expand All @@ -22,5 +22,5 @@ build = {
}
dependencies = {
--"kong >= 1.2.0",
"lua-resty-acme ~> 0.4"
"lua-resty-acme ~> 0.5"
}

0 comments on commit 438ae6f

Please sign in to comment.