@cryptotaxi247 / MeshCentral / commits / c779ab1c

docs - classifying codeblocks

silversword411 committed May 23, 2022 at 22:33 UTC c779ab1c31cd6679ef49bd29378d2ff775838e1c

5 files changed +25 -25

docs/docs/install/install2.md

+4 -4

@@ -324,7 +324,7 @@ nano ~/meshcentral-data/config.json

324

325 Then, make the start of the file look like this:

326

327 -```

327 +```json

328 {

329 "settings": {

330 "MongoDb": "mongodb://127.0.0.1:27017/meshcentral",

@@ -530,7 +530,7 @@ pico ~/meshcentral-data/config.json

530

531 Then, make the start of the file look like this:

532

533 -```

533 +```json

534 {

535 "settings": {

536 "LANonly": true,

@@ -754,7 +754,7 @@ pico ~/meshcentral-data/config.json

754

755 Then, make the start of the file look like this:

756

757 -```

757 +```json

758 {

759 "settings": {

760 "MongoDb": "mongodb://127.0.0.1:27017/meshcentral",

@@ -1072,7 +1072,7 @@ vi /usr/local/meshcentral/meshcentral-data/config.json

1072

1073 In the settings section, set the following key value pairs:

1074

1075 -```

1075 +```json

1076 {

1077 "settings": {

1078 "Cert": "meshcentral.example.com",

docs/docs/intelamt/index.md

+2 -2

@@ -103,7 +103,7 @@ The leaf certificate will have the Intel AMT activation option and a specific do

103

104 If you have a certificate chain in a .pfx or .p12 format, place that file in the “meshcentral-data” folder and add the “AmtAcmActivation” section in the domain section like so:

105

106 -```

106 +```json

107 {

108 "settings": {

109 "Cert": "devbox.mesh.meshcentral.com",

@@ -126,7 +126,7 @@ If you have a certificate chain in a .pfx or .p12 format, place that file in the

126

127 If you have the certificate chain in PEM format as a set of .crt files and a .key file, start by placing all of the certificate files in the “meshcentral-data” folder and setup the certificate chain like this:

128

129 -```

129 +```json

130 {

131 "settings": {

132 "Cert": "devbox.mesh.meshcentral.com",

docs/docs/meshcentral/index.md

+16 -16

@@ -2,7 +2,7 @@

3 [MeshCentral2 Guide](https://meshcentral.com/info/docs/MeshCentral2UserGuide.pdf)

5 -MeshCmd Guide [as .pdf](https://meshcentral.com/info/docs/MeshCmdUserGuide.pdf) [as .odt](https://github.com/Ylianst/MeshCentral/blob/master/docs/MeshCmd User's Guide v0.0.3.odt?raw=true)

5 +MeshCmd Guide [as .pdf](https://meshcentral.com/info/docs/MeshCmdUserGuide.pdf) [as .odt](https://github.com/Ylianst/MeshCentral/blob/master/docs/MeshCentral User's Guide v0.2.9.odt?raw=true)

7 ## Video Walkthru

@@ -478,7 +478,7 @@ MeshCentral makes use of HTTPS to authenticate and encrypt management traffic ov

478

479 Before moving forward with this section, make sure your MeshCentral server is working correctly, has a domain name pointing to it and that the HTTP redirection server on port 80 is enabled and working. MeshCentral’s HTTP port 80 server will be used in the process to prove to Let’s Encrypt that we have control over the domain. At any point, you may try to use https://letsdebug.net/ to see if your domain is setup correctly and/or debug any issues. When ready, add the “letsencrypt” section to the config.json file like this:

480

481 -```

481 +```json

482 {

483 "settings": {

484 "RedirPort": 80,

@@ -553,7 +553,7 @@ The password recovery flow when “Reset Account” is triggered at the login pa

553

554 Both account verification and password recovery are triggered automatically once SMTP mail server configuration is included into the config.json file. Update the config.json with “smtp” section as shown below and restart the server.

555

556 -```

556 +```json

557 {

558 "smtp": {

559 "host": "smtp.server.com",

@@ -603,7 +603,7 @@ With login tokens feature, a token can be generated to be used for a short time

603

604 To enable this feature, configure config.json file to allow login tokens.

605

606 -```

606 +```json

607 {

608 "settings": {

609 "allowLoginToken": true,

@@ -712,7 +712,7 @@ In this example, we will:

712

713 Let’s get started by configuring MeshCentral with the following values in config.json:

714

715 -```

715 +```json

716 {

717 "settings": {

718 "Cert": "myservername.domain.com"

@@ -886,7 +886,7 @@ In this example, we will:

886

887 First we will start with the MeshCentral configuration, here is a minimal configuration that will work:

888

889 -```

889 +```json

890 {

891 "settings": {

892 "Cert": "myservername.domain.com"

@@ -1016,7 +1016,7 @@ backend meshcentral

1016 On the MeshCentral side, we are not going to use port 80 and need the main HTTPS port to not perform TLS and listen on port 444.

1017

1018

1019 -```

1019 +```json

1020 {

1021 "settings": {

1022 "Cert": "myservername.domain.com"

@@ -1182,7 +1182,7 @@ node node_modules/meshcentral --vault http://127.0.0.1:8200 --token s.cO4… --u

1182

1183 MeshCentral will first read all of the files from Vault and get started. An alternative to this is to create a very small config.json file in “meshcentral-data” that contains only the Vault configuration like this:

1184

1185 -```

1185 +```json

1186 {

1187 "settings": {

1188 "vault": {

@@ -1225,7 +1225,7 @@ The additional encryption does the affect database operations and can be used in

1225

1226 Only some data fields are encrypted and the “_CRYPT” entry will only be present when one or more fields are present that need to be secured. To enable this feature, add the “DbRecordsEncryptKey” with a password string to the “settings” section of the config.json like this:

1227

1228 -```

1228 +```json

1229 {

1230 "settings": {

1231 "Port": 4430,

@@ -1243,7 +1243,7 @@ node node_modules/meshcentral --recordencryptionrecode

1243

1244 This command will re-write entries in the database that could require added security and force the application of record encryption. You can also specify a key for decryption only like this:

1245

1246 -```

1246 +```json

1247 {

1248 "settings": {

1249 "Port": 4430,

@@ -1299,7 +1299,7 @@ Once the new application is created, go to the “Keys and tokens” tab. You wi

1299

1300 Once done, your config.json should look a bit like this:

1301

1302 -```

1302 +```json

1303 {

1304 "settings": {

1305 "Cert": "myserver.mydomain.com",

@@ -1330,7 +1330,7 @@ Note that if you do not allow new accounts, any new users that use Twitter crede

1330

1331 The exact same process as shown in the previous section can be repeated for Google, GitHub and Reddit. In each case, you need to go to each respective credential provider and get a “ClientID” and “ClientSecret” for each service. You also need to register the correct callback URL for each service. Take a look at the config.json below and note the callback URL that will need to be registered for each service provider.

1332

1333 -```

1333 +```json

1334 {

1335 "settings": {

1336 "Cert": "myserver.mydomain.com",

@@ -1391,7 +1391,7 @@ Next, we need to create a secret that will be shared between Azure and MeshCentr

1391

1392 We then copy the resulting secret and this will be the 3rd and final value we need to get MeshCentral setup. Now, we take the application ID, tenant ID and secret and place these values in the MeshCentral config.json like so:

1393

1394 -```

1394 +```json

1395 {

1396 "settings": {

1397 "Cert": "myserver.mydomain.com",

@@ -1458,7 +1458,7 @@ We are now almost done with JumpCloud. The last thing we need to do is download

1458

1459 Save the certificate as “jumpcloud-saml.pem” and place it in the “meshcentral-data” folder. You are now ready to configure MeshCentral. Edit the config.json and make it look like this:

1460

1461 -```

1461 +```json

1462 {

1463 "settings": {

1464 "Cert": "myserver.mydomain.com",

@@ -1498,7 +1498,7 @@ In this section, we look at configuring SAML with a generic authentication provi

1498

1499 A generic SAML setup will look like this:

1500

1501 -```

1501 +```json

1502 {

1503 "settings": {

1504 "Cert": "myserver.mydomain.com",

@@ -1574,7 +1574,7 @@ MeshCentral and this document are both opens source and licensed using Apache 2.

1574

1575 In this annex, we present a complete sample config.json file. You would put this file in the “meshcentral-data” folder that is created when MeshCentral is first run. The config.json is completely optional and the server will run with default values with it. All key names in this file are case insensitive.

1576

1577 -```

1577 +```json

1578 {

1579 "settings": {

1580 "MongoDb": "mongodb://127.0.0.1:27017/meshcentral",

docs/docs/meshcmd/index.md

+1 -1

@@ -98,7 +98,7 @@ To get started, click on a device in MeshCentral and click on the “Router” l

99 You can download MeshCmd is you have not done so already, but more importantly, download the action.txt file. The file is in text format and contain something like this:

100

101 -```

101 +```json

102 {

103 "action": "route",

104 "localPort": 1234,  Change this

docs/docs/meshctrl/index.md

+2 -2

@@ -123,7 +123,7 @@ This technique needs some setup, but allows MeshCtrl to login as any account wit

123

124 In this technique, we will get a special encryption key from the server and use this to generate a login token to the server. First, we must activate the login token feature of the server by setting “AllowLoginToken” to “true” in the “settings” section of config.json:

125

126 -```

126 +```json

127 {

128 "settings": {

129 "Port": 443,

@@ -199,7 +199,7 @@ node ./node_modules/meshcentral/meshctrl serverinfo –-loginkeyfile key.txt --u

199

200 So, we add both the url to access the correct domain and the domain name explicitly. The domain name must be exactly the one that is used in the domain section of the config.json for of MeshCentral. For example, if the MeshCentral config.json file looks like this:

201

202 -```

202 +```json

203 {

204 "settings": {

205 "Cert": "myserver.com",