docs - simplifying ssl LE instructions
silversword411 committed
Sep 15, 2022 at 17:45 UTC
2fff692eaecc4a202ab340dd4482e58933e1ee43
1 file changed
+26
-6
docs/docs/meshcentral/SSLnletsencrypt.md
+26
-6
@@ -2,16 +2,36 @@
2
3
## MeshCentral supports SSL using self generated certs, your own certs or Letsencrypt
4
5
-### To enable Letsencrypt do the following in your config.json file:
5
+### Enabling letsencrypt
6
7
-1. Under Settings, change `"_redirPort"` to `"redirPort"` and `"_cert" to `"cert": "yourdomain.com",
8
-2. Under letsencrypt change `"_letsencrypt"` to `"letsencrypt"`, enter your email address at `"email"` and yourdomain.com for `"names"` and change `"production"` to true.
9
-3. Restart meshcentral and it will get a cert for you, the process will need to restart to apply the cert.
7
+Make sure you match and/or adjust all the following settings appropriately in your config.json file:
8
+
9
+```json
10
+{
11
+ "settings": {
12
+ "redirPort"
13
+ "cert": "yourdomain.com"
14
+ },
15
+ "domains": {
16
+ "letsencrypt": {
17
+ "__comment__": "Requires NodeJS 8.x or better, Go to https://letsdebug.net/ first before trying Let's Encrypt.",
18
+ "email": "myemail@myserver.com",
19
+ "names": "myserver.com,customer1.myserver.com",
20
+ "skipChallengeVerification": false,
21
+ "production": true
22
+ },
23
+ }
24
+}
25
+```
26
+
27
+If you need further clarification to know what each of these settings are
28
+
29
+Then restart meshcentral and it will get a cert for you, the process will need to restart to apply the cert.
30
31
### Useful resources/troubleshooting
32
13
-To check letsencrypt is working properly please use https://letsdebug.net/
33
+To check letsencrypt is working properly please use https://letsdebug.net/. We are using the [HTTP-O1 challenge](https://letsencrypt.org/docs/challenge-types/#http-01-challenge) method with these instructions.
34
15
-Also make sure you have port 80 open and pointing to your meshcentral server, IT WILL NOT work if port 80 isnt open and it HAS to be port 80.
35
+Also make sure you have port 80 open and pointing to your meshcentral server, **IT WILL NOT WORK** if port 80 isn't open and it **HAS** to be port 80.
36
37
You can read more about Letsencrypt and meshcentral [here](https://ylianst.github.io/MeshCentral/meshcentral/#lets-encrypt-support).