Skip to content

Commit 7b2fc68

Browse files
BornToBeRootBornToBeRoot
committed
Docs: Reformat docs
1 parent e155369 commit 7b2fc68

8 files changed

Lines changed: 169 additions & 80 deletions

File tree

‎Website/docs/application/dns-lookup.md‎

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,17 @@
11
---
22
sidebar_position: 7
33
description: "Query DNS servers for A, AAAA, CNAME, MX, NS, PTR, and other record types. NETworkManager DNS Lookup supports custom and predefined DNS server profiles."
4-
keywords: [NETworkManager, DNS lookup, DNS query, DNS records, name resolution, MX record, A record, DNS tool]
4+
keywords:
5+
[
6+
NETworkManager,
7+
DNS lookup,
8+
DNS query,
9+
DNS records,
10+
name resolution,
11+
MX record,
12+
A record,
13+
DNS tool,
14+
]
515
---
616

717
# DNS Lookup
@@ -34,16 +44,23 @@ Example: `server-01.borntoberoot.net; 10.0.0.1`
3444

3545
:::
3646

37-
The dns server can be selected from a list of configured servers or you can enter a custom dns server in the format `<hostname>|<ipadress>:<port>` (`<port>` is optional, to use a custom port with IPv6 enclose the address in square brackets: `[<ipv6adress>]:53`).
47+
The DNS server can be selected from a list of configured servers or you can enter a custom DNS server in the format `<hostname>|<ipaddress>:<port>` (`<port>` is optional, to use a custom port with IPv6 enclose the address in square brackets: `[<ipv6address>]:53`).
3848

39-
![DNS Lookup](../img/dns-lookup.png)
40-
41-
:::note
49+
:::info
4250

43-
Right-click on the result to copy or export the information.
51+
DNS (Domain Name System) is a hierarchical naming system for computers, services, and other resources connected to the internet or a private network. It translates human-readable hostnames into IP addresses and supports various record types such as A (IPv4), AAAA (IPv6), MX (mail), CNAME (alias), NS (name server), and PTR (reverse lookup).
4452

4553
:::
4654

55+
![DNS Lookup](../img/dns-lookup.png)
56+
57+
### Context menu
58+
59+
| Action | Description |
60+
| ------------- | ------------------------------------------------ |
61+
| **Copy** | Copies the selected information to the clipboard |
62+
| **Export...** | Exports the selected or all results to a file |
63+
4764
## Profile
4865

4966
### Inherit host from general
@@ -120,15 +137,15 @@ Add a custom DNS suffix to the hostname.
120137

121138
### Recursion
122139

123-
Use recursion for the dns query.
140+
Use recursion for the DNS query.
124141

125142
**Type:** `Boolean`
126143

127144
**Default:** `Enabled`
128145

129146
### Use cache
130147

131-
Use the cache for the dns query.
148+
Use the cache for the DNS query.
132149

133150
**Type:** `Boolean`
134151

