From 1e7fabf511385502675974ad4f8792d9d792b60a Mon Sep 17 00:00:00 2001 From: silversword411 Date: Thu, 15 Sep 2022 17:07:00 -0400 Subject: [PATCH 1/4] docs - adding json notes to FAQ https://github.com/Ylianst/MeshCentral/issues/4551 --- docs/docs/meshcentral/faq.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/docs/meshcentral/faq.md b/docs/docs/meshcentral/faq.md index f1e6e321..421b9977 100644 --- a/docs/docs/meshcentral/faq.md +++ b/docs/docs/meshcentral/faq.md @@ -1,5 +1,23 @@ # FAQ +## json config files + +Any item in the config.json file starting with an underscore character are ignored. + +Ignored + +```json +"_title": "MyServer" +``` + +Valid setting + +```json +"title": "MyServer" +``` + +json requires correct formatting, if in doubt copy/paste your json config into a web based format checker to make sure you have it right: + ## Help! I've been hacked there are weird agents appearing in my MeshCentral Console No, you haven't. From 35fc2fd41072e7700b8d6571f8597e8287bf302f Mon Sep 17 00:00:00 2001 From: silversword411 Date: Thu, 15 Sep 2022 17:44:46 -0400 Subject: [PATCH 2/4] docs - using more space on large screens for content --- docs/docs/stylesheets/extra.css | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/docs/stylesheets/extra.css b/docs/docs/stylesheets/extra.css index ef3b6050..721e0b33 100644 --- a/docs/docs/stylesheets/extra.css +++ b/docs/docs/stylesheets/extra.css @@ -1,3 +1,8 @@ +/* Maximum space for text block */ +.md-grid { + max-width: 95%; /* or 100%, if you want to stretch to full-width */ + } + .md-header { background-color: #0b3e81 !important; color: white !important; From e84c79fa279aec1b64278b9dce56a589b8ff6be5 Mon Sep 17 00:00:00 2001 From: silversword411 Date: Thu, 15 Sep 2022 17:45:19 -0400 Subject: [PATCH 3/4] docs - missing link --- docs/docs/install/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/install/index.md b/docs/docs/install/index.md index f278b4b9..59e7b8da 100644 --- a/docs/docs/install/index.md +++ b/docs/docs/install/index.md @@ -9,7 +9,7 @@ npm install meshcentral node node_modules/meshcentral ``` -That's it. MeshCentral will set itself up and start managing computers on your local network. By default it will be setup in LAN mode and agents you install will multicast on the local network to find the server. To setup the server so that agents use a well known DNS name and to start customizing your server, go in the "meshcentral-data" folder and edit the config.json file. The configuration file must be valid JSON, you can use this link to validate the file format. +That's it. MeshCentral will set itself up and start managing computers on your local network. By default it will be setup in LAN mode and agents you install will multicast on the local network to find the server. To setup the server so that agents use a well known DNS name and to start customizing your server, go in the "meshcentral-data" folder and edit the config.json file. The configuration file must be valid JSON, you can use this [link](https://duckduckgo.com/?va=j&t=hc&q=json+lint&ia=answer) to validate the file format. For Windows users, you can download the MeshCentral Installer that will automate installation of NodeJS and provide basic configuration of the server. This option is not recommended for advanced users. From 2fff692eaecc4a202ab340dd4482e58933e1ee43 Mon Sep 17 00:00:00 2001 From: silversword411 Date: Thu, 15 Sep 2022 17:45:46 -0400 Subject: [PATCH 4/4] docs - simplifying ssl LE instructions --- docs/docs/meshcentral/SSLnletsencrypt.md | 32 +++++++++++++++++++----- 1 file changed, 26 insertions(+), 6 deletions(-) diff --git a/docs/docs/meshcentral/SSLnletsencrypt.md b/docs/docs/meshcentral/SSLnletsencrypt.md index 03e653e8..742682a9 100644 --- a/docs/docs/meshcentral/SSLnletsencrypt.md +++ b/docs/docs/meshcentral/SSLnletsencrypt.md @@ -2,16 +2,36 @@ ## MeshCentral supports SSL using self generated certs, your own certs or Letsencrypt -### To enable Letsencrypt do the following in your config.json file: +### Enabling letsencrypt -1. Under Settings, change `"_redirPort"` to `"redirPort"` and `"_cert" to `"cert": "yourdomain.com", -2. Under letsencrypt change `"_letsencrypt"` to `"letsencrypt"`, enter your email address at `"email"` and yourdomain.com for `"names"` and change `"production"` to true. -3. Restart meshcentral and it will get a cert for you, the process will need to restart to apply the cert. +Make sure you match and/or adjust all the following settings appropriately in your config.json file: + +```json +{ + "settings": { + "redirPort" + "cert": "yourdomain.com" + }, + "domains": { + "letsencrypt": { + "__comment__": "Requires NodeJS 8.x or better, Go to https://letsdebug.net/ first before trying Let's Encrypt.", + "email": "myemail@myserver.com", + "names": "myserver.com,customer1.myserver.com", + "skipChallengeVerification": false, + "production": true + }, + } +} +``` + +If you need further clarification to know what each of these settings are + +Then restart meshcentral and it will get a cert for you, the process will need to restart to apply the cert. ### Useful resources/troubleshooting -To check letsencrypt is working properly please use https://letsdebug.net/ +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. -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. +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. You can read more about Letsencrypt and meshcentral [here](https://ylianst.github.io/MeshCentral/meshcentral/#lets-encrypt-support).