Skip to content

Commit fedc544

Browse files
committed
Docs: Add some docs
1 parent 360ad30 commit fedc544

File tree

4 files changed

+34
-7
lines changed

4 files changed

+34
-7
lines changed

Source/NETworkManager.Settings/LocalSettingsManager.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ public static void Load()
9999

100100
return;
101101
}
102-
102+
103103
Initialize();
104104
}
105105

Website/docs/changelog/next-release.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,25 @@ Release date: **xx.xx.2025**
3838
Starting with this release, new profile and settings files are created in `JSON` format. Existing `XML` files will be converted automatically on first load after upgrading. Automatic support for the migration will be provided until at least `2027`; after that only `JSON` files will be supported and very old installations may require an interim update.
3939

4040
The migration process creates a backup of the original files in the `Backups` subfolder of the settings and profiles directories. You can restore the originals from that folder if needed (they will work with the privous version), but it's **recommended to make a separate backup of your profile and settings files before updating**. If you encounter any issues during or after the migration, please report them via the [issue tracker](https://github.com/BornToBeRoot/NETworkManager/issues/new/choose).
41-
41+
4242
:::
4343

4444
## What's new?
4545

46+
- [System-Wide Policies](../system-wide-policies.md) for enterprise deployment and management. Administrators can now configure system-wide policies via a `config.json` file in the application directory to control specific settings for all users. This allows for centralized management of application behavior in enterprise environments. [#3313](https://github.com/BornToBeRoot/NETworkManager/pull/3313) [#3326](https://github.com/BornToBeRoot/NETworkManager/pull/3326)
47+
48+
Currently supported policies include (more will be added in future releases):
49+
- Check for updates at startup (see [Update > Check for updates at startup](../settings/update.md#check-for-updates-at-startup) documentation for more information)
50+
- Settings folder location (see [Settings > Location](../settings/settings.md#location) documentation for more information)
51+
52+
:::note
53+
54+
If you have specific requirements for system-wide policies in your organization, please submit a feature request via the [GitHub issue tracker](https://github.com/BornToBeRoot/NETworkManager/issues/new/choose).
55+
56+
:::
57+
4658
- New language Ukrainian (`uk-UA`) has been added. Thanks to [@vadickkt](https://github.com/vadickkt) [#3240](https://github.com/BornToBeRoot/NETworkManager/pull/3240)
4759
- Migrated all dialogs to child windows for improved usability and accessibility. [#3271](https://github.com/BornToBeRoot/NETworkManager/pull/3271)
48-
- System-wide policies can now be configured via a `config.json` file in the application directory to control settings for all users. Currently supports controlling the "Check for updates at startup" setting. This is useful for enterprise deployments where administrators need centralized control over update behavior. See [System-Wide Policies](../system-wide-policies.md) documentation for more information. [#3313](https://github.com/BornToBeRoot/NETworkManager/pull/3313)
4960

5061
**DNS Lookup**
5162

Website/docs/settings/settings.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,22 +19,30 @@ Folder where the application settings are stored.
1919

2020
:::info System-Wide Policy
2121

22+
<details>
23+
<summary>Click to expand</summary>
24+
2225
This setting can be controlled by administrators using a system-wide policy. See [System-Wide Policies](../system-wide-policies.md) for more information.
2326

2427
**Policy Property:** `SettingsFolderLocation`
2528

2629
**Values:**
27-
- Path like `C:\\Path\\To\\Settings` or `%UserProfile%\\NETworkManager\\Settings` - Force a custom settings folder location for all users
28-
- Omit the property - Allow the default location logic to apply (portable vs. non-portable)
30+
31+
- Absolute path (e.g., `C:\\Path\\To\\Settings`)
32+
- Path with environment variables (e.g., `%UserProfile%\\NETworkManager\\Settings`)
33+
- UNC path (e.g., `\\\\server\\share$\\NETworkManager\\Settings`)
34+
- Omit the property to allow the default location logic to apply (portable vs. non-portable)
2935

3036
**Example:**
3137

3238
```json
3339
{
34-
"SettingsFolderLocation": "C:\\CustomPath\\NETworkManager\\Settings"
40+
"SettingsFolderLocation": "%UserProfile%\\NETworkManager\\Settings"
3541
}
3642
```
3743

44+
</details>
45+
3846
:::
3947

4048
:::note
@@ -44,12 +52,14 @@ It is strongly recommended to regularly back up your settings files.
4452

4553
**Automatic backups**
4654
NETworkManager automatically creates a backup of the settings files before applying any changes. See [Create daily backup](#create-daily-backup) and [Maximum number of backups](#maximum-number-of-backups) for configuration options.
55+
4756
- Location: `Settings\Backups` subfolder
4857
- Naming: timestamped (e.g. `yyyyMMddHHmmss_Settings.json`)
4958
- Frequency: **once per day** at most (even if multiple changes occur)
5059
- Retention: keeps the **10 most recent backups** (default)
5160

52-
**Restoring settings**
61+
**Restoring settings**
62+
5363
1. Completely close NETworkManager
5464
2. Locate the desired backup in `Settings\Backups`
5565
3. Copy the file(s) back to the original folder (overwriting existing files)

Website/docs/settings/update.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,15 @@ Check for new program versions on GitHub when the application is launched.
1414

1515
:::info System-Wide Policy
1616

17+
<details>
18+
<summary>Click to expand</summary>
19+
1720
This setting can be controlled by administrators using a system-wide policy. See [System-Wide Policies](../system-wide-policies.md) for more information.
1821

1922
**Policy Property:** `Update_CheckForUpdatesAtStartup`
2023

2124
**Values:**
25+
2226
- `true` - Force enable automatic update checks at startup for all users
2327
- `false` - Force disable automatic update checks at startup for all users
2428
- Omit the property - Allow users to control this setting themselves
@@ -31,6 +35,8 @@ This setting can be controlled by administrators using a system-wide policy. See
3135
}
3236
```
3337

38+
</details>
39+
3440
:::
3541

3642
:::note

0 commit comments

Comments
 (0)