Skip to content

Commit

Permalink
Merge pull request #4553 from silversword411/master
Browse files Browse the repository at this point in the history
docs - json, adjusting max width, missing link and SSL LE improvements
  • Loading branch information
Ylianst committed Sep 15, 2022
2 parents d02f72e + 2fff692 commit b51108a
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/docs/install/index.md
Expand Up @@ -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.

Expand Down
32 changes: 26 additions & 6 deletions docs/docs/meshcentral/SSLnletsencrypt.md
Expand Up @@ -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).
18 changes: 18 additions & 0 deletions 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: <https://duckduckgo.com/?va=j&t=hc&q=json+lint&ia=answer>

## Help! I've been hacked there are weird agents appearing in my MeshCentral Console

No, you haven't.
Expand Down
5 changes: 5 additions & 0 deletions 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;
Expand Down

0 comments on commit b51108a

Please sign in to comment.