diff --git a/mRemoteNGDocumentation/index.rst b/mRemoteNGDocumentation/index.rst index dcc26709..e7b865f3 100644 --- a/mRemoteNGDocumentation/index.rst +++ b/mRemoteNGDocumentation/index.rst @@ -11,6 +11,8 @@ Welcome to mRemoteNG's documentation! protocols.rst keyboard_shortcuts.rst sql_configuration.rst + registry_settings_information.rst + registry_settings_guide.rst command_line_switches.rst themes.rst diff --git a/mRemoteNGDocumentation/registry/updates_settings.rst b/mRemoteNGDocumentation/registry/updates_settings.rst new file mode 100644 index 00000000..1dc81cd9 --- /dev/null +++ b/mRemoteNGDocumentation/registry/updates_settings.rst @@ -0,0 +1,206 @@ +.. _updates_settings: + +****************** +Updates Settings +****************** +.. versionadded:: v1.77.3 + +.. warning:: + Before proceeding with any changes to the Windows Registry, it is imperative that you carefully read and comprehend the + **Modifying the Registry**, **Restricted Registry Settings** and **Disclaimer** + on :doc:`Registry Settings Infromation `. + + +Common settings +=============== +These settings are defined for global configuration. + + +AllowCheckForUpdates +-------------------- +Allows or disallows checking for updates. + +- **Registry Hive:** HKEY_LOCAL_MACHINE +- **Registry Path:** SOFTWARE\\mRemoteNG\\Updates +- **Value Name:** AllowCheckForUpdates +- **Value Type:** REG_SZ +- **Values:** + + - **Enable (default):** true + - **Disable:** false + + +AllowCheckForUpdatesAutomatical +------------------------------- +Allows or disallows automatic search for updates. + +- **Registry Hive:** HKEY_LOCAL_MACHINE +- **Registry Path:** SOFTWARE\\mRemoteNG\\Updates +- **Value Name:** AllowCheckForUpdatesAutomatical +- **Value Type:** REG_SZ +- **Values:** + + - **Enable (default):** true + - **Disable:** false + +.. note:: + If "AllowCheckForUpdates" is set to false, the automatic update check is already disabled. + + +AllowCheckForUpdatesManual +-------------------------- +Allows or disallows manual search for updates. + +- **Registry Hive:** HKEY_LOCAL_MACHINE +- **Registry Path:** SOFTWARE\\mRemoteNG\\Updates +- **Value Name:** AllowCheckForUpdatesManual +- **Value Type:** REG_SZ +- **Values:** + + - **Enable (default):** true + - **Disable:** false + +.. note:: + If "AllowCheckForUpdates" is set to false, the automatic update check is already disabled. + + +AllowPromptForUpdatesPreference +------------------------------- +Controls whether a prompt for checking the updates preferences is displayed at startup. + +- **Registry Hive:** HKEY_LOCAL_MACHINE +- **Registry Path:** SOFTWARE\\mRemoteNG\\Updates +- **Value Name:** AllowPromptForUpdatesPreference +- **Value Type:** REG_SZ +- **Values:** + + - **Enable:** true + - **Disable:** false + + +Option Page Settings +==================== +Configure the options page to modify functionalities as described. + + +CheckForUpdatesFrequencyDays +---------------------------- +Specifies the number of days between automatic update checks. + +- **Registry Hive:** HKEY_LOCAL_MACHINE +- **Registry Path:** SOFTWARE\\mRemoteNG\\Updates\\Options +- **Value Name:** CheckForUpdatesFrequencyDays +- **Value Type:** REG_DWORD + +.. note:: + If 'AllowCheckForUpdates' is set to false, the automatic update check is already disabled, and 'CheckForUpdatesFrequencyDays' does not take effect. + + +UpdateChannel +------------- +Specifies the preferred update channel. Important note: Values are case-sensitive! + +- **Registry Hive:** HKEY_LOCAL_MACHINE +- **Registry Path:** SOFTWARE\\mRemoteNG\\Updates\\Options +- **Value Name:** UpdateChannel +- **Value Type:** REG_SZ +- **Values:** + + - Channel: Stable + - Channel: Nightly + - Channel: Preview + + +UseProxyForUpdates +------------------ +Indicates whether proxy usage for updates is enabled. + +- **Registry Hive:** HKEY_LOCAL_MACHINE +- **Registry Path:** SOFTWARE\\mRemoteNG\\Updates\\Options +- **Value Name:** UseProxyForUpdates +- **Value Type:** REG_SZ +- **Values:** + + - Enable: true + - Disable: false + + +ProxyAddress +------------ +Specifies the address of the proxy for updates. + +- **Registry Hive:** HKEY_LOCAL_MACHINE +- **Registry Path:** SOFTWARE\\mRemoteNG\\Updates\\Options +- **Value Name:** ProxyAddress +- **Value Type:** REG_SZ + +.. note:: + If 'UseProxyForUpdates' is disabled, these settings do not take effect. + + +ProxyPort +--------- +Specifies the port used for proxy connections during updates. + +- **Registry Hive:** HKEY_LOCAL_MACHINE +- **Registry Path:** SOFTWARE\\mRemoteNG\\Updates\\Options +- **Value Name:** ProxyPort +- **Value Type:** REG_DWORD + +.. note:: + If 'UseProxyForUpdates' is disabled, these settings do not take effect. + + +UseProxyAuthentication +---------------------- +Indicates whether proxy authentication is enabled. + +- **Registry Hive:** HKEY_LOCAL_MACHINE +- **Registry Path:** SOFTWARE\\mRemoteNG\\Updates\\Options +- **Value Name:** UseProxyAuthentication +- **Value Type:** REG_SZ +- **Values:** + - Enable Value: true + - Disable Value: false + +.. note:: + If 'UseProxyForUpdates' is disabled, these settings do not take effect. + + +ProxyAuthUser +------------- +Specifies the authentication username for the proxy. + +- **Registry Hive:** HKEY_LOCAL_MACHINE +- **Registry Path:** SOFTWARE\\mRemoteNG\\Updates\\Options +- **Value Name:** ProxyAuthUser +- **Value Type:** REG_SZ + +.. note:: + If 'UseProxyForUpdates' is disabled, these settings do not take effect. + +.. note:: + If 'ProxyAuthUser' is disabled, these settings do not take effect. + +ProxyAuthPass +------------- +(currently not supported) +Represents the authentication password for the proxy. + +.. warning:: + + Do not store decrypted passwords in the registry! + + Storing decrypted passwords in the registry poses a significant security risk and is strongly discouraged. It can expose sensitive information, compromise user credentials, and lead to unauthorized access. Always follow best security practices and avoid storing plaintext passwords in any form, including the registry. + + +- **Registry Hive:** HKEY_LOCAL_MACHINE +- **Registry Path:** SOFTWARE\\mRemoteNG\\Updates\\Options +- **Value Name:** ProxyAuthPass +- **Value Type:** REG_DWORD + +.. note:: + If 'UseProxyForUpdates' is disabled, these settings do not take effect. + +.. note:: + If 'ProxyAuthUser' is disabled, these settings do not take effect. \ No newline at end of file diff --git a/mRemoteNGDocumentation/registry_settings_guide.rst b/mRemoteNGDocumentation/registry_settings_guide.rst new file mode 100644 index 00000000..a6ff9618 --- /dev/null +++ b/mRemoteNGDocumentation/registry_settings_guide.rst @@ -0,0 +1,20 @@ +.. _registry_settings_guide: + +**************************** +Registry Settings Guide +**************************** + +.. warning:: + Before proceeding with any changes to the Windows Registry, it is imperative that you carefully read and comprehend the + **Modifying the Registry**, **Restricted Registry Settings** and **Disclaimer** + on :doc:`Registry Settings Infromation `. + + +The following registry settings are used by mRemoteNG to configure various options and behavior. +Please note that incorrect modifications to these settings can impact the functionality of mRemoteNG. +Make changes with caution and ensure that you have backups before making any adjustments. + +.. toctree:: + :maxdepth: 4 + + registry/updates_settings \ No newline at end of file diff --git a/mRemoteNGDocumentation/registry_settings_information.rst b/mRemoteNGDocumentation/registry_settings_information.rst new file mode 100644 index 00000000..c891c9af --- /dev/null +++ b/mRemoteNGDocumentation/registry_settings_information.rst @@ -0,0 +1,108 @@ +.. _registry_settings_information: + +***************************** +Registry Settings Information +***************************** + +.. warning:: + Before proceeding with any changes to the Windows Registry, it is imperative that you carefully read and comprehend the + :ref:`Modifying the Registry `, :ref:`Restricted Registry Settings ` + and :ref:`Disclaimer `. + + +.. _warning_modifying_registry: + +Modifying the Registry +====================== + +Making changes to the Windows Registry is a sensitive and advanced operation. Incorrect modifications can lead to system instability, +data loss, or even render your operating system unusable. Proceed with caution and follow these guidelines: + +1. **Backup Registry:** Before making any changes, create a backup of the Registry. This ensures that you can restore it to a working state if issues arise. + +2. **Know What You're Doing:** Only modify the Registry if you understand the implications of your changes. Incorrect values or deletions can affect system functionality and applications. + +3. **Documentation:** Document the changes you make. Include details such as the date, purpose, and the specific keys/values altered. This documentation can be crucial for troubleshooting later. + +4. **Create System Restore Point:** Create a System Restore Point before proceeding. This provides an additional layer of recovery in case problems occur. + +5. **Registry Editor:** Use the built-in Registry Editor (`regedit`) to make changes. Avoid third-party tools unless you are confident in their reliability. + +6. **One Change at a Time:** Make one change at a time and test its impact before proceeding to the next. This helps identify the cause if issues arise. + +7. **Verify Information:** Double-check the information you find online before applying it to your Registry. Incorrect instructions can lead to problems. + +8. **Permissions:** Be cautious with changing permissions. Modifying permissions incorrectly can result in restricted access to important system components. + +9. **Seek Professional Help:** If you are uncertain or uncomfortable with Registry modifications, seek assistance from knowledgeable professionals. + +10. **Emergency Plan:** Have a plan in case something goes wrong. Know how to restore your Registry from the backup or the System Restore Point. + +By acknowledging these warnings and following best practices, you can minimize the risks associated with making changes to the Windows Registry. + + +.. _warning_restricted_registry_setting: + +Restricted Registry Settings +============================ + +This specific registry setting is intentionally restricted, and users do not have default permissions to modify it. +Even if you possess administrative rights on your system, any changes to this registry entry are prohibited by default. + +Attempting to alter this registry entry without proper authorization or without following specific instructions from your system +administrator may result in adverse effects on system stability, security, or functionality. +Any unauthorized changes can lead to unintended consequences, system errors, or even render your operating system inoperable. + +If you require adjustments to this registry setting, please consult with your system administrator or IT support. +They can provide guidance, assess the implications of any changes, and implement the necessary modifications following established procedures. + +Exercise caution, adhere to your organization's policies, and avoid making unauthorized alterations to the Windows Registry, +as it can impact the overall integrity and performance of your system. + + +.. _How_to_open_the_Windows_Registry: + +How to open the Windows Registry +================================ + +The Windows Registry is a crucial component for system configuration. Here's a guide on how to open the Registry on Windows: + +**Using Run Dialog:** + - Press `Win + R` to open the Run dialog. + - Type `regedit` and press Enter. + - The Registry Editor will open. + +**Create Desktop Shortcut:** + - Right-click on the desktop. + - Choose "New" -> "Shortcut." + - Enter `regedit` as the location and click "Next." + - Provide a name for the shortcut and click "Finish." + + +.. _disclaimer: + +Disclaimer +========== +Any changes made by yourself to the system settings, including but not limited to the Windows Registry, are undertaken at your own risk. +mRemoteNG shall not be held liable for any consequences arising from user-initiated modifications. + +Please be advised of the following: + +1. **User Responsibility:** + - You, as the user, are solely responsible for the changes made to system configurations. + +2. **No Liability Assumed:** + - mRemoteNG do not assume any liability for potential issues, damages, or data loss resulting from user-initiated modifications. + +3. **Recommended Best Practices:** + - Users are encouraged to adhere to recommended best practices, such as creating backups and seeking professional assistance when necessary. + +4. **System Stability:** + - Modifications to system settings, including the Windows Registry, can impact system stability. It is essential to exercise caution and fully understand the implications of changes. + +5. **Professional Assistance:** + - If you are uncertain about specific configurations or require assistance, consider consulting with professional support services. + +By proceeding with user-initiated changes, you acknowledge and accept the responsibility for any potential consequences that may arise. This disclaimer applies to all adjustments made independently by users. + +Thank you for your understanding and cooperation.