@@ -159,23 +176,23 @@ Only show the most common query types (`A`, `AAAA`, `ANY`, `CNAME`, `DNSKEY`, `M
159176

160177
### Use only TCP
161178

162-
Only use TCP for the dns query. DNS uses UDP by default.
179+
Only use TCP for the DNS query. DNS uses UDP by default.
163180

164181
**Type:** `Boolean`
165182

166183
**Default:** `Disabled`
167184

168185
### Retries
169186

170-
Retries for the dns query after which the query is considered lost.
187+
Number of retries for the DNS query after which the query is considered lost.
171188

172189
**Type:** `Integer` [Min `1`, Max `10`]
173190

174191
**Default:** `3`
175192

176193
### Timeout (s)
177194

178-
Timeout in seconds for the dns query after which the query is considered lost.
195+
Timeout in seconds for the DNS query, after which the query is considered lost.
179196

180197
**Type:** `Integer` [Min `1`, Max `15`]
181198

‎Website/docs/application/powershell.md‎

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,37 @@
11
---
22
sidebar_position: 9
3-
description: "Launch local or remote PowerShell consoles with NETworkManager. Supports tabbed sessions, profiles, and integration with WSL, AWS SSM, and K9s."
4-
keywords: [NETworkManager, PowerShell, PowerShell remoting, terminal, command line, WSL, K9s, AWS SSM, remote console]
3+
description: "Launch local or remote PowerShell consoles with tabbed sessions, profiles, and integration with WSL, AWS SSM, and K9s."
4+
keywords:
5+
[
6+
NETworkManager,
7+
PowerShell,
8+
PowerShell remoting,
9+
terminal,
10+
command line,
11+
WSL,
12+
K9s,
13+
AWS SSM,
14+
remote console,
15+
]
516
---
617

718
# PowerShell
819

920
With **PowerShell** you can launch PowerShell consoles locally or connect to remote computers using [PowerShell Remoting](https://learn.microsoft.com/en-us/powershell/scripting/learn/ps101/08-powershell-remoting). You can also execute command-line applications such as `wsl`, `aws ssm`, `k9s`, or any other tools typically accessible from a PowerShell session. In addition, you can run PowerShell scripts directly within the console.
1021

11-
The integration of PowerShell with NETworkManger supports tabs and profiles for hosts (and tools). You can launch the console / establish a connection via a profile (double-click, Enter key or right-click `Connect`) or directly via the [connection](#connect) dialog.
22+
The integration of PowerShell with NETworkManager supports tabs and profiles for hosts (and tools). You can launch the console / establish a connection via a profile (double-click, Enter key or right-click `Connect`) or directly via the [connection](#connect) dialog.
1223

1324
:::info
1425

15-
PowerShell is a command-line shell and scripting language developed by Microsoft for automating administrative tasks and managing system configurations. It provides a robust set of built-in commands and access to .NET Framework objects, allowing for efficient system administration and automation. PowerShell uses a verb-noun syntax, allowing users to perform a wide range of operations by executing simple and powerful commands.
26+
PowerShell is a command-line shell and scripting language developed by Microsoft for automating administrative tasks and managing system configurations. It provides a robust set of built-in commands and access to .NET Framework objects for efficient system administration and automation. PowerShell uses a verb-noun cmdlet syntax, giving users a consistent and predictable way to perform a wide range of operations.
1627

1728
:::
1829

1930
:::note
2031

2132
Windows PowerShell (`powershell`) and PowerShell (`pwsh`) are supported. **Use PowerShell (`pwsh`) for the best experience.**
2233

23-
Indructions for installing PowerShell (`pwsh`) can be found on the [official website](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell?).
34+
Instructions for installing PowerShell (`pwsh`) can be found on the [official website](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell?).
2435

2536
:::
2637

@@ -51,14 +62,14 @@ If Windows Terminal is installed, change the `Default terminal application` in t
5162

5263
![PowerShell](../img/powershell.png)
5364

54-
:::note
55-
56-
Right-click on the tab will open the context menu with the following options:
65+
### Tab context menu
5766

58-
- **Reconnect** - Restart the PowerShell console (and reconnect to the remote computer).
59-
- **Resize** - Resize the PowerShell console to the current view size (if connected).
67+
Right-clicking a session tab opens a context menu:
6068

61-
:::
69+
| Action | Description |
70+
| ------------- | ---------------------------------------------------------------------- |
71+
| **Reconnect** | Restart the PowerShell console (and reconnect to the remote computer). |
72+
| **Resize** | Resize the PowerShell console to the current view size (if connected). |
6273

6374
## Connect
6475

@@ -68,7 +79,7 @@ Connect to a remote computer via PowerShell Remoting.
6879

6980
**Type:** `Boolean`
7081

71-
**Default:** `False`
82+
**Default:** `Disabled`
7283

7384
### Host
7485

‎Website/docs/application/putty.md‎

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,27 @@
11
---
22
sidebar_position: 10
33
description: "Connect via SSH, Telnet, or serial port using the embedded PuTTY client in NETworkManager. Supports tabbed sessions and profile-based connections."
4-
keywords: [NETworkManager, PuTTY, SSH client, Telnet, serial port, remote connection, SSH manager]
4+
keywords:
5+
[
6+
NETworkManager,
7+
PuTTY,
8+
SSH client,
9+
Telnet,
10+
serial port,
11+
remote connection,
12+
SSH manager,
13+
]
514
---
615

716
# PuTTY
817

918
With **PuTTY** you can connect to a remote computer via Secure Shell (SSH) or Telnet. In addition you can connect to a local serial port.
1019

11-
The integration of PuTTY with NETworkManger supports tabs and profiles for hosts. You can establish a connection via a profile (double-click, Enter key or right-click `Connect`) or directly via the [connection](#connect) dialog.
20+
The integration of PuTTY with NETworkManager supports tabs and profiles for hosts. You can establish a connection via a profile (double-click, Enter key or right-click `Connect`) or directly via the [connection](#connect) dialog.
1221

1322
:::info
1423

15-
PuTTY is a free and open-source application that acts as a terminal emulator, serial console and network file transfer tool. It offers support for various network protocols such as SSH, Telnet, SCP, rlogin and raw socket connections. In addition to its networking capabilities, PuTTY allows connection to serial ports and provides convenient session management options for saving connection settings and quickly accessing frequently used systems. Its lightweight design and customizable interface make it a popular tool for system administrators and network engineers for tasks such as remote system administration, configuration and troubleshooting.
24+
PuTTY is a free and open-source terminal emulator, serial console, and network file transfer tool. It supports various network protocols including SSH, Telnet, SCP, rlogin, and raw socket connections, as well as direct serial port connections. PuTTY provides session management for saving connection settings and quickly reconnecting to frequently used systems. Its lightweight and customizable design makes it a popular choice for system administrators and network engineers.
1625

1726
:::
1827

@@ -24,15 +33,15 @@ PuTTY must be installed on the local computer in order to use this feature. You
2433

2534
![PuTTY](../img/putty.png)
2635

27-
:::note
28-
29-
Right-click on the tab will open the context menu with the following options:
36+
### Tab context menu
3037

31-
- **Reconnect** - Restart PuTTY and reconnect to the remote computer.
32-
- **Resize** - Resize the PuTTY window to the current view size (if connected).
33-
- **Restart session** - Restart the PuTTY session (if connected).
38+
Right-clicking a session tab opens a context menu:
3439

35-
:::
40+
| Action | Description |
41+
| ------------------- | ---------------------------------------------------------------- |
42+
| **Reconnect** | Restart PuTTY and reconnect to the remote computer. |
43+
| **Resize** | Resize the PuTTY window to the current view size (if connected). |
44+
| **Restart session** | Restart the PuTTY session (if connected). |
3645

3746
## Connect
3847

‎Website/docs/application/remote-desktop.md‎

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,16 @@
11
---
22
sidebar_position: 8
33
description: "Connect to remote computers via RDP with NETworkManager Remote Desktop. Features tabbed sessions, profile management, and fullscreen support."
4-
keywords: [NETworkManager, remote desktop, RDP client, remote connection, remote access, Windows Remote Desktop, RDP manager]
4+
keywords:
5+
[
6+
NETworkManager,
7+
remote desktop,
8+
RDP client,
9+
remote connection,
10+
remote access,
11+
Windows Remote Desktop,
12+
RDP manager,
13+
]
514
---
615

716
# Remote Desktop
@@ -16,18 +25,17 @@ Remote Desktop Protocol (RDP) is a proprietary protocol developed by Microsoft t
1625

1726
![Remote Desktop](../img/remote-desktop.png)
1827

19-
:::note
20-
21-
Right-click on the tab will open the context menu with the following options:
28+
### Tab context menu
2229

23-
- **Reconnect** - Reconnect to the remote computer (if disconnected).
24-
- **Disconnect** - Disconnect from the remote computer (if connected).
25-
- **Fullscreen** - Toggle fullscreen mode (if connected).
26-
- **Adjust screen** - Adjust the screen size to the current view size (only if [Display](#display) is set to `Adjust screen automatically` or `Use the current view size as screen size`) (if connected).
27-
- **Keyboard shortcuts**
28-
- **Ctrl+Alt+Del** - Send Ctrl+Alt+Del to the remote computer (if connected).
30+
Right-clicking a session tab opens a context menu:
2931

30-
:::
32+
| Action | Description |
33+
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
34+
| **Reconnect** | Reconnects to the remote computer (only if disconnected) |
35+
| **Disconnect** | Disconnects from the remote computer (only if connected) |
36+
| **Fullscreen** | Toggles fullscreen mode (only if connected) |
37+
| **Adjust screen** | Adjusts the screen size to the current view size; only available if [Display](#display) is set to `Adjust screen automatically` or `Use the current view size as screen size` (only if connected) |
38+
| **Keyboard shortcuts > Ctrl+Alt+Del** | Sends Ctrl+Alt+Del to the remote computer (only if connected) |
3139

3240
## Connect
3341

@@ -517,7 +525,7 @@ Configure the printer redirection for the remote desktop connection.
517525

518526
**Default:** `Disabled`
519527

520-
### Persitent bitmap caching
528+
### Persistent bitmap caching
521529

522530
Configure the persistent bitmap caching for the remote desktop connection.
523531

@@ -925,7 +933,7 @@ Configure the printer redirection for the remote desktop connection.
925933

926934
**Default:** `Disabled`
927935

928-
### Persitent bitmap caching
936+
### Persistent bitmap caching
929937

930938
Configure the persistent bitmap caching for the remote desktop connection.
931939

@@ -1195,7 +1203,7 @@ Configure the printer redirection for the remote desktop connection.
11951203

11961204
**Default:** `Disabled`
11971205

1198-
### Persitent bitmap caching
1206+
### Persistent bitmap caching
11991207

12001208
Configure the persistent bitmap caching for the remote desktop connection.
12011209

‎Website/docs/application/snmp.md‎

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,17 @@
11
---
22
sidebar_position: 14
3-
description: "Monitor and manage network devices via SNMP v1, v2c, and v3 with NETworkManager. Supports get, walk, and set operations with configurable security levels."
4-
keywords: [NETworkManager, SNMP, SNMP v3, network monitoring, SNMP get, SNMP walk, SNMP set, network management]
3+
description: "Monitor and manage network devices via SNMP v1, v2c, and v3 using get, walk, and set operations with configurable security levels."
4+
keywords:
5+
[
6+
NETworkManager,
7+
SNMP,
8+
SNMP v3,
9+
network monitoring,
10+
SNMP get,
11+
SNMP walk,
12+
SNMP set,
13+
network management,
14+
]
515
---
616

717
# SNMP
@@ -17,6 +27,12 @@ Example inputs:
1727
| `10.0.0.10` | `Walk` | `V3` | `.1.3.6.1.2.1.1` | `-/-` | `AuthNoPriv` | `Admin` | `SHA1 | S3cr3t!` | `-/-` | `-/-` |
1828
| `10.0.0.10` | `Walk` | `V3` | `.1.3.6.1.2.1.1` | `-/-` | `AuthPriv` | `Admin` | `SHA1 | S3cr3t!` | `AES | S3cr3t%` |
1929

30+
:::info
31+
32+
Simple Network Management Protocol (SNMP) is a standard protocol for monitoring and managing network devices. It uses UDP (port 161 for queries, port 162 for traps) and operates on a manager–agent model, where managed devices expose a Management Information Base (MIB) — a hierarchical collection of objects identified by Object Identifiers (OIDs). SNMP has three versions: SNMPv1 and SNMPv2c use community strings for authentication, while SNMPv3 adds user-based authentication and encryption.
33+
34+
:::
35+
2036
:::note
2137

2238
Multiple OIDs (`.1.3.6.1.2.1.1; .1.3.6.1.2.1.2`) can be specified when using the mode `get`.
@@ -25,11 +41,12 @@ Multiple OIDs (`.1.3.6.1.2.1.1; .1.3.6.1.2.1.2`) can be specified when using the
2541

2642
![SNMP](../img/snmp.png)
2743

28-
:::note
29-
30-
Right-click on the result to copy or export the information.
44+
### Context menu
3145

32-
:::
46+
| Action | Description |
47+
| ------------- | ----------------------------------------------- |
48+
| **Copy** | Copy the selected information to the clipboard. |
49+
| **Export...** | Export the selected or all results to a file. |
3350

3451
## Profile
3552

‎Website/docs/application/tigervnc.md‎

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,21 @@
11
---
22
sidebar_position: 12
3-
description: "Connect to remote computers via VNC using the embedded TigerVNC client in NETworkManager. Features tabbed sessions and hardware-accelerated Tight encoding."
4-
keywords: [NETworkManager, TigerVNC, VNC client, remote desktop, VNC connection, remote access, VNC viewer]
3+
description: "Connect to remote computers via VNC with tabbed sessions and hardware-accelerated Tight encoding."
4+
keywords:
5+
[
6+
NETworkManager,
7+
TigerVNC,
8+
VNC client,
9+
remote desktop,
10+
VNC connection,
11+
remote access,
12+
VNC viewer,
13+
]
514
---
615

716
# TigerVNC
817

9-
With **TigerVNC** you can connect to a remote computer via VNC. The integration of TigerVNC with NETworkManger supports tabs and profiles for hosts. The connection can be established via a profile (double-click, Enter key or right-click `Connect`) or directly via the [connection](#connect) dialog.
18+
With **TigerVNC** you can connect to a remote computer via VNC. The integration of TigerVNC with NETworkManager supports tabs and profiles for hosts. The connection can be established via a profile (double-click, Enter key or right-click `Connect`) or directly via the [connection](#connect) dialog.
1019

1120
:::info
1221

@@ -28,13 +37,13 @@ TigerVNC must be installed on the local computer in order to use this feature. Y
2837

2938
![TigerVNC](../img/tigervnc.png)
3039

31-
:::note
32-
33-
Right-click on the tab will open the context menu with the following options:
40+
### Tab context menu
3441

35-
- **Reconnect** - Restart TigerVNC and reconnect to the remote computer.
42+
Right-clicking a session tab opens a context menu:
3643

37-
:::
44+
| Action | Description |
45+
| ------------- | ------------------------------------------------------ |
46+
| **Reconnect** | Restart TigerVNC and reconnect to the remote computer. |
3847

3948
## Connect
4049

0 commit comments

Comments
 (0)