You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+22-12Lines changed: 22 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,18 @@
1
-
# Lets Encrypt ACME Client
1
+
# LetsEncrypt! ACME Client
2
2
3
-
Automatically Issue and Renew `Let's Encrypt Certificates` (ACMEv2) using `DNS-01` or `HTTP-01`
4
-
5
-
Utilizes a `Daemon` that operates periodically alongside a `Mixin` to handle challenge completions.
3
+
Automatically Create and Renew `LetsEncrypt! SSL Certificates`, including `Wildcard Certificates` for supported `DNS Providers`
6
4
7
5
### Getting Started
8
6
9
-
You can view the full [`SSL Server Example`](https://github.com/FirstTimeEZ/server-ssl) to understand the `Daemon` and `Mixin`
7
+
This most recent version of this package is implemented in [`SSL Server`](https://github.com/FirstTimeEZ/server-ssl)and you can use that to understand how it works if the `jsdoc` isn't enough information.
10
8
11
9
### Wild Card Certificates
12
10
13
-
You can generate `Wild Card Certificates` if you use a supported `DNS-01` provider
11
+
You can generate `Wild Card Certificates` if you are using a supported `DNS Provider`
14
12
15
-
At this present moment that is only `Cloud Flare`
13
+
| Supported DNS Providers |
14
+
|-------------------------|
15
+
| Cloud Flare |
16
16
17
17
```
18
18
let dnsProvider = {
@@ -22,15 +22,17 @@ let dnsProvider = {
22
22
}
23
23
```
24
24
25
+
`DNS Providers` are used to complete `DNS-01` challenges
26
+
25
27
--------
26
28
27
-
### Daemon
29
+
### LetsEncrypt! Daemon
28
30
29
-
The `Daemon` runs periodically to Issue or Renew the certificate
31
+
The `Daemon` runs periodically to `Create` or `Renew` the `Certificate`
30
32
31
33
```javascript
32
34
/**
33
-
* Starts the Let's Encrypt Daemon to Manage the SSL Certificate for the Server
35
+
* Starts the LetsEncrypt! Daemon to Manage the SSL Certificate for the Server
34
36
*
35
37
* @param{Array<string>}fqdns - The fully qualified domain names as a SAN (e.g., ["example.com", "www.example.com"]), You must use a `dnsProvider` if you include a wild card
36
38
* @param{string}sslPath - The path where your acme account, keys and generated certificate will be stored or loaded from
@@ -51,10 +53,12 @@ The `Daemon` runs periodically to Issue or Renew the certificate
* Starts the Let's Encrypt Daemon to Manage the SSL Certificate for the Server
83
+
* Starts the LetsEncrypt! Daemon to Manage the SSL Certificate for the Server
84
84
*
85
85
* @param {Array<string>} fqdns - The fully qualified domain names as a SAN (e.g., ["example.com", "www.example.com"]), You must use a `dnsProvider` if you include a wild card
86
86
* @param {string} sslPath - The path where your acme account, keys and generated certificate will be stored or loaded from
Copy file name to clipboardExpand all lines: package.json
+12-3Lines changed: 12 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
{
2
2
"name": "lets-encrypt-acme-client",
3
3
"author": "FirstTimeEZ",
4
-
"version": "40.0.1",
5
-
"description": "Automatically Issue and Renew Let's Encrypt Certificates by utilizing a Daemon that operates periodically alongside a Mixin to handle challenge completions. (ACMEv2)",
4
+
"version": "40.0.2",
5
+
"description": "Automatically Create and Renew LetsEncrypt! SSL Certificates, including Wildcard Certificates for supported DNS Providers",
0 commit comments