Merge pull request #3991 from silversword411/master

docs Fixing debug info, adding mkdocs build info
This commit is contained in:
Ylian Saint-Hilaire 2022-05-16 16:55:00 -07:00 committed by GitHub
commit 26fe0c4ab4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 22 additions and 15 deletions

4
.gitignore vendored
View File

@ -309,3 +309,7 @@ __pycache__/
*.odx.cs
*.xsd.cs
.DS_Store
# When running mkdocs locally as dev
docs/__pycache__/
docs/env/

View File

@ -203,7 +203,7 @@ MeshCentral makes heavy use of Transport Layer Security (TLS) and datagram-TLS (
Probably the most important TLS configuration is for the MeshCentral server ports 443 and 4433. These two ports are exposed to the Internet and so, should be setup as securely as possible.
### MeshCentral HTTPS port 443**
### MeshCentral HTTPS port 443
The HTTPS port on the MeshCentral server will only support TLS 1.2 and above, and makes use of only 6 cypher suites:

View File

@ -80,20 +80,7 @@ You'll then have 3 files:
-rw-rw-r-- 1 tactical tactical 381 Feb 2 12:02 mesherrors.txt
```
And to make it truly log everything, change the following in meshcentral.js around line 3530.
Old:
```
obj.fs.writeSync(obj.xxLogFile, new Date().toLocaleTimeString() + ' - ' + source + ': ' + Array.prototype.slice.call(...args).join('') + '\r\n');
```
New:
```
obj.fs.writeSync(obj.xxLogFile, new Date().toLocaleTimeString() + ' - ' + source + ': ' + args.join(' ') + '\r\n');
```
`log.txt` will now log everything in the Trace tab, but not formatted as nice.
`log.txt` will now log everything in the Trace tab
## Restricting server to specific IP(s)

16
docs/startdevmkdocs.ps1 Normal file
View File

@ -0,0 +1,16 @@
# This is for running mkdocs locally on windows only.
# Make sure you change directory to your docs folder before starting this process
#Activate python
python -m venv env
.\env\Scripts\activate
#Install requirements first time only
python -m pip install --upgrade pip #only 1st time
pip install pytest #only 1st time
pip install mkdocs #only 1st time
pip install mkdocs-material #only 1st time
#Run mkdocs and look at changes as you make them
mkdocs serve
start http://localhost:8010 #Opens Browser