diff --git a/docs/docs/meshcentral/SSLnletsencrypt.md b/docs/docs/meshcentral/SSLnletsencrypt.md new file mode 100644 index 0000000000..03e653e831 --- /dev/null +++ b/docs/docs/meshcentral/SSLnletsencrypt.md @@ -0,0 +1,17 @@ +# SSL/Letsencrypt + +## MeshCentral supports SSL using self generated certs, your own certs or Letsencrypt + +### To enable Letsencrypt do the following in your config.json file: + +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. + +### Useful resources/troubleshooting + +To check letsencrypt is working properly please use https://letsdebug.net/ + +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. + +You can read more about Letsencrypt and meshcentral [here](https://ylianst.github.io/MeshCentral/meshcentral/#lets-encrypt-support). diff --git a/docs/docs/faq.md b/docs/docs/meshcentral/faq.md similarity index 61% rename from docs/docs/faq.md rename to docs/docs/meshcentral/faq.md index cc4a5ff7f7..f1e6e32138 100644 --- a/docs/docs/faq.md +++ b/docs/docs/meshcentral/faq.md @@ -1,6 +1,6 @@ # FAQ -## Help! I've been hacked there are weird agents appearing in my Tactical RMM +## Help! I've been hacked there are weird agents appearing in my MeshCentral Console No, you haven't. @@ -14,7 +14,7 @@ No, you haven't. 4. They ran it against their virtualization testing cluster. -5. You allow anyone to connect to your rmm server (you should look into techniques to hide your server from the internet). +5. You allow anyone to connect to your server (you should look into techniques to hide your server from the internet). 6. Here are some examples of what that looks like. @@ -25,3 +25,8 @@ You're sure you're typing in everything right, giving it 2FA code and can't logi [TOTP](https://en.wikipedia.org/wiki/Time-based_one-time_password) is time sensitive, check your time/NTP and make sure it's right (on server and TOTP app device)! :) ![](images/2022-08-04-18-19-19.png) + +# Branding and Customisation + +You can brand and customise MeshCentral almost as much as you like without delving into the code, a few changes in the config.json file and uplaoding images can change the way your system looks. Read more [here](https://ylianst.github.io/MeshCentral/meshcentral/#branding-terms-of-use) + diff --git a/docs/docs/images/faq_av_option1.png b/docs/docs/meshcentral/images/faq_av_option1.png similarity index 100% rename from docs/docs/images/faq_av_option1.png rename to docs/docs/meshcentral/images/faq_av_option1.png diff --git a/docs/docs/tipsntricks.md b/docs/docs/meshcentral/tipsntricks.md similarity index 100% rename from docs/docs/tipsntricks.md rename to docs/docs/meshcentral/tipsntricks.md diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index daa840e812..23285be2da 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -15,9 +15,12 @@ nav: - 'Debugging': 'meshcentral/debugging.md' - 'Device Tabs': 'meshcentral/devicetabs.md' - 'Plugins': 'meshcentral/plugins.md' + - 'SSL': 'meshcentral/SSLnletsencrypt.md' - 'Security': 'meshcentral/security.md' - 'Tokens': 'meshcentral/tokens.md' - + - 'FAQ': 'meshcentral/faq.md' + - 'Tips n Tricks': 'meshcentral/tipsntricks.md' + - Design and Architecture: - design/index.md