Skip to content

Commit 6366558

Browse files
Docs: Update readme and website (#3256)
* Docs: Update readme and website * Aktualisieren von groups-and-profiles.md * Update README.md Co-authored-by: Copilot <[email protected]> * Update README.md Co-authored-by: Copilot <[email protected]> --------- Co-authored-by: Copilot <[email protected]>
1 parent 6cafa27 commit 6366558

File tree

10 files changed

+76
-83
lines changed

10 files changed

+76
-83
lines changed

README.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
<b>A powerful tool for managing networks and troubleshoot network problems!</b>
66
</p>
77
<p>
8-
Streamline and simplify your network administration and troubleshooting with <strong>NETworkManager</strong>. Connect, monitor, and troubleshoot your network and server infrastructure using built-in tools like Remote Desktop (RDP), PuTTY (SSH, Telnet, Serial), PowerShell (WinRM), TigerVNC (VNC), and AWS Session Manager. Perform in-depth network diagnostics with features including WiFi Analyzer, IP Scanner, Port Scanner, Ping Monitor, Traceroute, DNS Lookup, LLDP/CDP Capture, and <a href="https://borntoberoot.net/NETworkManager/docs/features">many more</a> — all in a clean, unified interface.
8+
Streamline and simplify your network administration and troubleshooting with <strong>NETworkManager</strong>. Connect, monitor, and troubleshoot your network and server infrastructure using built-in tools like Remote Desktop (RDP), PuTTY (SSH, Serial, etc.), PowerShell (WSL, K9s, etc.) and TigerVNC (VNC). Perform in-depth network diagnostics with features including WiFi Analyzer, IP Scanner, Port Scanner, Ping Monitor, Traceroute, DNS Lookup, LLDP/CDP Capture, and <a href="https://borntoberoot.net/NETworkManager/docs/introduction">many more</a> — all in a clean, unified interface.
99
</p>
1010
<p>
11-
Organize hosts and networks in encrypted profiles with seamless access across all features. Built for professional environments, NETworkManager is enterprise-ready with an MSI installer, signed binaries, and support for package managers like Chocolatey, Evergreen, and WinGet. Available in over 16 languages with customizable light/dark themes and accent colors.
11+
Organize hosts and networks in profiles with seamless access across all features. Profile files can be encrypted to protect your sensitive data and used to separate different customers or environments. NETworkManager is enterprise-ready with an MSI installer, signed binaries, and support for package managers like Chocolatey, Evergreen, and WinGet. Available in over 16 languages with customizable light/dark themes and accent colors.
1212
</p>
1313
<p>
1414
<a href="https://borntoberoot.net/NETworkManager/download" target="_blank">
@@ -73,21 +73,21 @@ NETworkManager is your go-to tool for simplifying network administration and tro
7373

7474
Here's why you'll love it:
7575

76-
- 🧰 **Unified Experience** - All your essential network tools in one sleek interface — no more juggling apps.
77-
- 🖥️ **Remote System Management** - Connect to remote systems seamlessly via RDP, PuTTY (SSH, Telnet, Serial), PowerShell (WinRM), TigerVNC (VNC), or AWS Session Manager.
78-
- 🔍 **Analyze & Troubleshoot** - Deep network diagnostics with WiFi Analyzer, IP/Port Scanners, Ping Monitor, Traceroute, DNS Lookup, LLDP/CDP Capture, and <a href="https://borntoberoot.net/NETworkManager/docs/features">many more</a>.
79-
- 🔐 **Secure Profiles** - Organize hosts and networks in encrypted profiles with seamless access across all features.
80-
- 💎 **Open Source & Free** - No ads, no subscriptions, fully community-driven.
81-
- 🏢 **Enterprise-Ready** - MSI installer, signed binaries, and package manager support (Chocolatey, WinGet, Evergreen).
76+
- 🧰 **Unified Experience** - All your essential network tools together in a clean, unified interface.
77+
- 🖥️ **Remote System Management** - Seamlessly connect via Remote Desktop (RDP), PuTTY (SSH, Serial, etc.), PowerShell (WSL, K9s, etc.) or TigerVNC (VNC).
78+
- 🔍 **Analyze & Troubleshoot** - Deep network diagnostics with WiFi Analyzer, IP Scanner, Port Scanners, Ping Monitor, Traceroute, DNS Lookup, LLDP/CDP Capture, and <a href="https://borntoberoot.net/NETworkManager/docs/introduction">many more</a>.
79+
- 🔐 **Secure Profiles** - Organize hosts and networks in profiles with seamless access across all features. Encrypt profile files and separate them by customer or environment.
80+
- 💎 **Open Source & Free** - No ads, no subscriptions, no selling your data, fully community-driven.
81+
- 🏢 **Enterprise-Ready** - MSI installer, signed binaries, and package manager support (Chocolatey, Evergreen, and WinGet).
8282
- 🎨 **Personalized Experience** - Available in 16+ languages, with customizable light/dark themes and accent colors.
8383

84-
📖 Explore all features in detail on our [documentation page](https://borntoberoot.net/NETworkManager/docs/features).
84+
📖 Explore all features in detail in our [documentation](https://borntoberoot.net/NETworkManager/docs/introduction).
8585

8686
## 📦 Download
8787

8888
Get started with NETworkManager today! Download pre-built, [signed](https://borntoberoot.net/NETworkManager/download#code-signing-policy) binaries (setup, portable, or archive) from our [download page](https://borntoberoot.net/NETworkManager/download) with detailed install instructions (e.g., silent install). Files are hosted on [GitHub Releases](https://github.com/BornToBeRoot/NETworkManager/releases/latest).
8989

90-
Install via package managers for a hassle-free setup:
90+
Install and update via package managers for a hassle-free setup:
9191

9292
- **Chocolatey**:
9393

@@ -102,15 +102,17 @@ Install via package managers for a hassle-free setup:
102102
```
103103

104104
- **Evergreen**:
105+
105106
```powershell
106107
# Get latest release
107108
Get-EvergreenApp -Name NETworkManager
108109
# Save setup file
109110
Get-EvergreenApp -Name NETworkManager | Save-EvergreenApp -Path C:\Users\$env:Username\Downloads\
110111
```
111-
Evergreen PowerShell module: <https://github.com/aaronparker/evergreen>
112112

113-
> Pre-release versions with the latest features and fixes are (sometimes) available for testing on [GitHub Releases](https://github.com/BornToBeRoot/NETworkManager/releases).
113+
Evergreen PowerShell module (e.g. to automate image building or SCCM/Intune updates): <https://github.com/eucpilots/evergreen-module>
114+
115+
> Pre-release versions with the latest features and fixes are (sometimes) available for testing on [GitHub Releases](https://github.com/BornToBeRoot/NETworkManager/releases). Please note that pre-release versions may be unstable and are not recommended for production use. Please report any issues you encounter on [GitHub Issues](https://github.com/BornToBeRoot/NETworkManager/issues/new/choose).
114116
115117
## 💖 Donate
116118

@@ -159,8 +161,8 @@ Build NETworkManager yourself with these steps:
159161

160162
1. **Prerequisites**:
161163

162-
- [.NET 8.x SDK](https://dotnet.microsoft.com/download/dotnet/8.0)
163-
- Visual Studio 2022 with `.NET desktop development` and `Universal Windows Platform development`
164+
- [.NET 10.x SDK](https://dotnet.microsoft.com/download/dotnet/10.0)
165+
- [Visual Studio 2026](https://visualstudio.microsoft.com/) with `.NET desktop development` and `Universal Windows Platform development` (or [JetBrains Rider](https://www.jetbrains.com/rider/) - you still need to install the UWP workload via Visual Studio Installer)
164166

165167
2. **Clone the Repository**:
166168

@@ -175,8 +177,8 @@ Build NETworkManager yourself with these steps:
175177
- Open `.\Source\NETworkManager.sln` in Visual Studio or JetBrains Rider.
176178
- Alternatively, build via command line:
177179
```powershell
178-
dotnet restore .\Source\NETworkManager.sln
179-
dotnet build .\Source\NETworkManager.sln --configuration Release --no-restore
180+
dotnet restore .\Source\NETworkManager.sln
181+
dotnet build .\Source\NETworkManager.sln --configuration Release --no-restore
180182
```
181183
182184
## 🙏 Thanks
@@ -211,15 +213,15 @@ Star these projects to show your support!
211213
212214
## 🔒 Code Signing Policy
213215
214-
NETworkManager uses free code signing services from [SignPath.io](https://signpath.io/) and a free code signing certificate provided by the [SignPath Foundation](https://signpath.org/) to sign all official binaries and installers, ensuring the authenticity and integrity of your downloads.
216+
NETworkManager uses free code signing services from [SignPath.io](https://signpath.io/) and a free code signing certificate provided by the [SignPath Foundation](https://signpath.org/) to sign all official binaries and installers, ensuring the authenticity and integrity.
215217
216218
The binaries and installers are built on [AppVeyor](https://ci.appveyor.com/project/BornToBeRoot/networkmanager) directly from the [GitHub repository](https://github.com/BornToBeRoot/NETworkManager/blob/main/appveyor.yml). After each build, the artifacts are automatically sent to [SignPath.io](https://signpath.io/) via webhook, where they are signed following manual approval by the maintainer. Once signed, the binaries are uploaded to the [GitHub releases page](https://github.com/BornToBeRoot/NETworkManager/releases).
217219
218220
## 🔐 Privacy Policy
219221
220222
Your privacy matters. NETworkManager will not transfer any information to other networked systems unless specifically requested by the user or the person installing or operating it.
221223
222-
NETworManager has integrated some optional third-party services to enhance functionality. You can choose to enable or disable these services at the first startup or later in the settings:
224+
NETworManager has integrated some **optional** third-party services to enhance functionality. You can choose to enable or disable these services at the first startup or later in the settings:
223225
224226
- [api.github.com](https://docs.github.com/en/site-policy/privacy-policies/github-general-privacy-statement) - Check for application updates.
225227
- [ipify.org](https://www.ipify.org/) - Retrieve the public IP address used by the client.

Website/docs/application/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"label": "Application",
3-
"position": 3,
3+
"position": 2,
44
"link": {
55
"type": "generated-index",
66
"description": "Features included in NETworkManager"

Website/docs/changelog/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"label": "Changelog",
3-
"position": 2,
3+
"position": 1,
44
"link": {
55
"type": "generated-index",
66
"description": "Changelog of all NETworkManager releases"

Website/docs/commandline-arguments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 6
2+
sidebar_position: 5
33
---
44

55
# Command Line Arguments

Website/docs/features.md

Lines changed: 0 additions & 48 deletions
This file was deleted.

Website/docs/groups-and-profiles.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 5
2+
sidebar_position: 4
33
---
44

55
# Groups and Profiles
@@ -60,7 +60,7 @@ Use `tags` to organize profiles and filter by them. For example, tag profiles as
6060

6161
Some settings like the `host` can be inherited from the general settings in the feature specific settings.
6262

63-
See also the profile section in the specific [feature documentation](./features.md) for more information.
63+
See also the profile section in the specific [feature documentation](./introduction) for more information.
6464

6565
:::
6666

Website/docs/introduction.mdx

Lines changed: 43 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,50 @@ sidebar_position: 0
44

55
import styles from "./styles.module.css";
66

7-
# NETworkManager
7+
# Welcome to NETworkManager
88

9-
**A powerful tool for managing networks and troubleshoot network problems!**
9+
![NETworkManager Preview](https://github.com/BornToBeRoot/NETworkManager/raw/main/Website/static/img/preview-features.gif?raw=true)
1010

11-
Streamline and simplify your network administration and troubleshooting with <strong>NETworkManager</strong>. Connect, monitor, and troubleshoot your network and server infrastructure using built-in tools like Remote Desktop (RDP), PuTTY (SSH, Telnet, Serial), PowerShell (WinRM), TigerVNC (VNC), and AWS Session Manager. Perform in-depth network diagnostics with features including WiFi Analyzer, IP Scanner, Port Scanner, Ping Monitor, Traceroute, DNS Lookup, LLDP/CDP Capture, and [many more](./features) — all in a clean, unified interface.
11+
## Features
1212

13-
Organize hosts and networks in encrypted profiles with seamless access across all features. Built for professional environments, NETworkManager is enterprise-ready with an MSI installer, signed binaries, and support for package managers like Chocolatey, Evergreen, and WinGet. Available in over 16 languages with customizable light/dark themes and accent colors.
13+
The following features are currently available:
1414

15-
![NETworkManager Preview](https://github.com/BornToBeRoot/NETworkManager/raw/main/Website/static/img/preview-features.gif?raw=true)
15+
- [Dashboard](./application/dashboard)
16+
- [Network Interface](./application/network-interface) - Information, Bandwidth, Configure
17+
- [WiFi](./application/wifi) - Networks, Channels
18+
- [IP Scanner](./application/ip-scanner)
19+
- [Port Scanner](./application/port-scanner)
20+
- [Ping Monitor](./application/ping-monitor)
21+
- [Traceroute](./application/traceroute)
22+
- [DNS Lookup](./application/dns-lookup)
23+
- [Remote Desktop](./application/remote-desktop)
24+
- [PowerShell](./application/powershell)
25+
- [PuTTY](./application/putty) (requires [PuTTY](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html))
26+
- [TigerVNC](./application/tigervnc) (requires [TigerVNC](https://tigervnc.org/))
27+
- [Web Console](./application/web-console) (requires [Microsoft Edge - WebView2 Runtime](https://developer.microsoft.com/en-us/microsoft-edge/webview2/))
28+
- [SNMP](./application/snmp) - Get, Walk, Set
29+
- [Hosts File Editor](./application/hosts-file-editor)
30+
- [SNTP Lookup](./application/sntp-lookup)
31+
- [Discovery Protocol](./application/discovery-protocol) - LLDP, CDP
32+
- [Wake on LAN](./application/wake-on-lan)
33+
- [Whois](./application/whois)
34+
- [Subnet Calculator](./application/subnet-calculator) - Calculator, Subnetting, Supernetting
35+
- [Bit Calculator](./application/bit-calculator)
36+
- [Lookup](./application/lookup) - OUI, Port
37+
- [Connections](./application/connections)
38+
- [Listeners](./application/listeners)
39+
- [ARP Table](./application/arp-table)
40+
41+
If you have any suggestions for new features, please submit a [feature request](https://github.com/BornToBeRoot/NETworkManager/issues/new/choose) on GitHub.
42+
43+
## Profiles
44+
45+
Organize your hosts and networks with specific configurations in profiles and use them seamless across all features. You can separate them in different profile files for each environment (e.g. work, home, customer, etc.) and encrypt them with a master password to protect your sensitive data and credentials.
46+
47+
## Languages
48+
49+
Thanks to the community, NETworkManager is available in more than 16 [languages](https://app.transifex.com/BornToBeRoot/NETworkManager/dashboard/). If you would like to help with the translation and improve it, you can join the translation team on [Transifex](https://app.transifex.com/BornToBeRoot/NETworkManager/dashboard/).
50+
51+
New languages must be requested on GitHub via a [feature request](https://github.com/BornToBeRoot/NETworkManager/issues/new/choose) before you can join the translation team and start translating.
52+
53+
See also the [contributing guidelines](https://github.com/BornToBeRoot/NETworkManager/blob/main/CONTRIBUTING.md) for this project.

Website/docs/settings/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"label": "Settings",
3-
"position": 4,
3+
"position": 3,
44
"link": {
55
"type": "generated-index",
66
"description": "Application wide settings of NETworkManager"

Website/docs/settings/appearance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Apply the current application theme to the PowerShell console global profile(s).
8383

8484
If enabled, the PowerShell console global profile(s) are modified in the registry under `Computer\HKEY_CURRENT_USER\Console` (`HKCU:\Console`). This adjusts the background of the console and some other settings so that the console window integrates better with the NETworkManager application.
8585

86-
The profiles are changed for the PowerShell consoles configured in the PowerShell and AWS Session Manager tools. Both Windows PowerShell and PowerShell 7 and later are supported.
86+
The profiles are changed for the PowerShell consoles configured in the PowerShell tools. Both Windows PowerShell and PowerShell 7 and later are supported.
8787

8888
Example paths under `HKCU:\Console`:
8989

Website/src/components/HomepageFeatures/index.js

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ const FeatureList = [
2121
<>
2222
Connect to remote systems and manage your network and server
2323
infrastructure with integrated clients such as Remote Desktop (RDP),
24-
PuTTY (SSH, Telnet, Serial), PowerShell (WinRM, WSL, Custom Tools),
25-
TigerVNC (VNC), and AWS SSM.
24+
PuTTY (SSH, Serial, etc.), PowerShell (WSL, K9s, etc.)
25+
and TigerVNC (VNC).
2626
</>
2727
),
2828
},
@@ -32,9 +32,10 @@ const FeatureList = [
3232
.default,
3333
description: (
3434
<>
35-
Save hosts and networks with custom configurations in encrypted
36-
profile files to protect sensitive data, organize them by customers
37-
or environments, and use them seamlessly across features.
35+
Organize hosts and networks into encrypted profiles to protect
36+
sensitive data and use them seamlessly across all features.
37+
Separate profile files let you easily manage different customers
38+
or environments.
3839
</>
3940
),
4041
},

0 commit comments

Comments
 (0)