From 03d873af7e3b52dfc3d3bdf2d9da7a687824fb77 Mon Sep 17 00:00:00 2001 From: BornToBeRoot <16019165+BornToBeRoot@users.noreply.github.com> Date: Mon, 1 Jan 2024 04:12:33 +0100 Subject: [PATCH] Docs: Settings added --- Website/docs/changelog/_category_.json | 2 +- Website/docs/commandline-arguments.md | 91 +++++++++++++++++++ Website/docs/faq/_category_.json | 2 +- Website/docs/settings/_category_.json | 2 +- Website/docs/settings/appearance.md | 115 +++++++++++++++++++++++++ Website/docs/settings/autostart.md | 27 ++++++ Website/docs/settings/general.md | 65 ++++++++++++++ Website/docs/settings/hotkeys.md | 15 ++++ Website/docs/settings/language.md | 25 ++++++ Website/docs/settings/network.md | 36 ++++++++ Website/docs/settings/profiles.md | 42 +++++++++ Website/docs/settings/settings.md | 37 ++++++++ Website/docs/settings/status.md | 27 ++++++ Website/docs/settings/update.md | 2 +- Website/docs/settings/window.md | 59 +++++++++++++ 15 files changed, 543 insertions(+), 4 deletions(-) create mode 100644 Website/docs/commandline-arguments.md create mode 100644 Website/docs/settings/appearance.md create mode 100644 Website/docs/settings/autostart.md create mode 100644 Website/docs/settings/general.md create mode 100644 Website/docs/settings/hotkeys.md create mode 100644 Website/docs/settings/language.md create mode 100644 Website/docs/settings/network.md create mode 100644 Website/docs/settings/profiles.md create mode 100644 Website/docs/settings/settings.md create mode 100644 Website/docs/settings/status.md create mode 100644 Website/docs/settings/window.md diff --git a/Website/docs/changelog/_category_.json b/Website/docs/changelog/_category_.json index cdf7f2f7de..87f85d69de 100644 --- a/Website/docs/changelog/_category_.json +++ b/Website/docs/changelog/_category_.json @@ -3,6 +3,6 @@ "position": 2, "link": { "type": "generated-index", - "description": "Changelog of all versions" + "description": "Changelog of all NETworkManager releases" } } diff --git a/Website/docs/commandline-arguments.md b/Website/docs/commandline-arguments.md new file mode 100644 index 0000000000..437734fb8f --- /dev/null +++ b/Website/docs/commandline-arguments.md @@ -0,0 +1,91 @@ +--- +sidebar_position: 5 +--- + +# Command Line Arguments + +## Public + +Publicly available command line arguments. + +### `--help` + +Displays the help dialog. + +**Example:** + +```PowerShell +NETworkManager.exe --help +``` + +### `--reset-settings` + +Resets all application settings. + +**Example:** + +```PowerShell +NETworkManager.exe --reset-settings +``` + +### `--application:` + +Start a specific application on startup. + +**Possible values:** + +- `Dashboard` +- `NetworkInterface` +- `WiFi` +- `IPScanner` +- `PortScanner` +- `PingMonitor` +- `Traceroute` +- `DNSLookup` +- `RemoteDesktop` +- `PowerShell` +- `PuTTY` +- `AWSSessionManager` +- `TigerVNC` +- `WebConsole` +- `SNMP` +- `SNTPLookup` +- `DiscoveryProtocol` +- `WakeOnLAN` +- `Whois` +- `SubnetCalculator` +- `BitCalculator` +- `Lookup` +- `Connections` +- `Listeners` +- `ARPTable` + +**Example:** + +```PowerShell +NETworkManager.exe --application:PingMonitor +``` + +## Internal + +Internally used command line arguments. + +### `--autostart` + +Indicates whether the application was started automatically (via autostart). + +**Example:** + +```PowerShell +NETworkManager.exe --autostart +``` + +### `--restart-pid:` + +Process ID of the old application process to wait for it to end if the application is restarted. + +**Example:** + +```PowerShell +NETworkManager.exe --restart-pid:35674 +``` diff --git a/Website/docs/faq/_category_.json b/Website/docs/faq/_category_.json index f480300452..4f1d102fa6 100644 --- a/Website/docs/faq/_category_.json +++ b/Website/docs/faq/_category_.json @@ -1,6 +1,6 @@ { "label": "FAQ", - "position": 5, + "position": 6, "link": { "type": "generated-index", "description": "Frequently Asked Questions" diff --git a/Website/docs/settings/_category_.json b/Website/docs/settings/_category_.json index 67e835b591..9c73dbf850 100644 --- a/Website/docs/settings/_category_.json +++ b/Website/docs/settings/_category_.json @@ -3,6 +3,6 @@ "position": 4, "link": { "type": "generated-index", - "description": "Application wide settings in NETworkManager" + "description": "Application wide settings of NETworkManager" } } diff --git a/Website/docs/settings/appearance.md b/Website/docs/settings/appearance.md new file mode 100644 index 0000000000..29560c6c53 --- /dev/null +++ b/Website/docs/settings/appearance.md @@ -0,0 +1,115 @@ +--- +sidebar_position: 2 +--- + +# Appearance + +### Theme + +Theme of the application which is based on [`MahApps.Metro themes`](https://mahapps.com/docs/themes/usage) + +**Type:** `String` + +**Default:** `Dark` + +**Possible values:** + +- `Dark` +- `Light` + +### Accent + +Accent of the application which is based on [`MahApps.Metro themes`](https://mahapps.com/docs/themes/usage) + +**Type:** `String` + +**Default:** `Lime` + +**Possible values:** + +- `Red` +- `Green` +- `Blue` +- `Purple` +- `Orange` +- `Lime` +- `Emerald` +- `Teal` +- `Cyan` +- `Cobalt` +- `Indigo` +- `Violet` +- `Pink` +- `Magenta` +- `Crimson` +- `Amber` +- `Yellow` +- `Brown` +- `Olive` +- `Steel` +- `Mauve` +- `Taupe` +- `Sienna` + +:::note + +If you add, change or delete a theme in the folder, you must restart the application for the changes to be applied. + +::: + +### Use custom themes + +Enables or disables the custom themes. + +**Type:** `Boolean` + +**Default:** `Disabled` + +Custom themes can be placed in the `Themes` folder in the application folder (e.g. `C:\Program Files\NETworkManager\Themes`). The file name has the format `..xaml`. For instructions on how to create custom themes, see the [MahApp.Metro documentation](https://mahapps.com/docs/themes/thememanager#creating-custom-themes). + +:::note + +Custom themes override the [`Accent`](#accent) and [`Theme`](#theme) settings. + +::: + +### Apply theme to PowerShell console + +Apply the current application theme to the PowerShell console global profile(s). + +**Type:** `Boolean` + +**Default:** `Disabled` + +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. + +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. + +Example paths under `HKCU:\Console`: + +| PowerShell path | Registry profile path | +| ----------------------------------------------------------- | ------------------------------------------------------------- | +| `C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe` | `%SystemRoot%_System32_WindowsPowerShell_v1.0_powershell.exe` | +| `C:\Program Files\PowerShell\7\pwsh.exe` | `C:_Program Files_PowerShell_7_pwsh.exe` | + +The following registry keys are created, modified or deleted in the registry profile path: + +| Name | Type | Action | Value | Value basis | +| ----------- | ------------ | ------------------- | ----------------------------------- | ----------- | +| `REG_DWORD` | `Add/Modify` | `CursorType` | `1` | `Hex` | +| `REG_DWORD` | `Add/Modify` | `FontFamiliy` | `36` | `Hex` | +| `REG_DWORD` | `Add/Modify` | `FontSize` | `120000` | `Hex` | +| `REG_DWORD` | `Add/Modify` | `FontWeight` | `400` | `Hex` | +| `REG_DWORD` | `Add/Modify` | `DefaultBackground` | `252525` (Dark) or `FFFFFF` (Light) | `Hex` | +| `REG_DWORD` | `Add/Modify` | `ColorTable00` | `252525` (Dark) or `FFFFFF` (Light) | `Hex` | +| `REG_DWORD` | `Add/Modify` | `ColorTable07` | `252525` (Dark) or `252525` (Light) | `Hex` | +| `REG_SZ` | `Add/Modify` | `FaceName` | `Consolas` | `String` | +| `REG_DWORD` | `Delete` | `ScreenColors` | | | + +If disabled, the Powershell console global profile(s) are no longer modified. But the original values are not restored. + +:::note + +Colors may not be set correctly when [`Use custom themes`](#use-custom-themes) is enabled. + +::: diff --git a/Website/docs/settings/autostart.md b/Website/docs/settings/autostart.md new file mode 100644 index 0000000000..0b528ba278 --- /dev/null +++ b/Website/docs/settings/autostart.md @@ -0,0 +1,27 @@ +--- +sidebar_position: 7 +--- + +# Autostart + +### Start with Windows (current user) + +Start the application automatically when the user logs in. + +**Type:** `Boolean` + +**Default:** `Disabled` + +### Start minimized in tray + +Start the application minimized in the tray when the user logs in. + +**Type:** `Boolean` + +**Default:** `Disabled` + +:::note + +Requires [Start with Windows (current user)](#start-with-windows-current-user) to be enabled. + +::: diff --git a/Website/docs/settings/general.md b/Website/docs/settings/general.md new file mode 100644 index 0000000000..33627a9819 --- /dev/null +++ b/Website/docs/settings/general.md @@ -0,0 +1,65 @@ +--- +sidebar_position: 0 +--- + +# General + +### Show the following application on startup: + +Default application that is displayed when the application is launched. + +Type: `NETworkManager.Models.ApplicationName` + +Default: `Dashboard` + +### Visible applications + +Applications that are displayed in the bar. + +Type: `NETworkManager.Models.ApplicationName` + +Default: `All` + +### Hidden applications + +Applications that are not displayed in the bar. + +Type: `NETworkManager.Models.ApplicationName` + +Default: `None` + +### Run background job every x-minutes + +Run a background job every x-minutes to save profiles and settings. + +Type: `Integer` + +Default: `5` [Min `0`, Max `120`] + +:::note + +The value 0 will disable the background job. Changes to this value will take effect after restarting the application. + +::: + +### Number of stored entries + +Maximum number of entries stored in the history for several application inputs. + +Type: `Integer` + +Default: `5` [Min `0`, Max `25`] + +### ThreadPool additional min. threads + +Additional [minimum number of threads](https://learn.microsoft.com/en-us/dotnet/api/system.threading.threadpool.setminthreads?view=net-7.0) of the applications [ThreadPool](https://learn.microsoft.com/en-us/dotnet/standard/threading/the-managed-thread-pool) that are created on demand, as new requests are made, before switching to an algorithm for managing thread creation and destruction. This can improve e.g. the IP scanner or port scanner. The value is added to the default settings. + +Type: `Integer` + +Default: `512` [Min `0`, Max `1024`] + +:::note + +The value 0 leaves the default settings (number of CPU threads). If the value is to high, performance problems may occur. If the value is higher than the max. threads of the ThreadPool, the max. threads will be used. Changes to this value will take effect after restarting the application. Wheter the value was set successfully can be seen in the log file under `%LocalAppData%\NETworkManager\NETworkManager.log`. + +::: diff --git a/Website/docs/settings/hotkeys.md b/Website/docs/settings/hotkeys.md new file mode 100644 index 0000000000..64b6153639 --- /dev/null +++ b/Website/docs/settings/hotkeys.md @@ -0,0 +1,15 @@ +--- +sidebar_position: 6 +--- + +# HotKeys + +### Untray / Bring to foreground + +Untray the application and bring it to the foreground. + +**Type:** `Boolean` + +**Default:** `Disabled` + +**Default Hotkey:** `ALT + STRG + O` diff --git a/Website/docs/settings/language.md b/Website/docs/settings/language.md new file mode 100644 index 0000000000..eb6a322d83 --- /dev/null +++ b/Website/docs/settings/language.md @@ -0,0 +1,25 @@ +--- +sidebar_position: 3 +--- + +# Language + +### Language + +Language for the user interface of the application. + +**Type:** `NETworkManager.Localization.LocalizationInfo` + +**Default:** `English` (`en-US`) + +:::note + +The language is automatically detected based on the system language. If the language is not available, the default language is used. Changes to this value will take effect after restarting the application. + +::: + +:::info + +English and German are provided as official languages. Other languages are provided by the community. If you want to help translate the application, you can join the project on [Transifex](https://transifex.com/BornToBeRoot/NETworkManager). Please report any issues with the translations on [GitHub](https://github.com/BornToBeRoot/NETworkManager/issues/new/choose). See also the [contribution guidelines](https://github.com/BornToBeRoot/NETworkManager/blob/main/CONTRIBUTING.md). + +::: \ No newline at end of file diff --git a/Website/docs/settings/network.md b/Website/docs/settings/network.md new file mode 100644 index 0000000000..14f48eb35f --- /dev/null +++ b/Website/docs/settings/network.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 4 +--- + +# Network + +### Use custom DNS server + +Enables or disables the custom DNS server(s) for all DNS queries. If disabled, the DNS servers configured in Windows are used. If enabled, the servers configured under [DNS server(s)](#dns-servers) will be used. + +**Type:** `Boolean` + +**Default:** `Disabled` + +### DNS server(s) + +A semicolon-separated list of IP addresses of DNS servers to be used for DNS queries when [Use custom DNS server](#use-custom-dns-server) is enabled. + +**Type:** `String` + +**Default:** `Empty` + +**Example:** `1.1.1.1; 1.0.0.1` + +### Preffered protocol when resolving hostnames: + +Set the preferred protocol when resolving hostnames. + +**Type:** `Boolean` + +**Default:** `IPv4` + +**Possible values:** + +- `IPv4` +- `IPv6` diff --git a/Website/docs/settings/profiles.md b/Website/docs/settings/profiles.md new file mode 100644 index 0000000000..aeb4bd4f7e --- /dev/null +++ b/Website/docs/settings/profiles.md @@ -0,0 +1,42 @@ +--- +sidebar_position: 9 +--- + +# Profiles + +### Location + +Folder where the application profiles are stored. + +**Type**: `String` + +**Default**: + +| Version | Path | +| -------------- | ------------------------------------------------- | +| Setup / Archiv | `%UserProfile%\Documents\NETworkManager\Profiles` | +| Portable | `\Profiles` | + +:::note + +It is recommended to backup the above files on a regular basis. + +To restore the profiles, close the application and copy the files from the backup to the above location. + +::: + +### Profiles + +List of profile files. + +**Type**: `List` + +**Default**: `[Default]` + +:::note + +Profile files can be encrypted with a master password. Right click on a profile and select `Encryption... > Enable encryption...`. See [FAQ > How to enable profile file encryption?](https://borntoberoot.net/NETworkManager/FAQ/ProfileFileEncryption) for more details. + +At least one profile is required and must exist. + +::: diff --git a/Website/docs/settings/settings.md b/Website/docs/settings/settings.md new file mode 100644 index 0000000000..5bf0b9e593 --- /dev/null +++ b/Website/docs/settings/settings.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 10 +--- + +# Settings + +### Location + +Folder where the application settings are stored. + +**Type**: `String` + +**Default**: + +| Version | Path | +| -------------- | ------------------------------------------------- | +| Setup / Archiv | `%UserProfile%\Documents\NETworkManager\Settings` | +| Portable | `\Settings` | + +:::note +It is recommended to backup the above files on a regular basis. + +To restore the settings, close the application and copy the files from the backup to the above location. + +::: + +### Reset + +Button to reset all application settings to their default values. + +:::note + +The application will be restarted afterwards. + +Profiles are not reset. + +::: diff --git a/Website/docs/settings/status.md b/Website/docs/settings/status.md new file mode 100644 index 0000000000..666c584b78 --- /dev/null +++ b/Website/docs/settings/status.md @@ -0,0 +1,27 @@ +--- +sidebar_position: 5 +--- + +# Status + +### Show status window on network change + +Show the status window when the network changes (e.g. Ethernet cable is plugged in, WLAN or VPN is connected, etc.). + +**Type:** `Boolean` + +**Default:** `Enabled` + +### Time in seconds how long the status window is shown + +Time in seconds how long the status window is shown after the network has changed. The status window will be closed automatically after the specified time. + +**Type:** `Integer` + +**Default:** `10` + +:::note + +This will only work if [Show status window on network change](#show-status-window-on-network-change) is enabled and the status window is opened due to a network change event. + +::: diff --git a/Website/docs/settings/update.md b/Website/docs/settings/update.md index ce07445efd..565a74fefe 100644 --- a/Website/docs/settings/update.md +++ b/Website/docs/settings/update.md @@ -1,5 +1,5 @@ --- -sidebar_position: 0 +sidebar_position: 8 --- # Update diff --git a/Website/docs/settings/window.md b/Website/docs/settings/window.md new file mode 100644 index 0000000000..56a81e7941 --- /dev/null +++ b/Website/docs/settings/window.md @@ -0,0 +1,59 @@ +--- +sidebar_position: 1 +--- + +# Window + +### Minimize main window instead of terminating the application + +Minimize the main window instead of terminating the application when the close button is clicked. + +**Type:** `Boolean` + +**Default:** `Disabled` + +### Minimize to tray instead of taskbar + +Minimize the main window to the tray instead of the taskbar when the minimize (or close) button is clicked. + +**Type:** `Boolean` + +**Default:** `Disabled` + +### Confirm close + +Show a confirmation dialog when the close button is clicked. + +**Type:** `Boolean` + +**Default:** `Disabled` + +### Multiple instances + +Allow multiple instances of the application to be opened. + +**Type:** `Boolean` + +**Default:** `Disabled` + +:::warning + +Enabling this setting is not recommended. Multiple instances of the application share the same settings and profile files. The last instance to be closed may overwrite changes made by other instances. + +::: + +### Always show tray icon + +Always show the tray icon, even if the main window is visible. + +**Type:** `Boolean` + +**Default:** `Disabled` + +### Show splash screen + +Show the splash screen when the application is started. + +**Type:** `Boolean` + +**Default:** `Enabled`