| The Connection File |
| 3. Locate the Connection File (.nxs) |
By default, .nxs files are stored in the directory defined in the 'Connections and recordings' field from the Settings -> Player -> Folders panel of the User Interface. By default:
/home/USERNAME/Documents/NoMachine on Linux
/Users/USERNAME/Documents/NoMachine on macOS
%USERPROFILE%\Documents\NoMachine on Windows
Per-session settings are defined in these files.
| 3.1. Preconfigure IP or Hostname of the NoMachine server |
<option key="Server host" value="" />
| 3.2. Preconfigure Connections by SSH Protocol |
<option key="Connection service" value="ssh" />
<option key="Server port" value="22" />
<option key="Server authentication method" value="system" />
<option key="System login method" value="password" />
Accepted values are: 'password', 'privatekey', 'smartcardkey','kerberos'.
The client will connect to SSHD as system user.
| 3.3. Preconfigure Connections by NX Protocol |
<option key="Connection service" value="nx" />
<option key="NoMachine daemon port" value="4000" />
<option key="NX login method" value="password" />
Accepted values are: 'password' or 'privatekey'.
| 3.4. Preconfigure Username and Password |
<option key="User" value="" />
<option key="Auth" value="EMPTY_PASSWORD" />
Password must be scrambled with the following algorythm: https://www.nomachine.com/AR01C00125
| 3.5. Set the Remote Node to be Connected (Manual Node Selection Enabled) |
<option key="Connect to this node when manual selection is enabled" value="" />
Value is the name of the node as it appears in the output of 'nxserver --nodelist', i.e. in the format IP or hostname:port. The connection will be started on the remote node specified in this key, even if the possibility to choose the remote node (manual node selection) is enabled on the server.
This key applies to multi-node environments only (Enterprise Terminal Server + Terminal Server Nodes)
| 3.6. Choose the Virtual Desktop (X, RDP or VNC) |
<option key="Session" value="" />
Accepted valuse are: 'unix', 'windows' or 'vnc'. 'windows' indicates RDP sessions.
| 3.7. Preconfigure the (X) Virtual Desktop |
<option key="Session" value="unix" />
<option key="Desktop" value="" />
Accepted values are: 'xsession-default', 'kde', 'gnome', 'xdm' or 'console'.
Value 'xsession-default' will start the default desktop environment as set on the system and specified in the DefaultDesktopCommand node configuration key.
Value 'console' specifies a custom session.
| 3.8. Preconfigure the Custom Session |
<option key="Session" value="unix" />
<option key="Desktop" value="console" />
<option key="Custom Unix Desktop" value="" />
Accepted values are: 'application', 'default' or 'console'.
| 3.9. Preconfigure the Application to be run in the Custom Session |
<option key="Session" value="unix" />
<option key="Desktop" value="console" />
<option key="Custom Unix Desktop" value="application" />
<option key="Command line" value="" />
Specify path to the command to be executed in the value field.
| 3.10. Run a Custom Session in a Floating Window |
<option key="Session" value="unix" />
<option key="Desktop" value="console" />
<option key="Virtual desktop" value="false" />
| 3.11. Run a Custom Session in a Virtual Desktop |
<option key="Session" value="unix" />
<option key="Desktop" value="console" />
<option key="Virtual desktop" value="true" />
| 3.12. Do not Show Informative Messages at Session Startup |
Message to enable/disable the remote audio:
<option key="Show remote audio alert message" value="false" />
Message to enable/disable the selection of desktop view mode:
<option key="Show remote desktop view mode message" value="false" />
Message to enable/disable resizing the remote desktop to the size of the client window or monitor:
<option key="Show remote display resize message" value="false" />
Accepted values are: 'true' or 'false'.
| 3.13. Resize the Remote Desktop to the Client Window at Session Startup |
<option key="Resize the remote screen upon connecting" value="no" />
Accepted values are:
no - never make resize of the remote screen
screen - resize the remote screen to the size of the client's screen
window - resize the remote screen to the size of the client's window.
| 3.14. Adapt the Remote Desktop to the Client Window when it's Resized |
<option key="Enable physical desktop auto-resize" value="false" />
<option key="Enable virtual desktop auto-resize" value="false" />
Accepted values are: 'true' or 'false'.
| 3.15. Preconfigure Size of the Client Window |
<option key="Resolution" value="" />
Value must be specified in the format of 'WxH', e.g. 1024x768.
This option makes the client to ask the remote desktop to start with the given resolution. The remote desktop can ignore this setting if it has a different configuration stored in desktop manager settings or if the 'Resize the remote screen to the local geometry' or the 'Enable session auto-resize' option are enabled (set to 'true').
Predefining the size of the client window may be problematic when it is running in windowed mode. The size of the window depends from the resize mode, from the available desktop geometry and from the behaviour of the remote desktop manager. Using the NXS file to preconfigure the window size behaviour may not work as expected.
| 3.16. Send the Client Session Window at Fullscreen on All Monitors |
<option key="Session window state" value="multiscreen" />
Accepted values are 'normal', 'fullscreen' or 'multiscreen'.
Exiting from the multiscreen mode will override this setting.
Multi-screen for the main window has to be enabled in the player.cfg file.
| 3.17. Preconfigure How the Client will Show the Remote Session |
<option key="Physical desktop resize mode" value="scaled" />
<option key="Virtual desktop resize mode" value="viewport" />
Accepted values are: 'viewport' or 'scaled'.
When value is 'scaled', the remote desktop is scaled to fit the client window.
| 3.18. Set the Highest Quality Display |
<option key="Link quality" value="9" />
Accepted values are from 1 to 9.
| 3.19. Set the Highest Quality Display |
<option key="Disable network-adaptive quality" value="true" />
Accepted values are: 'true' or 'false'.
| 3.20. Disable Client Side Image Post-Processing |
<option key="Disable image post-processing" value="true" />
Accepted values are: 'true' or 'false'.
Please note that post processing is made only on client side. This change will not affect server side. |
