Docs - fixing debugging, adding token notes

silversword411 committed May 12, 2022 at 02:05 UTC 50bbfafcb9a1e8ad19433aebf8a7a2c52d62d18f
6 files changed +34 -6
docs/docs/meshcentral/debugging.md
+13 -4
@@ -1,4 +1,10 @@
1 -Youtube video about websockets: https://youtu.be/3vI4URd3VzU
1 +## Websockets Video
2 +
3 +<div class="video-wrapper">
4 + <iframe width="320" height="180" src="https://www.youtube.com/embed/3vI4URd3VzU" frameborder="0" allowfullscreen></iframe>
5 +</div>
6 +
7 +## Enabling trace in your browser Dev Tools
8
9 `Trace=1` as a parameter in chrome dev tools for debugging
10
@@ -26,7 +32,7 @@ If you want to change node to meshcentral in journalctl, add this to /etc/system
32 SyslogIdentifier=meshcentral
33 ```
34
29 -## Logging it all
35 +## Server: Logging it all
36
37 To log everything that's possible, prepare the log directory.
38
@@ -89,6 +95,8 @@ obj.fs.writeSync(obj.xxLogFile, new Date().toLocaleTimeString() + ' - ' + source
95
96 `log.txt` will now log everything in the Trace tab, but not formatted as nice.
97
98 +## Restricting server to specific IP(s)
99 +
100 When doing debugging on my development server, I use this line in the settings section to block all agent connections except the agent I want:
101
102 ```
@@ -97,9 +105,10 @@ When doing debugging on my development server, I use this line in the settings s
105
106 Of course, this is just for debugging.
107
100 -
108 ## Finding system ID types
109
103 -<https://serverurl/meshagents>
110 +<https://serverurl/meshagents> aka trying figure out what this is
111 +
112 +![ID](images/determine-id.png)
113
114 ## General server statistics related
\ No newline at end of file
docs/docs/meshcentral/images/determine-id.png
Binary files /dev/null and b/docs/docs/meshcentral/images/determine-id.png differ
docs/docs/meshcentral/images/user_tokens1.png
Binary files /dev/null and b/docs/docs/meshcentral/images/user_tokens1.png differ
docs/docs/meshcentral/images/user_tokens2.png
Binary files /dev/null and b/docs/docs/meshcentral/images/user_tokens2.png differ
docs/docs/meshcentral/tokens.md new
+15
@@ -0,0 +1,15 @@
1 +# 14.1 Tokens
2 +
3 +## User Tokens
4 +
5 +![User Tokens 1](images/user_tokens1.png)
6 +
7 +![User Tokens 2](images/user_tokens2.png)
8 +
9 +## Software Integration Tokens
10 +
11 +Currently, the login tokens in the user manual section 14.1 can't be tracked, deleted or revoked. They are generated with:
12 +
13 +```bash
14 +node meshcentral --loginTokenKey
15 +```
docs/mkdocs.yml
+6 -2
@@ -6,7 +6,10 @@ nav:
6 - install/index.md
7
8 - MeshCentral:
9 - - meshcentral/index.md
9 + - 'Index': 'meshcentral/index.md'
10 + - 'Tokens': 'meshcentral/tokens.md'
11 + - 'Assistant': 'meshcentral/assistant.md'
12 + - 'Debugging': 'meshcentral/debugging.md'
13
14 - Design and Architecture:
15 - design/index.md
@@ -27,7 +30,7 @@ site_description: "A remote monitoring and management tool"
30 site_author: "Ylianst"
31 site_url: "https://git.meshcentral.com/"
32
30 -dev_addr: "0.0.0.0:8006"
33 +dev_addr: "0.0.0.0:8010"
34
35 # Repository
36 repo_name: "Ylianst/MeshCentral"
@@ -46,6 +49,7 @@ theme:
49 - navigation.tabs
50 - navigation.expand
51 - navigation.top
52 + - navigation.instant
53 - toc.integrate
54 extra_css:
55 - stylesheets/extra.css