NoMachine Support

Your questions answered

Knowledge Base

Searching in: Documents
Filter the search results
Version:
Last update:
Searching in: Documents
ID: DT03O00130
Version: NoMachine 6
Added on: 2017-03-13
Last update: 2018-12-14
NoMachine Small Business Server Guide - Installation and Configuration Guide
Table of Contents
Introduction
1. NoMachine Small Business Server - Installation and Configuration User Interface
1.1. About This Guide
How to set-up the Small Business Server
2. Install the Small Business Server
2.1. Prerequisites
2.2. Linux Installations
2.3. RPM Packages
2.4. DEB Packages
2.5. TAR.GZ Packages
2.6. Activating the License (for Customers)
Connect to the Small Business Server
3. Initiating a NoMachine Connection (end-user's side)
3.1. Connecting by Browsers Via Small Business Server Web Tools
3.2. Connecting by NoMachine Client
3.3. Preventing Users from Storing their Credentials
Configurations and Optimizations
4. Configuring NoMachine Small Business Server
4.1. Configuring Web Sessions
4.2. Managing Small Business Server Web Services
4.3. Using an Alternative Apache Web Server
4.4. Web Optimizations: Using WebRTC (Real-Time Web Communication)
5. Compression Techniques and Optimizations
5.1. Video Streaming Encoding in Web Sessions
5.2. Video Streaming Encoding in Client Sessions
5.3. The X11 Vector Graphics Mode in Client Sessions
5.4. Supporting OpenGL Applications in Virtual Sessions
Administration of Small Business Server
6. Small Business Server Configuration
6.1. Configuration Files
7. Services Management
7.1. Accepting Connections
7.2. Stopping and Starting Small Business Server and Services
7.3. Stopping and Starting Network Services
7.4. Local and Network Ports
7.5. Hiding the NoMachine Monitor and Notification Messages
7.6. Hiding the Whiteboard and Chat Tools
7.7. Handling of Discovering of this Server on LAN
8. Notifications to Users
8.1. Whiteboard and Custom Notifications
8.2. Greeting Messages
9. Supported Connection Protocols and Authentication Methods
9.1. Defining Protocol in Server Configuration
9.2. Locking Down the Accepted Authentication Methods
9.3. Changing Port for the NX Protocol
9.4. Changing Port for the SSH Protocol
9.5. Connecting to a Server Behind a Firewall (UPnP Port Mapping)
9.6. Using NoMachine DBs for Managing User Access
10. User Management
10.1. Managing Users on the Small Business Server Host
10.2. Connecting with a Privileged System Account
10.3. Connecting to Virtual Desktops as NoMachine Trusted User
11. Managing Users Session Management
11.1. Monitoring Sessions
11.2. Managing Sessions
11.3. Setting a Virtual Desktop Environment on Linux
11.4. Executing Custom Scripts on Server/Node Events
12. Collaborative Virtual Desktops and Connections to the Physical Desktop
12.1. Disabling Connections to Virtual Desktops
12.2. Configuring Interaction Level to Virtual Desktops
12.3. Configuring Authorization to Connect to Virtual Desktops
12.4. Connections to Physical Desktop
13. Device Sharing, Copy&Paste and File Transfer
13.1. Connecting Devices
13.2. Disks
13.3. Printers
13.4. USB Devices
13.5. Network Ports
13.6. Smartcard Readers
13.7. Copy and Paste Operations
13.8. Transferring Files
14. Multimedia and Session Recording
14.1. Supporting Audio and Microphone
14.2. Recording your Screen
15. Automatic Updates
16. Behavior of NoMachine 6 vs. Legacy Servers
16.1. Listing the Available Desktop Types
16.2. Activating the Disconnect/Terminate Dialog
17. Logging Facilities
17.1. Using the System Logging Facilities
17.2. Redirecting Logs to a Custom File
17.3. Configuring the Automatic Clean-up of Session Directories


Introduction
1. NoMachine Small Business Server Installation and Configuration User Interface

Welcome to the NoMachine Small Business Server - Installation and Configuration Guide v. 6.


What is NoMachine Small Business Server for?
NoMachine Small Business Server is a standalone server for Linux that allows up to ten concurrent virtual desktops to run on the host where it is installed. Designed to offer individual instances of the remote desktop (terminal services), it provides users with their own separate desktop environment. With the Small Business Server each user has his/her own desktop or application, and can store, manage files inside the session and even share his/her own resources with another user.

Available for Linux, the Small Business Server accepts connections via a browser (thanks to its built-in web server) or via the NoMachine client.



A Graphical Interface
The NoMachine Small Business Server server package includes the NoMachine User Interface which provides the graphical interface (Server preferences) for administering the server and its services. This User Interface acts also as client for running sessions and connecting to remote desktops.

The most common operations detailed in this User Interface can be performed by the NoMachine UI and the Server preferences panel running on the local installation of the server:

More details about the Server preferences User Interface can be found in the dedicated User Interface available in the Documents section at: https://www.nomachine.com/all-documents



The server is fully operative once installed
Installation provides a fully operative NoMachine server with a default configuration suitable for the majority of environments. All the necessary services are automatically started.



A standalone server
NoMachine Small Business Server is a single server (standalone server) to all effects. NoMachine Small Business Server supports up to ten concurrent virtual desktops. A virtual desktop is an individual instance of the remote desktop. Sharing of a virtual desktop is also supported. The number of users is not limited.



1.1. About This User Interface

Document Conventions and Important Notices
The following conventions are used in this User Interface:

BaseDirectory
is the base directory where the NoMachine binaries and libraries are installed.
By default, BaseDirectory is: /usr.

InstallationDirectory
is: BaseDirectory/NX, i.e. /usr/NX.

The command line interface
NoMachine server and node programs have a command line interface to execute operations.


You need to be a privileged system user to access all these functionalities. These commands can be run from an xterm or similar using the sudo utility or as root.

On Linux invoke the 'nxserver' and 'nxnode' programs from /etc/NX, for example:

$ sudo /etc/NX/nxserver --status
Printing the server and node usage doesn't require to be a privileged user, instead:
$ /etc/NX/nxserver --help
$ /etc/NX/nxnode --help
The 'nxserver --help' and 'nxnode --help' display the list of all the available commands and options and their description.


Online Resources
Visit the NoMachine Support Area to access a variety of online resources including the NoMachine Forums, tutorials and FAQs: https://www.nomachine.com/support. Or log in to your customer area to open a support enquiry.

Find a list of all documents and tutorials: https://www.nomachine.com/all-documents

Use the Knowledge Base search engine to access articles, FAQs and self-help information: https://www.nomachine.com/knowledge-base


Leave Feedback About This User Interface
Our goal is to provide comprehensive and clear documentation for all NoMachine products. If you would like to send us your comments and suggestions, you can use the contact tool available at https://www.nomachine.com/contact-request, selecting Web Quality Feedback as your option.

2. Install the Small Business Server
2.1. Prerequisites

Supported Operating Systems

Linux 32-bit and 64-bit
Red Hat Enterprise 4/5/6/7
SLED 10.x/11.x/12.x,
SLES 10/11/12
Open SUSE 10.x/11.x/12.x/13.x/15.0/42.x
Mandriva 2009/2010/2011
Fedora 10/11/12/13/14/15/16/17/18/19/20/21/22/23/24/25/26/27/28
Debian GNU Linux 4.0 Etch/5.0 Lenny/ 6.0 Squeeze/ 7.0 Wheezy/ 8.0 Jessie/9.0 Stretch
Ubuntu 8.04 Hardy Heron/8.10 Intrepid Ibex/Ubuntu 9.04 Jaunty Jackalope/
9.10 Karmic Koala/10.4 Lucid Lynx/10.10 Maverick/11.04 Natty/11.10 Oneiric/
12.04 Precise Pangolin/12.10 Quantal Quetzal/13.04 Raring Ringtail/
13.10 Saucy Salamander/14.04 Trusty Tahr/14.10 Utopic Unicorn/15.04 Vivid Vervet/
15.10 Wily Werewolf/16.04 Xenial Xerus/16.10 Yakkety Yak/17.04 Zesty Zapus/
17.10 Artful Aardvark/18.04 Bionic Beaver



Hardware requirements
Intel Core2 Duo or AMD Athlon Dual-Core or equivalent
1 GB RAM
Network connection (either a LAN, or Internet link: broadband, cable, DSL, etc...)
Size required on disk:
Linux 195 MB



Software requirements
Connections by web and by NoMachine clients are supported. Although compatibility with clients v. 4 and 5 is preserved, it's advisable to upgrade client installations to the same version 6 of the Small Business Server. NoMachine v. 6 is not compatible with the legacy NX version 3.5.0 (no longer supported since December 2016).

2.2. Linux Installations

Installing for the first time
You can install, update and uninstall using the graphical package manager of your Linux distribution or from command line by running commands from an xterm or similar with the sudo utility, or as root user if you don't have sudo installed. Instructions below refer to installation by command line.

If you own a customer license we recommend to download the package from your Customer Area: https://www.nomachine.com/support#login.

Successive updates
The update procedure for server and node installations requires all NoMachine services to be stopped in order to correctly replace libraries and binaries. This implies that the Small Business Server is not accessible to users during the update procedure. Current sessions will be terminated, users will be able to connect again later.

There are two ways to update your current installation:

I Automatic updates

You can update your installation from our repositories. Just run the NoMachine User Interface from your Programs Menu and access the 'Settings' panel and click on 'Server preferences'. Go to the 'Updates' panel in the User Interface and click on the 'Check now' button.

NoMachine has the automatic check for updates enabled: it will check the repositories every two days to verify if updates are available. In this case, the server will prompt a dialog informing that a new version is available but it will never automatically update the current installation.

Checking for updates can be disabled from that dialog by selecting the 'Don't ask again for this version' option or in the Updates panel by unchecking the 'Automatically check for updates' option.

Detailed instructions for configuring the Automatic Updates are available in the Documents section on the NoMachine web site: https://www.nomachine.com/all-documents .

Note: Due to heavy changes between versions 5 and 6, automatic updates are disabled: it's therefore necessary to upgrade NoMachine Small Business Server v. 5 by manually installing packages (see below).

II Update with NoMachine packages

Alternatively, download the latest available package from the NoMachine web site and click on the executable file to launch Setup. As for the installation, Setup will User Interface you through all steps necessary for updating your installation.

If you own a customer license we recommend you download the package from your Customer Area: https://www.nomachine.com/support#login.

2.3. RPM Packages

If you want to install to default location, namely /usr/NX/:

INSTALL

# rpm -ivh <pkgName>_<pkgVersion>_<arch>.rpm
To find out which NoMachine package you have installed (you will get the full name of the package), run:
# rpm -qa | grep nomachine


UPDATE

# rpm -Uvh <pkgName>_<pkgVersion>_<arch>.rpm


UNINSTALL

# rpm -e nomachine-small-business-server


TIP
For non-default locations, for example /opt/NX:

INSTALL

# rpm -ivh <pkgName>_<pkgVersion>_<arch>.rpm --prefix /opt

UPDATE

# rpm -Uvh <pkgName>_<pkgVersion>_<arch>.rpm --prefix /opt

UNINSTALL

# rpm -e nomachine-small-business-server



2.4. DEB Packages

If you want to install to default location, namely /usr/NX/:

INSTALL

$ sudo dpkg -i <pkgName>_<pkgVersion>_<arch>.deb
To find out which NoMachine package you have installed (you will get the full name of the package), run:
$ dpkg -l | grep nomachine


UPDATE

$ sudo dpkg -i <pkgName>_<pkgVersion>_<arch>.deb


UNINSTALL

$ sudo dpkg -r nomachine-small-business-server


TIP
For non-default locations, for example /opt/NX:

INSTALL

$ sudo NX_INSTALL_PREFIX=/opt dpkg -i <pkgName>_<pkgVersion>_<arch>.deb

UPDATE

$ sudo NX_INSTALL_PREFIX=/opt dpkg -i <pkgName>_<pkgVersion>_<arch>.deb

UNINSTALL

$ sudo dpkg -r nomachine-small-business-server

2.5. TAR.GZ Packages

If you want to install to default location, namely /usr/NX/, ensure that package is placed there.

INSTALL

$ cd /usr
$ sudo tar xvzf <pkgName>_<pkgVersion>_<arch>.tar.gz
$ sudo /usr/NX/nxserver --install


UPDATE

$ cd /usr
$ sudo tar xvzf <pkgName>_<pkgVersion>_<arch>.tar.gz
$ sudo /usr/NX/nxserver --update


UNINSTALL

$ sudo /usr/NX/scripts/setup/nxserver --uninstall
$ sudo rm -rf /usr/NX


TIP
For non-default locations, for example /opt/NX:

INSTALL

$ sudo NX_INSTALL_PREFIX=/opt /usr/NX/nxserver --install

UPDATE

$ sudo NX_INSTALL_PREFIX=/opt /usr/NX/nxserver --update

UNINSTALL

$ sudo /opt/NX/scripts/setup/nxserver --uninstall
$ sudo rm -rf /opt/NX

2.6. Activating the License (for Customers)

The evaluation version
includes a 30-day license which is automatically activated during the installation. No further actions are necessary.

Customer packages
include a temporary (30-days) node.lic and server.lic files for evaluation.
Such license files have to be replaced with the customer's license files acquired from NoMachine. This can be done via the NoMachine server User Interface in the 'Updates' panel: click on the server.lic and node.lic links to open their license panel and replace the license.

You can find a User Interface for User Interface usage in the Documents section on the NoMachine web site: https://www.nomachine.com/all-documents. Look for the keyword 'license' to find out in the knowledge base, section 'Articles' how to activate licenses manually: https://www.nomachine.com/knowledge-base.

To verify from command line that server.lic and node.lic are correctly in place and check their validity, you can run:

$ sudo /etc/NX/nxserver --subscription
$ sudo /etc/NX/nxnode --subscription
$ sudo /etc/NX/nxserver --version
$ sudo /etc/NX/nxnode --version


3. Initiating a NoMachine Connection (end-user's side)

First of all, ensure that the user has a system account on the Small Business Server host: you can create it by using system tools or by using nxserver commands. Empty password is not supported.



3.1. Connecting by Browsers Via Small Business Server Web Tools

Once installation is complete, Small Business Server is ready to go.

The end-user should point the browser on his/her device to:

http://SERVER:4080

Where SERVER is either the name or IP address of the host you want to reach.

E.g., if Small Business Server is installed on a host named 'myserver.com', the URL will look like this:

http://myserver.com:4080

The connection will be automatically switched to HTTPS protocol:

https://myserver.com:4443/nxwebplayer

In the login form, the end-user has to provide username and password of his/her system account on the Small Business Server host and connect.

TIPS
I Auto-reconnection is supported: when the connection is lost for whatever reason (including when browser's computer has entered sleep mode), the NoMachine web application will automatically try to reconnect for as long as the user keeps the web page open. If reconnecting is not possible, then the user will have to reconnect manually.
II IPv6 is supported: specify the IP address of the server host in IPv6 format (e.g. 2001:0:5ef5:79fb:30c6:1516:3ca1:5695) if you want to use it instead of IPv4.


3.2. Connecting by NoMachine Client

From a client device, where you have already installed a NoMachine package type or the Enterprise Client, run the NoMachine User Interface from the programs or applications menu. A wizard will take you through the steps necessary to set-up your first connection, just click on 'Create a new connection'. If you prefer to skip the wizard, click on 'Continue'.

The fastest way to create a new connection is to write the name or IP of the NoMachine host you want to connect to in the text field and click on the 'Press enter to create a new connection' link. This method will use the default NX protocol on port 4000.

Alternatively, you can click on the 'New' icon next to the white text field to configure the session in more detail.

TIPS
I Auto-reconnection is supported: when the connection is lost for whatever reason (including when the client host has entered sleep mode), the client will automatically try to reconnect for as long as the user keeps the User Interface open. If reconnecting is not possible, then the user will have to reconnect manually.
II IPv6 is supported: specify the IP address of the server host in IPv6 format (e.g. 2001:0:5ef5:79fb:30c6:1516:3ca1:5695) if you want to use it instead of IPv4.




3.3. Preventing Users from Storing their Credentials

To prevent NoMachine users from storing their credentials, use the EnableCredentialsStoring key in the server configuration file. The accepted values are:
player Only users connected via NoMachine client are enabled to save username and password in the connection file stored on their devices (computer, tablet etc ...)
webplayer Only users connected via browser can choose to save their access credentials. They are stored in the browser's cookie, given that the user's browser has cookies enabled.
both All users, regardless if connected via NoMachine client or via web, can store their credentials.
none Users cannot save their username and password. They will be requested to provide their log-in credentials at each connection.

For example, to allow only users connecting via NoMachine client to store credentials, set in the server configuration file:
EnableCredentialsStoring player



4. Configuring NoMachine Small Business Server


4.1. Configuring Web Sessions

The configuration file for the web player program (which provides the graphical front-end) and the web client program (which manages web sessions) is server.cfg, located in the BaseDirectory/NX/etc directory on Linux: /usr/NX/etc/server.cfg.

Default settings
The Section directive defines settings for the NoMachine server(s) where the web player application will connect. This directive, by default, points to localhost and looks like:

Section "Server"

Name "Connection to localhost"
Host localhost
Protocol NX
Port 4000

EndSection

Name is a label that can be displayed as an alternative to show hostname of the server.
Host is IP or hostname of the NoMachine server host.
Protocol and Port indicates protocol and port that web player will use to connect to the NoMachine server.

Changing protocol and port
By default when users connect via web, they will use the NX protocol on port 4000. Supported protocols are NX and SSH with system login.

To use the NX protocol (this is the default), set:

Protocol NX
Port 4000

To use SSH protocol and system login, set:

Protocol system
Port 22



TIP
NoMachine uses by default port 22 for SSH protocol on Linux.The default port for NX protocol is 4000. In order to change the port for NX protocol, change the port for the nxd service and restart it. See the paragraph 'Connecting by NX Protocol'. To change the port for connections by SSH it's necessary to modify the listen port for the SSH server on the system.

Showing hostname or a custom label
To display hostname or IP of the Small Business Server host when connecting by the web, set the following key. This is the default:

EnableWebConnectionName 0

To display the label set in the 'Name' field of Section "Server" set:

EnableWebConnectionName 1



Hiding the tutorial wizard at web session startup
To not display the tutorial wizard for the menu panel at session startup, set:

EnableWebMenuTutorial 0

and to show it (this is the default):

EnableWebMenuTutorial 1



4.2. Managing Small Business Server Web Services

You can start and stop the NoMachine HTTP server (nxhtd)
from the Server preferences User Interface -> Server preferences -> Network services panel. From the NoMachine User Interface you can also change the port where the web server will be listening (by default 4080 and 4443 for secure connections).

From command line it's possible to do the following.

Stop, start or restart nxhtd

nxserver --stop nxhtd
or:
nxserver --start nxhtd
or:
nxserver --restart nxhtd


Automatic restart of the nxhtd service
Each service is automatically restarted at the next boot. You can change the default behavior for the nxhtd service by setting:

nxserver --startmode nxhtd manual
or to enable the automatic restart of the service:
nxserver --startmode nxhtd automatic

The nxserver --startmode command operates on the StartHTTPDaemon server configuration key:

StartHTTPDaemon Automatic

and:

StartHTTPDaemon Manual



Disabling the starting of the NoMachine HTTP server
Edit the server configuration file and remove HTTP from the ClientConnectionMethods key. It should then look like:
ClientConnectionMethods NX,SSH

Then restart NoMachine server to make this change effective:

nxserver --restart


4.3. Using an Alternative Apache Web Server

NoMachine Small Business Server is designed to provide a fully integrated service to deploy sessions on the web which doesn't require additional software to be installed or manual configuration. The minimal Apache web server, nxhtd, provides the necessary modules and is pre-configured to work with the web player application.

However, it is possible to run the web player application with an alternative Apache web server. Look for detailed instructions in our Knowledge Base, section Articles, by searching for the 'Apache' keyword: https://www.nomachine.com/knowledge-base.



4.4. Web Optimizations: Using WebRTC (Real-Time Web Communication)

The implementation of WebRTC support in browser-based remote desktop sessions has inititally been released as beta and must be enabled explicitly by the administrator by editing the server.cfg file.

With the help of a STUN/TURN server for negotiating NAT traversal, peer-to-peer WebRTC communication can be established also when the web session has to be run behind a NAT.

STEP 1: Uncomment and set the AcceptedWebMethods key as follows to enable the use of WebRTC:

AcceptedWebMethods webrtc

STEP 2: If the node machine where the web session will be started is behind a NAT, you need to uncomment the following section in server.cfg:

Section "STUN"

Host hostname
Port portnumber
User username
Password password

EndSection

and provide relevant information to contact a STUN or TURN server. In this last case change Section name to "TURN".

Specific articles can be found in the Knwoledge Base, https://www.nomachine.com/knowledge-base.



5. Compression Techniques and Optimizations


5.1. Video Stream Encoding in Web Sessions

In the case of web sessions, by default, session data is streamed in video frames compressed and decompressed by using the MJPEG lossy algorithm, which is the video-format widely supported by browsers.

Oher video codecs like VP8 and H.264, require a browser which supports WebRTC and HTML5.

NoMachine web sessions use the H.264 video streaming when the following requirements are all met, otherwise VP8 is used. In practice, when WebRTC is enabled, the H.264 or VP8 encoding will be used, otherwise MJPEG will be used:

I WebRTC is enabled.
II The software or hardware H.264 encoding is supported on the server host. (*)
III The browser supports WebRTC and the H.264 decoding

(*) Server packages for customers provide the H.264 libraries necessary to support the SW H.264 encoding. Packages for evaluation, instead, don't provide such libraries. In this case it's possible to add them by installing the NoMachine AVC pack or by compiling them manually.

HW H.264 encoding is possible when the Small Business Server host machine have an hardware accelerated video cards (GPU) with any of the supported microarchitectures: Nvidia Kepler microarchitecture onward and Intel Quick Sync processors. Enabling HW acceleration by Quick Sync requires manual configuration as explained here: https://www.nomachine.com/AR09O00938

Optimizations
Optimizations can be done in two ways: (I) by adjusting display settings in the session or (II) by enabling WebRTC.

I Adjusting display settings in the web sessions
To access NoMachine display settings, open the NoMachine menu inside the web session: press ctrl+alt+0 or click on the page peel in the upper right corner of the window to open it. Then click on the 'Display' button and finally on 'Display settings'. From this panel you can do the following.

Change the display image quality
Increasing the quality will mean to apply a minor compression ratio, the image will be clearer, but more bandwidth will be used.

Disable network-adaptive display quality
This will anchor the display quality to the fixed value specified in the Display quality slider, making it independent from the current network congestion. This is not recommended when there is a very limited bandwidth.

Disable multi-pass display encoding
Default settings within the encoding will work to refine the image progressively to the target quality (as specified in the Display quality slider) starting from a lower quality version of the image during moments of inactivity of the desktop. Disabling this refinement sends the image directly with target quality. Not recommended when there is limited bandwidth.
II Enabling WebRTC
NoMachine web sessions use by default the classic web media exchange protocol for the two-way browser/web server communication. WebRTC (Real-Time Web Communication) is also supported and can be enabled as explained in the next paragraph.
Enabling WebRTC allows to use the H.264 video streaming (when possible) or VP8 which optimize the user experience with multimedia applications and content.


TIP
You may verify which encoding method is in use from the NoMachine menu inside the session: press ctrl+alt+0 or click on the page peel in the upper right corner of the window to open it. Then click on the 'Display' button and finally on 'Display settings'. The codec actually in use is reported at the bottom left of the menu.


5.2. Video Streaming Encoding in Client Sessions

Sessions run by NoMachine client use a combination of video and image encoding based on standard codecs and a number of techniques developed by NoMachine. Frames are encoded into a video stream optimized by means of a compression and decompression algorithm of real-time image and audio data. VP8, H.264 and MJPEG encoding are supported.

In general VP8 and H.264 are suitable for all situations, while MJPEG can be an alternative when the end-user's computer is less powerful and the user is experiencing slow responsiveness.

The display encoder can be changed on the server:

from the User Interface
In the User Interface in the Server Performance panel.

or in the node configuration file
Enable the use of a specific codec by editing the node configuration file and enabling the following two keys:

EnableDisplayServerVideoCodec 1
DisplayServerVideoCodec CODEC

where CODEC can be: 'vp8','h264' or 'mjpeg'. For example:
EnableDisplayServerVideoCodec 1
DisplayServerVideoCodec mjpeg



5.3. The X11 Vector Graphics Mode in Client Sessions

The X11 vector graphics mode (previously called 'lightweight mode') is enabled by default for (i) virtual desktops and (ii) custom sessions in floating window mode. This mode is mainly a set of NoMachine techniques to compress and optimize the X11 protocol (by applying the same algorithms available with the NX compression protocol v. 3). These compression techniques are applied to all non-video content like textual elements, while multimedia content is encoded in a video stream (VP8 or H.264).

The X11 vector graphics mode is useful for avoiding loss of image quality and in general is the best option when working with traditional User Interfaces or a large amount of text. However it's not advisable for multimedia content or applications with many graphical effects.

This mode can also help to reduce bandwidth usage, decrease the HW requirements on client and server (expensive video encoding/decoding operations are applied only to multimedia content), increase responsiveness on slow link and end-users' clients without hardware accelerated video encoding/decoding capabilities.

You can disable/enable the X11 vector graphics mode
via the User Interface
in the Server preferences User Interface -> Performances panel

or in the node configuration file
Edit the node configuration file, uncomment and set the AgentX11VectorGraphics key (previously named 'AgentLightweightMode') to '0' for disabling the the X11 vector graphics mode:
AgentX11VectorGraphics 0

or to enable it:
AgentX11VectorGraphics 1

TIPS
I In the case of slow bandwidth, decreasing the quality level of images could help but if you need to have a perfect image without quality loss, you have to increase the display quality instead. It's also suggested to disable multi-pass encoding to avoid the 'out of focus' effect: multi-pass is an encoding technique which uses multiple passes to progressively reach the best definition of the image.
II Quality level and multi-pass encoding can be tuned from the NoMachine menu inside the session in the Display -> Change settings panel. (Ctrl+alt+0 or click on the right upper corner of the window to open the NoMachine menu).


5.4. Supporting OpenGL Applications in Virtual Sessions

In NoMachine virtual desktops and custom sessions, OpenGL rendering is done by default by software components. This means that rendering tasks are accomplished by CPU and not offloaded onto the GPU. Such operations canbe resource-demanding, especially in the case of 3D desktop graphics effects, and make the user interface look slow.

A possible alternative is to configure the NoMachine server to use the VirtualGL libraries (included in the NoMachine package) and therefore activate support for HW accelerated OpenGL applications. This allows OpenGL applications, namely 3D applications, to use server side graphics hardware.

In order to activate support for VirtualGL, follow instructions at http://www.nomachine.com/AR11K00737



6. Small Business Server Configuration


6.1. Configuration Files

The configuration file for the nxserver and nxweplayer/nxwebclient programs is server.cfg. The configuration file for the nxnode program is node.cfg.

They are placed in the:
BaseDirectory/NX/etc directory on Linux:
/usr/NX/etc/server.cfg
/usr/NX/etc/node.cfg

The Default Configuration
NoMachine Small Business Server comes with a default configuration that grants a working setup for the majority of environments. NoMachine administrators can tune their installation at any moment and according to their specific needs by setting the related configuration keys. In some cases this will require to restart all NoMachine services.

Edit the Configuration Files
NoMachine configuration files are text files made up of a number of key-value pairs. All the configuration files can be edited manually by a text editor, e.g. 'vi'.

Be sure to uncomment the configuration key (i.e., remove the '#' pre-pended to the key) to set a value different from the default.

When a configuration key supports an on/off status, set value to '0' to disable it and to '1' to enable it.

Make Changes to the Default Configuration Effective
Changes will be effective with the next new connection without the need to restart the server if not otherwise specified.



7. Services Management

Installation and upgrade procedures take care of configuring and starting all the necessary services to make NoMachine Small Business Server ready to accept and serve user requests for virtual desktops and custom sessions. The necessary services are configured to be restarted at each reboot of the host machine.



7.1. Accepting Connections

You can stop and start accepting new connections via:

the User Interface
from the Server status User Interface click on 'Stop the server' and 'Start the server' respectively: this will prevent users from running new connections

or from command line
to disable accepting new connections from the command line, run:

nxserver --stop
or to enable accepting new connections:
nxserver --start


7.2. Stopping and Starting Small Business Server and Services

All NoMachine services can be stopped via:

the User Interface
all NoMachine services can be stopped by the Server status User Interface ('Shutdown the server'). When doing so, you will be asked if services must be started at the next reboot or not. You can restart services also from the Server status User Interface ('Start the server').

or from command line.

Stopping all the NoMachine services

nxserver --shutdown
This will completely disable access to the server host machine and terminate all sessions running on that host. By default, all services will be restarted when the machine is booted. To override this behavior, specify the --startmode option when stopping the services:
nxserver --shutdown --startmode manual


Starting NoMachine server and services

nxserver --startup
All services will be restarted at the next reboot. To not start services when the machine is rebooted, specify the start mode while running the --startup command:
nxserver --startup --startmode manual


Specifying the start mode
It's possible to set the 'start mode' (if services will be started automatically at boot or not) by using:

nxserver --startmode manual
or:
nxserver --startmode automatic


Stopping and restarting NoMachine server and services

nxserver --restart


7.3. Stopping and Starting a Network Service

The NoMachine network services available for NoMachine Small Business Server are nxd and nxhtd:

Program Default port Scope
nxd 4000 Accept connections by NX protocol
nxhtd 4080 and 4443 Accept connections by HTTP protocol (connections by the web)


You can stop a single service:

via the User Interface
in the Server status -> Server preferences -> Network services User Interface. You can also choose the start mode: whether the servicehas to be started automatically at the next boot or not.

or from command line.

Stopping a service

nxserver --stop SERVICE


where SERVICE can be:
nxd, the Network Server for accepting connections by NX protocol
nxhtd, the NoMachine web server for web sessions

Starting or restarting a service

nxserver --start nxd
nxserver --start nxhtd
or:
nxserver --restart nxd
nxserver --restart nxhtd


Specifying the start mode
By default each service is automatically restarted at the next boot. You can configure that on a per-service basis by running:

nxserver --startmode SERVICE manual
or to restore the default behavior:
nxserver --startmode SERVICE automatic

Commands above operate on the configuration keys listed below. You can change them manually in the server configuration.

Configuration Key setting
Enable automatic starting of the NX Network server, nxd StartNXDaemon Automatic
Disable automatic starting of the NX Network server, nxd StartNXDaemon Manual
Enable automatic starting of the NoMachine web server, nxhtd StartHTTPDaemon Automatic
Disable automatic starting of the NoMachine web server, nxhtd StartHTTPDaemon Manual


7.4. Local and Network Ports

For each session, NoMachine uses ports that are used only locally on the server host and network ports.

Some ports are mandatory and must be free, e.g. the session display number and the connection port. Other ports are used for services that can be disabled (e.g. USB forwarding, UDP communication).

Local port Description How to change the default
11000 + DisplayBase Session display. If this port is already in use, NoMachine will look for a free port by incrementing DisplayBase up to the value set in the DisplayLimit server configuration key. DisplayBase (by default 1001) and DisplayLimit (200) are defined in server.cfg
20000 Communication port between the session's nxserver process and the main server process. Add the ServerSlaveBase key to the end of server.cfg and specify a value
24000 + DisplayBase Session's monitor port. DisplayBase (by default 1001) and DisplayLimit (200) are defined in server.cfg
5473 and 5483 USB devices forwarding. Disable USB sharing by setting EnableUSBSharing none in node.cfg


Network port Description How to change the default
6000 + DisplayBase TCP port for the NoMachine display service. If this port is already in use, NoMachine will look for a free port by incrementing DisplayBase up to the value set in the DisplayLimit server configuration key. DisplayBase (by default 1001) and DisplayLimit (200) are defined in server.cfg.
5353 UDP port for the MDNS service to broadcast computer's information over the LAN. Disable the service by setting EnableNetworkBroadcast 0 in server.cfg.
4000 TCP port for the NoMachine Network service (nxd) and connections via NX protocol. This port must be open in the firewall and mapped to the external IP of the server host. Set NXPort in server.cfg and restart the nxd service.
4011 - 4999 UDP port range. Set UDPPort in server.cfg to define a different range. UDP can be disabled on client side.
22 TCP port for connections via SSH protocol. This port must be open in the firewall and mapped to the external IP of the server host. Set a different port for the system SSH server and align value set for SSHDPort in server.cfg. Then restart the NoMachine server.
4080 and 4443 HTTP and HTTPS port for web connections. These ports must be open in the firewall and mapped to the external IP of the server host. Change 'Listen' directives in htd.cfg and restart the nxhtd service.
20000 - 30000 External ports range for UPnP port mapping. Set NXUPnPPort in server.cfg to define a different range. Set EnableUPnP none in server.cfg to disable port mapping.
5040 + x Port opened between client and server for each USB device. Port number is defined by 5040 + x where 'x' is the first free port retrieved starting from port number 5040. N/A
4000 Automatic updates from NoMachine repositories. Updates are managed by nxd. Disable automatic updates by setting UpdateFrequency 0 in server.cfg.
5473 and 5483 USB devices forwarding. Disable USB sharing by setting EnableUSBSharing none in node.cfg.
7.5. Hiding the NoMachine Monitor and Notification Messages

It is possible to hide or show the !M (the Monitor) icon in the system tray. When the icon is hidden, notification messages will still be displayed when users are connecting. This can be configured:
from the User Interface:
In the Server status -> Server preferences -> Server options User Interface. When the icon is hidden, notification messages will still be displayed when users are connecting.

or in the node configuration file
This setting is ruled by the DisplayMonitorIcon key in the node configuration file. If you change them manually by editing the file, you then need to restart the server to make changes effective.

To hide the !M in the system tray set:
DisplayMonitorIcon 0

To display the !M in the system tray set:
DisplayMonitorIcon 1

In both cases, then restart the server:

nxserver --restart


By default NoMachine issues a balloon message to notify about events like user disconnections or user requests to connect. You can disable notification messages by setting the following key in the node configuration:
DisplayMonitorNotifications 0

TIP
If the displaying of monitor notification messages is disabled, the desktop owner will be unable to accept connection's requests by other users. Configure trusted users if you need to allow the connection without explicit authorization.


7.6. Hiding the Whiteboard and Chat Tools

If you want to disable the Whiteboard from the Monitor menu, edit the node configuration file to have:
EnableWhiteboard 0

Then restart the server:

nxserver --restart


7.7. Handling of Discovering of this Server on LAN

By default NoMachine Small Business Server broadcasts information to let other NoMachine computers to discover it on the local network. You can disable this feature via:
the User Interface
in the Server status -> Server preferences -> "Network services" User Interface

or in the server configuration file
set the following key in the server configuration:

EnableNetworkBroadcast 0

Then restart the server to make changes effective:

nxserver --restart


8. Notifications to Users


8.1. Whiteboard and Custom Notifications

NoMachine provides an instant messaging tool, named whiteboard which allows also drawing, the sharing of files with connected users and fast-track access to file transfer. To access it, connect to the user's desktop and from the Monitor (!M icon) in your system tray click on 'Show the whiteboard'. Note that if multiple users are connected at the same time to the same session, they will all see the same message.

As an alternative, it's possible to issue a dialog in the connected sessions to show a custom message by sending it from command line.

Sending a message to all running sessions:

nxserver --broadcast "Your message goes here"
or sending a message only to the session specified by its session id:
nxserver --message "Your message goes here"


8.2. Greeting Messages

It is possible to welcome users when the session has started by issuing a greeting message, either only the first time the user logs-in or every time the user connects to the Small Business Server. Update the node configuration file by writing the text of your message in any of the following keys:

NodeFirstLoginGreeting "Welcome to your first NX session"
NodeLoginGreeting "Welcome to your NoMachine session"

9. Supported Connection Protocols and Authentication Methods

NX Protocol
connections by default use the NX protocol which is its own protocol for secure communication over the network. Encryption in the NX protocol is implemented using OpenSSL TLS/SSL, based on ECDHE-RSA-AES128-GCM-SHA256 as the default cipher suite. ECDHE-RSA-AES128-GCM-SHA256 is an AES (Advanced Encryption Standard) block cipher with 128 bits key in GCM (Galois/Counter Mode). RC4 (ECDHE-RSA-RC4-SHA cipher suite) is used as a backward compatibility when connecting from or to versions 4.0.

When using the NX protocol, NX data can travel on TCP and UDP streams, even at the same time. The client and server can decide dynamically what transport to use, based on the type of data and the network conditions. Client and server negotiate the UDP transport at session startup, after having negotiated the main TCP link. UDP uses symmetric Blowfish encryption, with key negotiated on the secure TCP link. UDP is presently not available when using the SSH tunneling to ensure that all data goes through the same SSH link, as it was in legacy version 3. UDP protocol can be also disabled.

SSH Protocol
NoMachine Small Business Server also provides tunneling of connections using SSH and full integration with any authentication backend supported by the host SSH server.

Authentication methods
These are the authentication methods supported by NoMachine when connections use the NX protocol or the SSH protocol:

Authentication method NX protocol SSH protocol
Login with user's password yes yes
Login with SSH private key yes yes
Login with SSH private key provided by SSH agent (available since v. 6.3.6) - yes
Login with SSH private key private key stored on a PKCS11 smart card - yes
Login with Kerberos ticket on client side yes yes
Support for SSH agent forwarding - yes
Support for Kerberos tickets authentication forwarding yes yes
Support for two-factor authentication yes yes


9.1. Defining Protocol in Server Configuration

Protocols are defined in the ClientConnectionMethods key in the server configuration. They are specified as a comma-separated list of values:

ClientConnectionMethods NX,SSH,HTTP

This key is automatically populated during the installation or the update of the package. It is possible to exclude any of the available protocols to force users to connect by the desired protocol.

For example, to use only NX protocol, set this key to:
ClientConnectionMethods NX

and restart the server to make changes effective:

nxserver --restart


TIPS
I If your server supports SSH but it still reports that SSH is not available, check the ClientConnectionMethods key and ensure that the SSH values is set. Then restart the server.
II Removing 'HTTP' from the ClientConnectionMethods key will disable the starting of the NoMachine HTTP server and prevent connections via web.


9.2. Locking Down the Accepted Authentication Methods

Administrators may decide how the user should authenticate on the server by defining which authentication method(s) is/are available. Authentication methods can be set in the server configuration file by editing this key:

AcceptedAuthenticationMethods all

By default all methods are accepted. They can be restricted by providing a comma-separated list of values, they will indicate which authentication method is permitted.

Accepted values for connections by NX protocol are:
NX-password to allow password authentication.
NX-private-key to allow key-based authentication.
NX-kerberos to allow Kerberos ticket-based authentication.

while for connections by SSH protocol:
SSH-system to allow all methods supported for the system login. SSH authentication methods for the system login have to be set on the system for example in the PAM configuration.

For example, to accept key-based and Kerberos ticket-based authentication for the NX protocol:

AcceptedAuthenticationMethods NX-private-key, NX-kerberos



Settings in the client User Interface
Users can select the authentication method in their connection settings from the NoMachine User Interface in the Advanced panel for the NX protocol and SSH protocol settings respectively.

They correspond to the following options in the client User Interface:

Authentication method NX protocol
Client User Interface's Advanced settings options
SSH protocol
Client User Interface's Advanced settings options
Login with user's password Password (default) Password (default)
Login with SSH private key(*) Private key Private key
Login with SSH private key provided by SSH agent (available since v. 6.3.6) - Authentication agent
Login with SSH private key stored on a smart card(*) - Smart card
Login with Kerberos ticket on client side(**) Kerberos Kerberos
(*)Support for SSH agent forwarding - Private key'+ Forward authentication or Smart card + Forward authentication
(**)Support for Kerberos tickets authentication forwarding Kerberos + Forward authentication Kerberos + Forward authentication
Support for two-factor authentication No settings needed on client side, it's a server side configuration No settings needed on client side, it's a server side configuration

Protocol and authentication methods can be set when creating a new connection via client User Interface:

or changed later by modifying the connection settings (right mouse click on the connection icon in the client User Interface to edit it).



9.3. Changing Port for the NX Protocol

The default setting of NoMachine is to run connections via the NX protocol on port 4000. On server side, the Network Server, nxd, is listening on port 4000. It's mandatory that this port is open between client and server to allow connections by NX protocol.

If you change the port for nxd, connecting users will have to specify the new value in their connection settings in the client User Interface.

It's possible to modify the port for nxd
from the User Interface
in the Server status -> Server preferences -> Network services User Interface

or in the server configuration file by editing this key:
NXPort 4000

Restaring the nxd service is necessary to make this change effective:

nxserver --restart nxd


When NX protocol is used, UDP communication for multimedia is enabled by default. UDP traffic uses a range of ports between 4011 and 4999. These ports must be open between client and server. If they are not available, traffic will fall back to TCP communication. You can change the port range, define a comma-separated list of ports or a single port by changing value set for the following key in the server configuration:
UDPPort 4011-4999

Users can disable UDP in their connection settings from the NoMachine User Interface in the Advanced panel for the NX protocol settings.



9.4. Changing Port for the SSH Protocol

The default port used for the SSH protocol is 22 on Linux. On such platform NoMachine relies on the SSH server installed on the system. If your SSHD is configured to listen on a port different from 22 you need to align the NoMachine server configuration accordingly. Connecting users will have to specify such value in their connection settings in the client User Interface.

If your SSH server is listening on a port different than 22, change the SSH port in the NoMachine configuration

in the Server status -> Server preferences -> Network services User Interface

or in the server configuration file by editing this key:
SSHDPort 22



9.5. Connecting to a Server Behind a Firewall (UPnP Port Mapping)

Automatic discover of the NoMachine Small Business Server host is possible only when the server and the user's machine are on the same LAN. When the user connects over the internet or from a different network, it's mandatory to know the public (or external) IP of the Small Business Server.

When the server is behind a firewall, you have to configure the router to forward external port to the nxd service (to use the NX connection protocol), to the SSH server (to use the SSH protocol) and to the nxhtd service (to connect by the web). By default the required ports are TCP ports: 4000 for NX, 4080 and 4443 for HTTP/HTTPS and UDP ports in the 4011-4999 range. Note that users will have to specify the external port in their connection settings in the client User Interface.

If the router on the server side supports UPnP/NAT-PMP, you can let NoMachine try to enable port forwarding in the router automatically. External ports will be selected randomly from the 20000 - 30000 range. Also in this case users will have to specify the external port in their connection settings in the client User Interface.

For connections by NX protocol, at session startup NoMachine will also try to map UDP ports by using UPnP.

Enabling the automatic port forwarding
Step 1: Set in the server configuration:
EnableFirewallConfiguration 1

Step 2: Specify for which service the port forwarding must be enabled by listing them in the following key:
EnableUPnP NX,SSH,HTTP

Step 3: Specify the port where the NX service will be redirected by editing respectively:
NXUPnPPort ""; SSHDUPnPPort "" and HTTPUPnPPort ""

TIP
To allow only connections by SSH (on external port 20048 for example) and use the automatic port forwarding, set in the server configuration:
ClientConnectionMethods SSH
EnableFirewallConfiguration 1
EnableUPnP SSH
SSHDUPnPPort "20048"
and restart the server.


You can enable port forwarding for connections by NX and HTTP/HTTPS protocol also from the User Interface
via the Server preferences -> Network services User Interface by selecting the service and enter its settings (click on 'Configure'). Then check the Gateway port option.

Retrieving information about UPnP port mapping
When the automatic port mapping is enabled, you can retrieve information about UPnP port mapping, e.g. IP of the gateway device, external port and port mapped by running:

nxserver --upnpstatus
To terminate port mapping:
nxserver --upnpunmap
To initiate port mapping:
nxserver --upnpmap
You can also specify for how long port mapping should last by using
nxserver --upnpmap --time


9.6. Using NoMachine DBs for Managing User Access

Use of NoMachine DBs can be configured by editing the server configuration. The table below reports which configuration key value has to be set to enable or disable specific behavior as defined in the 'Target' field:

Target Server configuration key Description
User's access based on system authentication (default) EnablePasswordDB 0 Authentication is requested to the system, user's connection is allowed once the user has been authenticated. PAM, LDAP, AD are supported.
User access based on NX Password db EnablePasswordDB 1 Authentication is verified against the NX password DB. Separate the NoMachine authentication from the system authentication. The user's account must exist on the system.
Allow connections from all authenticated users (default) EnableUserDB 0 Every time a new account is created via NoMachine or an already existing system user runs the session for the first time, the user is added to the NoMachine NX Users DB, even when the use of NX Users DB is disabled. These users cannot be disabled and are always allowed to connect if they authenticate successfully.
Enable or disable user's access to NoMachine EnableUserDB 1 By default all users are enabled to access the NoMachine system once authenticated. With this configuration a user can be disabled and re-enabled at any moment from command line.


10. User Management


10.1. Managing Users on the Small Business Server Host

You can manage (create, delete and modify) user accounts by using tools provided by your Operating System or the NoMachine server commands as explained below.

Creating Accounts
The Small Business Server is able to handle two types of accounts: system accounts and NoMachine accounts. The latter allows the administrator to separate the system password from the NoMachine password.

Creating a System Account
The system account will be created with the default system settings. The new user will be also added to the NoMachine Users db:

nxserver --useradd USERNAME --system


Creating a NoMachine Account
Use this command when the user already has a system account:

nxserver --useradd USERNAME


TIPS
I To assign a password different from system password to a system user, enable NoMachine Password DB ( EnablePasswordDB 1) in server.cfg.
II To verify if the user's authentication is based or not on NoMachine Password db:
nxserver --userauth USERNAME


Enabling and Disabling access for a NoMachine User
Prerequisites are:

i)The user has run at least one session or have been added to NoMachine dbs by means of 'nxserver --useradd' command.

ii) NoMachine Users DB is enabled (EnableUserDB 1 is set in server.cfg)

You can enable/disable a user and allow/forbid access to the Small Business Server for that user by running:

nxserver --userenable USERNAME
or:
nxserver --userdisable USERNAME
Note that 'nxserver --useradd USERNAME' adds the user to NoMachine dbs and automatically enables the user to log-in, while 'nxserver --userdel USERNAME' removes the user from NoMachine dbs and disables the user's ability to login by NoMachine.


Modifying the User's Password
You can modify the user's system password by running:

nxserver --passwd USERNAME --system
or you can modify just the NoMachine password when Password db is in use( EnablePasswordDB 1 is set in server.cfg):
nxserver --passwd USERNAME


Listing the NoMachine Users
All users who have run at least one session or have been added to NoMachine dbs are stored in the Users db. You can retrieve the complete list by running:

nxserver --userlist

The output of this command provides the following fields:
Redirected to: IP/hostname of the server to which the user's connection is redirected (by means of the 'nxserver --redirect' command when supported).
Trusted for: it shows if the user is trusted.
Screen Sharing: it shows which user has the sharing of their physical screen disabled.
Access: it shows if the user is enabled or not to access the NoMachine system. This works in conjuction with the use of the NoMachine Users DB: when enabled (EnableUserDB 1 in the server configuration), it's possible to enable/disable user's access to the whole NoMachine system.
Forwarded to: this field is applicable only when the server is a NoMachine Cloud Server, so it's always empty in case of Small Business Server.

Removing Accounts
To remove an account from the system:

nxserver --userdel USERNAME --system
or removing a NoMachine user and delete his account from the NoMachine dbs:
nxserver --userdel USERNAME
This will not remove the system account.


10.2. Connecting with a Privileged System Account

By default, NoMachine allows the running of sessions as privileged system user ('root' or 'sudo' on Linux). You can however configure the NoMachine Server to disallow it. Do it by disabling the following server configuration key:

EnableAdministratorLogin 0

To re-enable the possibility to log in as root or administrator, set:

EnableAdministratorLogin 1



10.3. Connecting as a NoMachine Trusted User

By default when the connecting user is different from the owner of the virtual desktop, the desktop owner has to authorize the user for the connection.

It is possible to define in advance a number of trusted users who don't need the specific owner's permission to connect to virtual desktops run by a different user.

In order to create a list of trusted users, administrators should use the nxserver commands for creating and editing users. These commands provide the --trusted option to define if the user is trusted for connections to the virtual desktop or not.

To create a new trusted user for virtual desktops on the system:

nxserver --useradd USERNAME --system --trusted virtual
For example:
/etc/NX/nxserver --useradd nxtest01 --system --trusted virtual
To make an existing user trusted, modify trusted permissions or remove them:
nxserver --useredit --trusted [virtual | none]
For example edit user 'nxtest02' and give it trusted authorization:
/etc/NX/nxserver --useredit nxtest02 --trusted virtual
To remove trusted authorization for user 'nxtest01':
/etc/NX/nxserver --useredit nxtest01 --trusted none


To list only trusted users:

nxserver --userlist --trusted


11. Session Management

Each session on the same server is uniquely identified by a session id (which can look like: B253864E822F5A235825F3AB8853AF00) and a display id (e.g.,1002).

A session on the NoMachine Small Business Server can be in any of the following statuses:
Connected - when it's connected to the remote display.
Disconnected - this status is available only for virtual desktop sessions and custom sessions. A session is marked as disconnected when it's disconnected from the remote display. A disconnected session can be reconnected at any time even from a different machine (migration). While a session is disconnected, applications on the remote server stay running. Finished - the session has been closed in a clean way and all NoMachine processes have been shut-down smoothly.
Failed - any of the NoMachine processes has failed to start or it has been "un-cleanly" terminated.
Transitional statuses are Connecting, Disconnecting and Terminating.

NoMachine Small Business Server is able to manage different types of sessions, named internally as in the table below. You can see the complete list of supported session types by running:

nxserver --resourcelist --class session


Session types supported by the Small Business Server and their descriptions are:

Session type Description
physical-desktop Connect to the physical desktop of the Small Business Server host.
unix-xsession-default Run the default virtual desktop as set on the system.
shadow Connect to a virtual desktop session (desktop sharing/collaboration).
unix-console Run a virtual Unix console application.
It can be embedded into the client session window or be a floating window console depending on the user's choice: run or not the custom session in a virtual desktop
unix-desktop Run a virtual custom application embedded into the player session window.
unix-application Run a virtual custom application.
It can be embedded into the client session window or be a floating window application depending on the user's choice: run or not the command in a virtual desktop.
unix-gnome Run a virtual GNOME desktop.
The ConnectPolicy key in the server configuration must have 'desktop=1' set.
unix-kde Run a virtual KDE desktop.
The ConnectPolicy key in the server configuration must have 'desktop=1' set.
unix-xdm Run a virtual desktop through the X Desktop Manager.
unix-default Run a virtual session by using the default X client script on server.
unix-script Run a virtual session by using the X client script on server as specified by path.


11.1. Monitoring Sessions

You can monitor sessions from command line tools. Below are the server commands to be run from xterm or console.

Listing Running Sessions
To list all the running sessions, their display, session owner, remote IP of the connected client, session ID and session host:

nxserver --list
You can also filter results on a per-user basis:
nxserver --list USERNAME
or gather further information about connected clients:
nxserver --list --client-version --client-platform

The number of active connections on the server corresponds to the number of sessions in status Connected. Session status is shown in the output of session history command.

Session History
History is preserved for a certain amount of time as set in the server configuration. To see the complete list of sessions, including those that have been cleanly terminated or failed, run:

nxserver --history
If you want to filter results on a per-user basis:
nxserver --history USERNAME
or to get more details about a session:
nxserver --history SESSIONID
Output of this last command in the case of a failed session can help to understand what went wrong.


Clearing Sessions History
You can reset the history backlog by running the following command.

nxserver --history clear


Configuring the Session History Backlog
Data is preserved for 30 days. You can modify that in the server configuration file by uncommenting and setting a different value for the following key:
SessionHistory 2592000

This key accepts the following values:
< 0 Never delete data from NX session history.
0 Disable NX session history.
> 0 Keep data in session history for this amount of seconds.



11.2. Managing Sessions

Disconnecting a Virtual Desktop Session from Command Line
You can disconnect a session, if it's a virtual desktop one, by running:

nxserver --disconnect SESSIONID
or:
nxserver --disconnect DISPLAYID
You can also disconnect all virtual desktops belonging to a specific user:
nxserver --disconnect USERNAME


TIP
Take SESSIONID or DISPLAYID from the output of the 'nxserver --list' command, they are the 'Session ID' and 'Display' column respectively. The same output also shows the user's name.


Disconnecting or Terminating Virtual Desktops Automatically
To disconnect a virtual desktop or custom sessions after a certain time of inactivity, uncomment and set a proper timeout value, in seconds, in the following node configuration key. For example, if you want to terminate sessions after 10 minutes of inactivity you need to set:
DisplayServerExtraOptions "-timeout 600"

If the NoMachine display agent doesn't receive any input from the user in the given timeout, it will either disconnect or terminate the session. Termination of the session will be carried out if the session is not persistent or no X application is connected to the display. Otherwise the agent will disconnect the session so that the X applications will be left running.

Note that the DisplayServerExtraOptions key is only for virtual desktops or custom sessions with X11 vector graphics enabled (default).

For web sessions, sessions connected to a virtual desktop (sharing of the virtual desktop), virtual desktops with X11 vector graphics disabled and connections to the physical desktop, set instead:
DisplayAgentExtraOptions "-timeout 600"


Terminating the Session from Command Line
To terminate a virtual desktop or custom session:

nxserver --terminate SESSIONID
or:
nxserver --terminate DISPLAYID
You can also terminate all sessions belonging to a specific user:
nxserver --terminate USERNAME
If you want to terminate all sessions, just restart the server:
nxserver --restart
or if you want to terminate all sessions and forbid new connections until the server is started again:
nxserver --shutdown
To start the server after a shutdown:
nxserver --startup

Terminating Automatically Virtual Desktop/Custom Sessions in Status Disconnected
It's possible to specify for how long the server has to keep alive virtual desktops in the disconnected status. When the time has expired, the server will terminate virtual desktops if no user is connected there. To let the server terminate a disconnected virtual desktop after XXX seconds, edit the server configuration file, uncomment and set the timeout value (XXX) expressed in seconds in the following key:
DisconnectedSessionExpiry XXX

For example, by setting:
DisconnectedSessionExpiry 600
a virtual desktop will terminate after ten minutes provided there is no activity.


Terminating Automatically Virtual Desktop/Custom Sessions when the Maximum Number is Reached
To terminate a disconnected session when the maximum number of virtual desktops (see 'Limiting the Number of Virtual Desktops' below) is reached and make room for a new virtual desktop or custom session, enable the following key in the server.cfg file:
EnableAutokillSessions 1


Limiting the Number of Virtual Desktops or Custom sessions
You can set a limit for the number of virtual desktops provided that such limit does not exceed the number of connections allowed by the server license value (it's the 'Virtual Desktops' field in the server.lic file). NoMachine Small Business Server allows up to ten concurrent virtual desktops.

For example to configure the server to allow only two concurrent virtual desktops, edit the server configuration and set:
VirtualDesktopsLimit 2

You can also specify how many virtual desktops a single user may run. For example, to allow 1 connection per-user, uncomment and set the following key in the server configuration file:
VirtualDesktopsUserLimit 1

A Practical Example
Limit the number of virtual desktops to three and keep alive a virtual desktop (inactive & disconnected) for one day. If a new virtual desktop is requested, the server will terminate the oldest virtual desktop in status disconnected to make room for the new session.
VirtualDesktopsLimit 3
EnableAutokillSessions 1
DisconnectedSessionExpiry 86400


Automatic Disconnection of Users
The automatic disconnection is a server configuration to rule the server behavior when the limit of users is exceeded and a new user is requesting to connect.

Current options are:
enabled (1): the server will automatically disconnect the user to make room for the new user.
disabled (0): the server will issue a pop-up message before disconnecting the user. The current user can accept or not to
disconnect itself. If no choice is made, the server will automatically disconnect this user and let the incoming user to connect.

The automatic disconnection applies when the maximum number of available connections to the desktops or the maximum number of available virtual desktops is exceeded.

To enable the automatic disconnection set the following key in the server.cfg file:
AutomaticDisconnection 1

To let the connected user decide or refuse to disconnect, set:
AutomaticDisconnection 0


Disabling persistent virtual desktops
Users may be forced to terminate their virtual desktop session by setting in the server configuration:
DisablePersistentSession all

In this way when the user closes the virtual desktop, the session is terminated instead of being disconnected. This server configuration key also accepts a list of comma-separated usernames and will be applied to the specified users. Non persistent sessions cannot be reconnected.



11.3. Setting a Virtual Desktop Environment on Linux

Pre-requisite to connect by NoMachine is that a desktop environment is installed on the system even if the host is headless or not started in graphics mode.

During its installation, NoMachine detects the default desktop environment set on the system and configures the node accordingly. Path and command to start the system desktop environment is defined in the node configuration file by the DefaultDesktopCommand key. The Small Business Server is able to detect GNOME, Unity, KDE and LXDE. If you have a different desktop environment, it's necessary to edit the DefaultDesktopCommand key accordingly.

For example to run MATE:
DefaultDesktopCommand "/usr/bin/mate-session"

or to run Pantheon:
DefaultDesktopCommand "/usr/bin/gnome-session --session=pantheon"


If there are multiple desktop environments installed, you can specify in the same key the desktop to be launched. For example if you have KDE, GNOME and Xfce installed installed on Ubuntu 16.04 and want users to be able to run new virtual KDE desktops, set the configuration key to:
DefaultDesktopCommand "/etc/X11/Xsession startkde"

If you want they create new GNOME virtual desktops instead, set:
DefaultDesktopCommand "/etc/X11/Xsession 'gnome-session --session=gnome'"

or for creating Xfce virtual desktops:
DefaultDesktopCommand "/etc/X11/Xsession startxfce4"

TIP
If you want to let users choose between creating new KDE or GNOME virtual desktops (given that they are both installed) set desktop=1 in the ConnectPolicy key in the server configuration. With this key set, the server uses the following keys (in node.cfg) to start respectively KDE and GNOME virtual desktops: CommandStartKDE and CommandStartGnome.


11.4. Executing Custom Scripts on Server/Node Events

The server configuration provides a number of keys that can be activated to execute a custom script upon a certain event. According to the event, a number of parameters can be specified for each script. In a similar way, a number of keys is present in the node configuration file to allow to execute a custom script on a certain NoMachine node event. In both cases and according to the event, a number of parameters can be specified for each script.

Available for Configuration key Accepted parameter (server.cfg) Accepted parameter (node.cfg)
server UserScriptBeforeLogin remote ip -
server UserScriptAfterLogin username
Starting from v. 6.4, it accepts also remote ip
-
server,node UserScriptBeforeSessionStart session id, username, node host, node port, main session id(*), main session type(*) session id, username, session type, display, main session id(*), main session type(*)
server,node UserScriptAfterSessionStart session id, username, node host, node port, main session id(*), main session type(*) session id, username, session type, display, main session id(*), main session type(*)
server,node UserScriptBeforeSessionDisconnect session id, username, node host, node port session id, username, session type, display
server,node UserScriptAfterSessionDisconnect session id, username, node host, node port session id, username, session type, display
server,node UserScriptBeforeSessionClose session id, username, node host, node port, main session id(*), main session type(*) session id, username, session type, display, main session id(*), main session type(*)
server,node UserScriptAfterSessionClose session id, username, node host, node port, main session id(*), main session type(*) session id, username, session type, display, main session id(*), main session type(*)
server,node UserScriptBeforeSessionReconnect session id, username, node host, node port session id, username, session type, display
server,node UserScriptAfterSessionReconnect session id, username, node host, node port ssession id, username, session type, display
server UserScriptBeforeSessionFailure session id, username, node host, node port,main session id(*), main session type(*) -
server,node UserScriptAfterSessionFailure session id, username, node host, node port,main session id(*), main session type(*) session id, username, session type, display, main session id(*), main session type(*)
server UserScriptBeforeCreateUser username -
server UserScriptAfterCreateUser username -
server UserScriptBeforeDeleteUser username -
server UserScriptAfterDeleteUser username -
server UserScriptBeforeEnableUser username -
server UserScriptAfterEnableUser username -
server UserScriptBeforeDisableUser username -
server UserScriptAfterDisableUser username -

(*) 'main session id' and 'main session type' parameters are available only when the user connects to an already running virtual desktop (session shadowing). They indicate respectively the id and type of the session to which the user is connected with his/her own session qualified by 'session id' and 'session type'.



A further key in the node configuration file (available since v. 6.3.6), allows to run a custom script triggered on change resolution events (resize of the remote screen). The related key is:
UserScriptAfterRemoteResize



Note that the order of parameters is relevant. For example, a custom script to be run on node event 'UserScriptBeforeSessionStart' should use the $2 variable to retrieve username and $4 to retrieve display.

Pre-requisites to run custom scripts
Custom scripts must be executable. Custom scripts set-up in server.cfg are common to all the users who are accessing the server and are executed by the nxserver program. Since nxserver is running as the nx user, you have to grant this user the necessary permissions in order to execute the custom script.

Custom scripts set-up in node.cfg are executed by the nxnode program, which is run as the connected user. Place the script in a directory that is accessible by the node, i.e. accessible by the connected user(s).

By default if the execution of the scripts fails, the nxserver and nxnode will terminate. This means that the user's session will not start. You can override this behavior by forcing exit 0 inside the custom script and let the session start even if the custom script is failed.



12. Collaborative Virtual Desktops and Connections to the Physical Desktop

Multiple connections to a virtual desktop
By default users can connect to their virtual desktops and to virtual desktops owned by other users. When the desktop owner is different from the connecting user, he/she is always required to authorize the incoming request for connection. Authorization is not requested when the incoming user and the desktop owner are the same. This allows different users sharing the same instance of the virtual desktop and access all applications and resources interactively or in view-mode only. This feature is suitable for collaborative sessions and desktop sharing.

Request for desktop owner's authorization and interaction level can be configured
via the User Interface
You can configure how users will connect to a desktop owned by another user from the Server preferences User Interface -> Security panel. You can basically determine if users can connect or not without asking the desktop owner's permission and if users will be able to interact with the desktop. Allowing connections in interactive mode grants the user full access to the desktop resources and applications. View-only mode is suggested for example when making presentations or teaching a lesson.

or in the server configuration file
besides using the graphical tools, you can configure the server by editing the server configuration file, uncommenting and setting a proper value for keys as illustrated in the following paragraphs.

TIPS
I Configurations made from the User Interface apply to connections to physical and virtual desktops. If you want to set a separate configuration for these desktops, you have to edit the server configuration manually.
II Rather than allow all users to connect without virtual desktop's owner authorization or click accept for every single user which would like to connect, it is possible to define in advance a number of trusted users who don't need the specific owner's permission.


Connect to the physical desktop

NoMachine Small Business Server supports the screen blanking feature: when active, the local user will see a black screen on the physical monitor while somebody is connected from remote to the physical desktop. Operations made on the physical screen are not shown and the local user cannot interact with the desktop until the remote user logs-out. Control is given back to the local user once the remote user has logged off. Screen blanking is available for physical hosts, it is not supported on virtual machines since it has effect on the physical monitor

You can activate the screen blanking feature on the Small Business Server host machine
via the User Interface:
in the Server preferences User Interface panel select the 'Blank the physical screen when somebody connects' option.

or in the server configuration file.
Uncomment and set:
EnableScreenBlanking 1

To disable the screen blanking, set:
EnableScreenBlanking 0

In both cases then restart the server to make this change effective:

nxserver --restart


The screen blanking feature can be used in conjunction with the automatic lock of the remote screen. Even if the user didn't lock the screen before disconnecting by NoMachine, as soon as the screen is unblanked, the system lock screen will be activated automatically to keep the remote desktop protected even when the computer is running unattended.

You can enable the automatic remote screen lock from the User Interface
In the Server preferences -> Security panel select the 'Lock the physical screen on disconnect' option

or in the server configuration file, server.cfg.
Uncomment and set:
EnableLockScreen 1

To disable the automatic screen lock, set:
EnableLockScreen 0

Then restart the server to make this change effective:

nxserver --restart


TIP
For versions previous than v. 6.1:
The option to manage the screen blanking from the server User Interface was named 'Lock the physical screen when somebody connects' and the server configuration key was: EnableScreenLock.
The possibility to automatically lock the remote screen when the user disconnects was not available.


12.1. Disabling Connections to Virtual Desktops

By default users can connect to virtual desktop sessions owned by a different user. To forbid this capability, set in the server configuration file:
VirtualDesktopSharing 0

TIP
This setting disables also the listing of other user's virtual session in the client User Interface.


12.2. Configuring Interaction Level to Virtual Desktops

To forbid users to interact with the desktop once connected set in the server configuration:
VirtualDesktopMode 0

In this way, the connected user will access the virtual desktop in view-only mode.

To allow interaction instead, ensure to have:
VirtualDesktopMode 1



12.3. Configuring Authorization to Connect to Virtual Desktops

To request for the explicit authorization of the desktop owner before connecting the user, be sure that the following key is set in the server configuration:
VirtualDesktopAuthorization 1

Users trusted for virtual desktops, and by default also system administrators and NoMachine administrators, will be able to connect without the need for the desktop owner's approval.

Since v. 6.4, it's possible to request the owner's authorization also for administrators. To configure this, set:
VirtualDesktopAuthorization 2

To allow users connecting to the virtual desktop without explicit permissions, set:
VirtualDesktopAuthorization 0

Settings above apply to all users.

TIP
To restrict the access without owner's authorization only to given users, set: VirtualDesktopAuthorization 2 in the server configuration and edit such users to set the 'trusted for virtual' flag:
nxserver --useredit USERNAME --trusted virtual


12.4. Connections to Physical Desktop

By default, connections to the physical desktop are enabled and require the desktop owner's permission.

Users trusted for physical desktop, system administrators and NoMachine administrators will be able to connect without the need for the desktop owner's approval.



Limit connections to the physical desktop
Connections to the physical desktop can be fully disabled by setting in the server.cfg file:
PhysicalDesktopSharing 0

It's possible to limit connections to the physical desktop to special users (system administrators, NoMachine administrators, trusted users and the desktop owner). They by default can connect without authorization, even when the server is configured to request it. This configuration can be helpful for example when the computer run unattended. Set:
PhysicalDesktopSharing 2

To allow all users connect to the physical desktop, set:
PhysicalDesktopSharing 1

Limit user's interaction with the physical desktop
To forbid users to interact with the desktop once connected set in the server configuration:
PhysicalDesktopMode 0

In this way, the connected user will access the physical desktop in view-only mode.

To allow interaction instead, ensure to have:
PhysicalDesktopMode 1

Enable or disable requesting the desktop owner's authorization
To request for the explicit authorization of the desktop owner before connecting the user, set in the server configuration:
PhysicalDesktopAuthorization 1

System administrators, NoMachine administrators, trusted users and the desktop owner will be still able to connect without authorization.

Since v. 6.4, it's possible to request the owner's authorization also for administrators. To configure this, set:
PhysicalDesktopAuthorization 2

To never request the desktop owner's authorization and allow all users connecting to the physical desktop without explicit permissions, set:
PhysicalDesktopAuthorization 0

System administrators
A privileged system user has to be defined by means of system tools.

The Enterprise Terminal Server allows by default administrative users to connect. You can disable it by setting in the server configuration:
EnableAdministratorLogin 0

To re-enable the possibility to log in as root or administrator, set:
EnableAdministratorLogin 1

NoMachine administrators
Permissions as NoMachine administrator are totally indipendent from system privileges and apply only to NoMachine. A NoMachine administrator, for example, can create a NoMachine infrastructure by adding server hosts to a central server. To create a new user on the system with NoMachine administrative permissions, execute:

nxserver --useradd --system --administrator yes
To manage an existing user and set NoMachine administator's permissions:
nxserver --useredit --administrator --yes
To remove NoMachine administrative permissions:
nxserver --userdel --administrator
To list only NoMachine administrators:
nxserver --userlist --administrator

NoMachine trusted users
To allow a restricted number of users to connect to the physical desktop without explicit authorization, assign the 'trusted' flag to a new system user. They don't have further privileges, neither on the system nor in NoMachine. To create a new user on the system trusted for NoMachine physical desktops, execute:

nxserver --useradd --system --trusted physical
or edit an existing account:
nxserver --useredit --trusted physical


User's ability to disable accepting connections to the physical desktop
By default, the owner of the physical desktop, either sitting in front of the computer or connected to the physical desktop via NoMachine, has the possibility to switch off/on the sharing of the screen at any moment.

This can be done via the NoMachine Monitor (click on the !M icon in the system tray to open it) and the 'Accepting connection is enabled/disabled' item in the menu.

When 'Accepting connection' is disabled, nobody can connect to that desktop by NoMachine. This setting lasts until the desktop owner changes it again. It persists also when the user is physically logged out or closed the NoMachine connection. It's therefore strongly advisable to be very careful when disabling accepting connections from remote, since it will be no longer possible to reconnect to the desktop via NoMachine once the current session is closed.

As administrator, you can override user's settings and forcibly enable or disable the screen sharing for the given user. The user, however, will be still able to change it from the !M Monitor menu:

nxserver --useredit USERNAME --screensharing yes
or:
nxserver --useredit USERNAME --screensharing no
The screensharing flag can be set also when creating the user:
nxserver --useradd USERNAME --screensharing yes|no
To view the current users' settings:
nxserver --userlist --screensharing yes|no


13. Device Sharing, Copy&Paste and File Transfer

The Small Business Server allows users to access and share their devices and resources from locale to remote and vice-versa. Disks, printers, USB devices and more can be connected inside the session to easily access them from both client and server side. At present device sharing is not available with web sessions and requires to connect by NoMachine client.

Two-ways copy and paste is fully supported. Web sessions implements the NoMachine virtual clipboard provides for copying text from/to the session running in the browser and the local computer.

Download/upload files from the session to the local computer and vice-versa is also fully supported in client and web sessions, as well as drag and drop of a file from remote to locale and from locale to remote.

By default device sharing, copy&paste and file transfer are always permitted. You can however completely disable any of these services or disable it only partially, for example to prevent users from sharing their local printer in the NoMachine session but permitting them to use the remote printer.



13.1. Connecting Devices

NoMachine implements a self-contained infrastructure for making available physical and logical devices over the network from local to remote or vice-versa.

The NoMachine infrastructure for device sharing ensures that all services work out of the box without the need for any additional change or configuration. It is possible to connect disks, printers, USB devices, network port and smartcards.

Connecting devices is supported only by NoMachine client (web sessions don't support that). Devices can be connected through the NoMachine menu within the session (ctrl+alt+0 to open it). Connected devices can be disconnected during the life of the session and reconnected later. If option 'Export this deviceName at session startup' is checked in the menu panel, this device is automatically reconnected at the next session start-up.

Disabling device sharing
You can disable selectively the possibility to share a device

from the User Interface
in the Server User Interface -> Devices panel

or in the node configuration file
by editing the corresponding keys. The manual configuration also allows the service to be limited to one-way, for example forbid to connect a local printer to the remote host. The next paragraphs deal with manual node configurations in detail.

The available devices are:

Devices Configuration Technical details
Disks Local and remote disks can be connected and disconnected during the life of the session and navigated by file browsing. A disk connected as 'Public' is available to all users accessing that desktop. A private disk is available only to the user who connected it.
Administrators can configure paths on the server where public and private disks will be mounted as well as specifying which disks on the server can be made available to users.
This service uses FUSE, installed on the Linux system by default. The nxfs and nxfsserver programs are used to mount disks.
Printers Local and remote printers can be connected at any time (bi-directional printing). A connected printer is listed among the available printers when printing a document or similar. A printer can be connected to be 'Public', i.e. available to all users connected to that desktop, or private, for a specific user. It can be also configured to be the default printer. This services uses the CUPS infrastructure present on the Linux system. A printer can be exported to the server only if the connected user is in the lpadmin group.
USB devices USB devices such as disks, pendrives, webcam etc... are forwarded through the network. For example, when a USB device is forwarded from locale (where the player is running) to remote, it becomes available on the remote side only. This service is based only on the NoMachine USB Server (nxusbd) and drivers (the nxusb.ko kernel module for Linux) and doesn't require external tools.
Network ports Service ports (such as Samba, CUPS, FTP, SSH, telnet and others) can be made available from local to remote and vice-versa via a virtual network interface. This service relies on a NoMachine tool plus a standard driver.
Smart Cards A smartcard reader can be forwarded from client to server side and makes smartcard authentication available within the session. The server host must support authentication via smartcard. Support for authentication with smart card has been set-up by relying on the Public Key Infrastructure (PKI) and requires an OpenSC compatible smart card. It can be integrated with Kerberos ticket authentication and ticket forwarding.


13.2. Disks

NoMachine allows access to local and remote file systems from within the session through the SSHFS file-sharing protocol and by means of FUSE, a technology to implement a fully functional filesystem in a userspace program.

Connected folders and disks can be disconnected during the life of the session or left as they are.

By default, all disks from the server are available to be connected to the end-user's machine. However you can specify a set of disks and folders by editing a proper value for the DiskSharingList key in the node configuration file. The default value is: all. Alternatively, you can specify a list of comma-separated directories. Note that $(HOME) and $(USER) are accepted values.

Disks from the end-user's machine can be connected on the server in 'Public' or 'Private' mode.

Connecting public disks
Disks from the end-user's machine can be connected on the server in 'Public' or 'Private' mode.
By default public disks are exported from player to "$(PUBLIC)" directory on the server, where $(PUBLIC) is: /media on Linux.

You can specify a different path by un-commenting and editing the DiskSharingPublicBasePath key in the node configuration file.
Note that $(USER) is an accepted value that can be also concatenated to specify the path to a directory, for example "/tmp/$(USER)".

The target directory must exist on the system!

Disabling Disks' Connection
To forbid disk and filesystem sharing, uncomment and set a proper value for the EnableDiskSharing key in the node configuration file:
client The filesystem on the client can be connected to server side and accessed from the session.
server The filesystem on the server can be connected to the end-user's machine and accessed through the whole life of the session.
both Client and server filesystem can be connected to remote and local sides respectively.
none Neither client or server filesystem can be connected.

For example, to forbid connecting disks from remote to local side, set in the node configuration:
EnableDiskSharing client



13.3. Printers

The printers sharing infrastructure integrates client-side printers with the server-side printing subsystem and vice-versa. Printers available on the client machine can be shared and used within the session as well as printers on the server side which can be made available on the end-user's machine.

Connected printers can be disconnected during the life of the session or left as they are. In this case, they are automatically shared at the next session start-up.

On Linux this service uses the CUPS infrastructure present on the system. With CUPS 1.4 or later, to ensure that users are able to connect a printer from locale to their NoMachine session on Linux , it's necessary that the user already belongs to the CUPS System Group on the NoMachine server host. This is because in order to add a printer to the CUPS system, the 'lpadmin' command line tool has to be executed by a user who belongs to the CUPS's System Group, which can be for example 'lpadmin' on Ubuntu, 'sys' on Fedora, RHEL and CentOS distributions.

Disabling Printers' Connection
To forbid printer sharing it is necessary to uncomment and set a proper value for the EnablePrinterSharing key in the node configuration file:
client Printers on the client can be connected to server side and made available within the session.
server Printers on the server can be connected to the end-user's machine.
both Client and server printers can be connected to remote and local sides respectively.
none Neither client or server printers can be connected.

For example, to forbid a server-side printer to be connected to the end-user machine, set in the node configuration:
EnablePrinterSharing client



13.4. USB Devices

This service creates a USB tunnel between client and server to forward devices over the network such as hard disk, web cams, barcode readers, and pen drives from local to remote desktops and vice-versa.

Disabling USB Forwarding
To forbid USB device sharing it is necessary to uncomment and set a proper value for the EnableUSBSharing key in the node configuration file:
client USB devices on the client can be forwarded to server side and made available within the session.
server USB devices on the server can be connected to the end-user's machine.
both Client and server USB devices can be connected to remote and local sides respectively.
none Neither client or server USB devices can be connected.

For example, to avoid that users can forward a USB devices from the server to its own machine, set in the node configuration:
EnableUSBSharing client



13.5. Network Ports

NoMachine can create virtual network interfaces and establish a bridge between local and remote sides or vice-versa to provide transparent access to network resources.

This service allows access to any of the default network servers like Samba, CUPS, FTP, SSH and Telnet or any other type, for example a MySQL server.

Connecting a Samba server allows access to resources on that server host via the SMB/CIFS protocol. Connecting a local CUPS server to the remote side allows mounting of printers (local to the user) on that remote CUPS subsystem so that files can be printed on the remote side via the IPP protocol.

Some typical examples of usage:
Print to remote printers from the session
If you have a Linux or Mac machine you can add the locale CUPS server via the player toolbar. Choose to add a local server and select CUPS. In this way all printers that are available on your side will be available also on the server and you can print all your documents via the native CUPS (IPP) protocol.

Access a remote host not in your Network Neighborhood
If the remote host has a Samba server, you can add it via the player toolbar. Choose to add a remote server and select Samba as server type. Once that Samba server is added, the remote host shows up in your local Network Neighborhood. You can then connect to remote folders via SMB/CIFS protocol as if that host was in your local network.

Make available a client side HTTP server
You can add your local HTTP server via the player toolbar and make it available on the remote host where your session is running. In this way you can develop and test your web application directly inside the session, without the need for sharing or moving files from remote to local.

Connect to MySQL server behind a firewall
You can choose to add a remote server via the player toolbar. Select 'Custom' and specify MySQL and the port for the MySQL server, by default 3306. Once done, you can connect to that MySQL server via the MySQL client installed on your PC.

Disabling Network Port Forwarding
To forbid network server sharing you must uncomment and set a proper value for the EnableNetworkSharing key in the node configuration file: client Network servers on client side can be connected and made available within the session.
server Network server on the server side can be connected and made available on the end-user's machine.
both Network servers from client and server side can be connected to remote and local sides respectively.
none Neither client or server side network servers can be connected.

For example, to forbid users from connecting their local ports to the server, set in the node configuration:
EnableNetworkSharing server



13.6. Smartcard Readers

When the smartcard reader plugged into the enduser's host is forwarded to the server host, the smartcard authentication is made available inside the session. It can be integrated on with Kerberos Ticket system for example for implementing single sign-on (SSO).

Disabling Smartcard readers' Forwarding
You can enable or disable support for smarcard forwarding by uncommenting and setting the EnableSmartcardSharing key in the node configuration to 1 or 0 respectively.

To disable it set in node configuration file:
EnableSmartcardSharing 0



13.7. Copy and Paste Operations

By default users can copy and paste from locale to the session and vice-versa.

You can configure the server to limit such operations by setting proper values in the configuration file as explained below.

Limiting copy & paste operations
To forbid copy & paste partially or totally, uncomment and set a proper value for the EnableClipboard key in the server configuration file:
client Content copied on the user's side can be pasted inside the session.
server Content copied inside the session can be pasted on the user's side.
none No copy and paste operations are allowed.
both Two-way copy and paste operations are allowed.

Limiting the Clipboard Buffer
By default, the clipboard buffer is unlimited. If you want, for example, to limit the clipboard buffer to 4MB, you have to uncomment and set the following key (value is espressed in bytes) in the node configuration file:
ClipboardBufferLimit 4194304



13.8. Transferring Files

When a user is connected to the desktop, they have the possibility to transfer files by using the Connection Monitor tool from the system tray within the session. The user can transfer a file from their own PC to the remote host where the session is running and vice-versa. If multiple users are connected, each of them can send a file to a specific user or to all connected users. Drag and drop of a file is also supported

You can manage file transfer
from the User Interface
In the Server User Interface -> Transfers panel

or via node configuration.

Disabling File Transfer
To forbid file transfer you have to uncomment and set a proper value for the EnableFileTransfer key in the node configuration file:
client Files can be transferred from client machine to the server.
server Files can be sent from the server to clients.
both Client and server files can be transferred on remote and locale respectively.
none Neither client or server files can be transferred.

For example, to forbid users from transferring a file from the server to their PC:
EnableFileTransfer client



14. Multimedia and Session Recording


14.1. Supporting Audio and Microphone

On Linux, NoMachine audio framework is integrated with PulseAudio sound server. If PulseAudio is not available on the system, NoMachine is able to use ALSA (Advanced Linux Sound Architecture). This is automatically managed by the NoMachine server so that multimedia support can work out of the box without the need for any configuration. If both PulseAudio and Alsa are available, the administrator might want to configure the node to use one or the other.

Disabling or Setting Audio Support
To disable audio and microphone support, uncomment and set the AudioInterface key to 'disabled' in the node configuration file:
AudioInterface disabled

On Linux it is possible to define whether PulseAudio Server or ALSA has to be used by setting AudioInterface key to 'pulseaudio' or 'alsa' respectively. For example:
AudioInterface pulseaudio



14.2. Recording your Screen

NoMachine can video-record all activity made inside the session or on the desktop. To start the recording of the session, users should open the NoMachine menu inside the session (ctrl+alt+0) and click on the 'Recording' button icon to access the Recording panel. From this panel it's possible to open the recording bar, change audio and video quality and open the recording directory to access all recorded files. Session recording is not available with sessions on the web.

To record activity made on the desktop, start the recording from the !M icon menu in the system tray of the Small Business Server host and show the Recording bar from there. Desktop activities can be registered on the physical desktop without the need to be connected by NoMachine.

Recorded files are saved by default in WebM format and can be played back directly with NoMachine or any other player supporting that format. Video streams can be encoded only with VP8 or H.264 when supported. Recorded files are saved by default on the user's device in the NoMachine directory under the 'Documents' directory.

Disabling session recording
To prevent users from recording their session activities, edit the node configuration to set:
EnableSessionRecording 0

Disabling desktop recording
To prevent users from recording desktop activities, even when physically logged into the Small Business Server host, edit the node configuration to set:
EnableLocalRecording 0



15. Automatic Updates

The Small Business Server, as well as the other NoMachine client and server products, periodically checks NoMachine repositories (by default every two days) to verify if updates are available and will prompt a dialog informing the user that a new version is available.

It will never automatically update the current installation. Also the download in background of a new software version will not lead to an automatic update of the current installation.

A separate User Interface which deals specifically with all the possible options for the automatic software updates is available on the web site in this section:

https://www.nomachine.com/all-documents



16. Behavior of NoMachine 6 vs. Legacy Servers

Some behaviors typical of NX 3.5.0 server are maintained:

I A new virtual desktop is created for each new connection. The virtual desktop type (GNOME, KDE etc ...) must be specified in the connection settings: to do that in client v. 6, 5 or 4, choose the desktop type the first time you run the session and remember to save the connection settings.
II You can migrate a virtual desktop session from one PC to another one: the session is disconnected and reconnected on the new client.

Behaviors above are automatically available when connecting from client 4.1 or later. The client overrides values set in the ConnectPolicy key in the server configuration.

Differently to version 3.5, NoMachine runs the default desktop set on the system instead. By adopting the configuration explained in the next paragraph, it's possible to allow users to choose the virtual desktop type from a list, e.g. choose between running a GNOME or a KDE desktop. Additionally, it's also possible to display the 'disconnect/terminate' dialog typical of version 3.5.

16.1. Listing the Available Desktop Types

To provide users with the list of all the available desktop types on that host (e.g., GNOME and KDE), enable the desktop option in the server configuration:
ConnectPolicy autocreate=1,autoconnect=1,automigrate=1,desktop=1,dialog=0

This setting works in conjuction with the following keys in the node configuration to define the command to be usedd to start a GNOME or a KDE desktop:
CommandStartGnome ""
CommandStartKDE ""



16.2. Activating the Disconnect/Terminate Dialog

It's possible to configure the server to display a dialog to let the user decide whether to disconnect or terminate the virtual desktop session when clicking on the X button to close the session window.

This allows administrators to re-introduce the disconnect/terminate dialog typical of NX 3.5.0 but it will override the possibility of disconnecting the session by clicking on the X window button. It will be still possible to terminate the session by executing log-out from the system menu.

he Disconnect/Terminate dialog is available for:

I virtual desktops running in X11 vector graphics mode
II virtual desktops not running in X11 vector graphics mode
III virtual custom sessions


To enable the Disconnect/Terminate dialog, enable the 'dialog' option (i.e. set 'dialog=1') in the following key available in the server configuration:
ConnectPolicy autocreate=1,autoconnect=1,automigrate=1,desktop=0,dialog=1



17. Logging Facilities

Two separate guides, available in the Documents section on the NoMachine web site (https://www.nomachine.com/all-documents) provide step-by-step instructions for that.

TIP
When debug mode is enabled, server logs may increase consistently. It's suggested to keep debug level only for the time necessary to reproduce the problem and collect logs.


17.1. Using the System Logging Facilities

By default the nxserver, nxwebplayer/nxclient and nxnode programs log to the file defined in the SystemLogFile key in their configuration files (server.cfg for nxserver and nxwebplayer/nxwebclient and node.cfg).

It's possible to configure these applications to log to the system log file instead. Edit the server.cfg and node.cfg files, uncomment and set:

EnableSyslogSupport 1

Then restart the server and all services to make the change effective:

nxserver --restart


17.2. Redirecting Logs to a Custom File

You can redirect logs of nxserver, nxwebplayer/nxclient and nxnode programs to a custom file by uncommenting and setting the path to that file in the SystemLogFile key available in the server and node configuration files. By default this key is set to:

SystemLogFile /usr/NX/var/log/nxserver.log

Change it to point to a different file, for example:

SystemLogFile /tmp/NX.log

TIP
The custom file must be accessible (writable) to the 'nx' user and to the connected user.


17.3. Configuring the Automatic Clean-up of Session Directories

In its default configuration, the Small Busines Server removes the session directory once the session has been correctly terminated. Sessions directories are stored in the /usr/NX/var/log/node/ directory.

You can preserve it, for example for log purposes, by uncommenting and disabling the following key in the node configuration file. In this case, the session directory in user's home/.nx is renamed as T-C*:

SessionLogClean 0