Support Center

Your questions answered

Knowledge Base

Searching in: Documents
Filter the search results
Version:
Last update:
Searching in: Documents
ID: DT09K00057
Version: NX 4
Added on: 2013-09-24
Last update: 2015-07-07
NoMachine Enterprise Products v. 4, Cloud Server Installation and Configuration Guide

 

Table of Contents

1. NoMachine Cloud Server Installation and Configuration Guide

1.1. Resources on the Web

1.2. Prerequisites
2. Installing on Windows

2.1. Installing the Cloud Server

2.2. Updating the Cloud Server

2.3. Uninstalling the Cloud Server
3. Installing on Mac OS X

3.1. Installing the Cloud Server

3.2. Updating the Cloud Server

3.3. Uninstalling the Cloud Server
4. Installing on Linux

4.1. Managing the RPM Package

4.2. Managing the DEB Package

4.3. Managing the TAR.GZ Package
5. Initiating a Web Connection via Cloud Server
6. Managing the Cloud Server
7. Connecting Multiple Servers by Cloud Server

 

 

1. NoMachine Cloud Server Installation and Configuration Guide

Welcome to the NoMachine Cloud Server Installation Guide version 4. This document is intended to provide you with step-by-step instructions on how to install the Cloud Server package (it was named 'Portal Server' in version 4.0) and it's updated to fit version 4.2.27 and later.

This package includes a small Apache-based web server, the NoMachine HTTP server (nxhtd), pre-configured to work out-of-the box to let you get access to the server on which it is installed, or other Enterprise and Cloud Servers.

 

1.1. Resources on the Web

The NoMachine Web site, www.nomachine.com, provides you with a variety of online resources in conjunction with the software and its usage:


The NoMachine Packages
The latest version of NoMachine is available at: www.nomachine.com/download.


The Knowledge Base
The Knowledge Base, https://www.nomachine.com/support, makes available both technical documents especially for administrators and end-user oriented guides, as well as articles on specific topics and How-Tos.


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

 

1.2.Prerequisite

Operating System

  • Windows 32-bit/64-bit XP/Vista/7/8/8.1
  • Mac OS X Intel 64-bit 10.5/10.6/10.7/10.8/10.9/10.10
  • Linux 32-bit and 64-bit
    Red Hat Enterprise 4/5/6/7
    SLES 10/11
    SLED 10.x/11.x
    Open SUSE 10.x /11.x/12.x/13.x
    Mandriva 2009/2010/2011
    Fedora 10/11/12/13/14/15/16/17/18/19/20/21
    Debian GNU Linux 4.0 Etch/5.0 Lenny/ 6.0 Squeeze/ 7.0 Wheezy/ 8.0 Jessie
    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



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: 
    Windows   107.5 MB 
    Linux     81 MB   
    Mac       83 MB

 

2. Installing on Windows

 

2.1. Installing the Cloud Server

Download the package from the NoMachine web site and install it by double-clicking on the icon of the executable: a setup wizard will take you through the installation. Accept to reboot the machine, this is mandatory for completing the installation.

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

 

 

 

Tip

To install the package in silent or very silent mode from a CMD console, run respectively:

>nomachine-packageName_packageVersion.exe /silent

or:

>nomachine-packageName_packageVersion.exe /verysilent

Then reboot the machine:

> SHUTDOWN -r -t 10 -c " your comments here"

 

To specify a non-default installation directory, use:

nomachine-packageName_packageVersion.exe  /SILENT /DIR="X:Target_directory"

or:

nomachine-packageName_packageVersion.exe  /VERYSILENT /DIR="X:Target_directory"


Note for Windows XP: the NoMachine server will not start until the machine is rebooted.

 

2.2. Updating the Cloud Server

Starting from version 4.0.365, you can update your installation from the NoMachine repositories instead of downloading and installing the new package. Just run the NoMachine GUI and access the Preferences -> Updates panel and click on 'Check now'.

Note that since version 4.6.3 NoMachine has the automatic check for updates enabled: it will periodically check our repositories (by default 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.

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

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

 

2.3. Uninstalling the Cloud Server

You can uninstall NoMachine Cloud Server from the Windows Control Panel and the “Add or Remove Programs” in Windows XP or “Program and Features” in Windows Vista , 7 or 8. Find the NoMachine program in the list of installed programs and choose to uninstall it.


On Windows 8, you can use the Search box from the Charms bar on the right side of the screen: type Control Panel to open it. Then access the Programs - 'Uninstall a program' panel.


On Windows 7, Vista and XP, click on the Start button and click to open the Control panel from the Start menu. Then access panel 'Programs and Features' or 'Add or Remove Programs', depending on your Windows version.

Reboot is requested to complete the uninstalling process.

Tip

To uninstall from a CMD console, move to C:/ProgramData/NoMachine/var/uninstall/ (if you are on Vista/7/8) or to C:/Documents and Settings/All Users/NoMachine/var/uninstall/ (if you are on XP). Then run:

> unins000.exe /silent

or:

> unins000.exe /verysilent
Uninstalling is completed when your command prompt is back. Then, your computer will restart automatically. 

 

3. Installing on Mac OS X

 

3.1. Installing the Cloud Server

Download the DMG package from the NoMachine web site. Double-click on the disk Image to open it and see the package icon. Then double-click on the package icon to install the program: the installer will take you through the installation.

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

 

 

 

Tip

To install from the command line, run:

$ NXMOUNTDIR=$(echo `hdiutil mount nomachine-cloud-server_version.dmg | tail -1 | awk '{$1=$2=""; print $0}'` | xargs -0 echo)

$ sudo installer -pkg "${NXMOUNTDIR}/NoMachine.pkg" -target /

 

3.2. Updating the Cloud Server

Starting from version 4.0.365, you can update your installation from our repositories instead of downloading and installing the new package. Just run the NoMachine GUI and access the Preferences -> Updates panel and click on 'Check now'.

Note that since version 4.6.3 NoMachine has the automatic check for updates enabled: it will periodically check our repositories (by default 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.

Alternatively, you may download the lastest available package from the NoMachine web site and click on the dmg file to mount the disk image and launch the Installer. As for the installation, Installer will guide you through all steps necessary for updating your installation.

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

3.3. Uninstalling the Cloud Server

To uninstall the Cloud Server drag and drop NoMachine from Applications to trash or select 'Move to trash' from the mouse button menu. This will uninstall all the NoMachine software.

Tip

To uninstall from command line, it's enough you remove the NoMachine application directory:

$  sudo rm -rf /Applications/NoMachine.app

 

4. Installing on Linux

Notes for the first installation

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.

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


Up to version 4.4.6, all packages were qualified by the same name 'nomachine'. Next versions use different package names to distinguish among client, node and server types (FR09L02829).

Notes for updating the installation

Starting from version 4.0.365, you can update your installation from our repositories instead of downloading and installing the new package. Just run the NoMachine GUI and access the Preferences -> Updates panel and click on 'Check now'.

Note that since version 4.6.3 NoMachine has the automatic check for updates enabled: it will periodically check our repositories (by default 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.

Alternatively, you may download the lastest available package from the NoMachine web site and use the graphical installation program provided with your Linux distribution or update the installation by command line as explained below.

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

 

4.1. Managing the RPM Package

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

Installing


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

Updating

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

Uninstalling


# rpm -e nomachine-cloud-server


For versions up to 4.4.6 use:

# rpm -e nomachine

Tip

To find out which NoMachine package you have installed, run the following command:

# rpm -qa | grep nomachine

You will get the full name of the NoMachine package already installed, for example: nomachine-cloud-server-4.4.10-1.x86_64


If you want to install to a non-default location, for example /opt/NX


Installing

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

Updating

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

Uninstalling


# rpm -e nomachine-cloud-server

or for versions up to 4.4.6:

# rpm -e nomachine

 

4.2. Managing the DEB Package

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

Installing


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

Updating


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

Uninstalling

$ sudo dpkg -r nomachine-cloud-server


For versions up to 4.4.6 use:

$ sudo dpkg -r nomachine

 

Tip

To find out which NoMachine package you have installed, run the following command:

$ dpkg -l | grep nomachine

You will get the full name of the NoMachine package already installed, for example: nomachine-cloud-server 4.4.10-1



If you want to install to a non-default location, for example /opt/NX:


Installing

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

Updating

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

Uninstalling


$ sudo dpkg -r nomachine-cloud-server

or for versions up to 4.4.6:

$ sudo dpkg -r nomachine

4.3. Managing the TAR.GZ Package

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

Installing

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

Updating


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

Uninstalling


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

in case, remove the installation dir:

$ sudo rm -rf /usr/NX


If you want to install to a non-default location, for example /opt/NX:


Installing

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

Updating


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

Uninstalling


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

in case, remove the installation dir:

$ sudo rm -rf /opt/NX

 

5. Initiating a Web Connection via Cloud Server

Once installation has completed with success, Cloud Server is ready to go. Point your browser to http://serverName:4080 where serverName is either the name or IP address of the host you want to reach. E.g., if you have the installation on a host named myserver.com, the URL will look like this: https://myserver.com:4080. Then provide your username and password and connect.

 

6. Managing the Cloud Server

You can start and stop the NoMachine HTTP server (nxhtd) from the NoMachine GUI -> Preferences -> Server status -> Server Preferences -> Services panel.  Always from the NoMachine GUI you can also change the listen port for the web server (by default 4080 and 4443 for secure connections).

 

7. Connecting Multiple Servers by Cloud Server

By default the Cloud Server connects to the server installed local to the web player application, but it can be configured to give access to multiple servers on different hosts. To do that, you have to follow instructions below.

Step 1

First of all, it's necessary to change some configurations in the cloud.cfg file that is:

/usr/NX/etc/cloud.cfg on Linux

C:\Program Files\NoMachine\etc\cloud.cfg on Windows

/Applications/NoMachine.app/Contents/Frameworks/etc/cloud.cfg on Mac OS X.

 

The 'SectionSession' directive in the cloud.cfg file allows to define to which server users will connect to.

SectionSession  "Connection to localhost"

ServerHost localhost
ConnectionMethod NX
ConnectionPort 4000
ServerPath /etc/NX/nxserver

EndSection


Name set in the "Connection to localhost" field is the connection name that will appear to users when there are multiple servers available.

ServerHost is IP or hostname of the server machine.

ConnectionMethod and Port indicates protocol and port that web player will use to connect to the server.

Supported protocols are:

  • NX
  • SSH with system login
  • SSH with nomachine login (i.e. authenticating by using NoMachine DSA keys and user 'nx').

Set 'ConnectionMethod NX' to use the NX protocol (this is the default).

Set 'ConnectionMethod system' to use SSH protocol and system login

Set 'ConnectionMethod nomachine' to use SSH protocol and NoMachine DSA keys.

Note NoMachine uses by default port 22 for SSH protocol on Linux and Mac, and port 4022 on Windows. Default port for NX protocol is 4000.


ServerPath indicates path to launch the server program and in general doesn't need changing, unless you installed the server in a non-default path.


To allow users to connect to multiple servers by a unique Cloud Server, add a new 'SectionSession' for each of them and specify a different name in the  "Connection to localhost" field to recognize different servers.

For example:

SectionSession  "Connection to server A"

ServerHost localhost
ConnectionMethod NX
ConnectionPort 4000
ServerPath /etc/NX/nxserver

EndSection

SectionSession  "Connection to server B"

ServerHost 192.168.1.12
ConnectionMethod system
ConnectionPort 22
ServerPath /etc/NX/nxserver

EndSection

 

Step 2 - Update the list of allowed hosts

Depending if web player is configured to allow connections via NX or SSH protocol, you need to follow procedure a) or b).

a) ConnectionMethod is set to 'NX' in the cloud.cfg configuration file

To connect via web player and NX protocol to another server than localhost, you need to update list of allowed hosts in the client.crt file.

This file is placed in the home of the nxhtd user at:

/var/NX/nxhtd/.nx/config/ on Linux

%PROGRAMDATA%\NoMachine\nxhtd\.nx\config\ on Windows Vista, 7 and 8

/Library/Application\ Support/NoMachine/var/nxhtd/.nx/config/ on Mac OS X


1) Create a backup of the original file, client.crt.

2) Copy in place the nxd certificate from the server host machine to the web player host.

For example on Linux, if the server is 192.168.1.12, copy from 192.168.1.12 its nxd certificate to your Cloud Server host installed let's say on testdrive:

# scp root@testdrive.nomachine.com:/usr/NX/etc/keys/host/nx_host_rsa_key.crt

3) Then add a line to the client.crt file to specify the host and then the certificate. In this way the certificate will be assigned to the specified host:

# echo "Host:<hostname or ip>" >> client.crt

# cat nx_host_rsa_key.crt >> client.crt

so for example, if you have set 'ServerHost 192.168.1.12' in cloud.cfg, you have to issue the following commands:


# echo "Host:192.168.1.12" >> client.crt
# cat nx_host_rsa_key.crt >> client.crt

 

Then the client.crt file will look like:

Host:192.168.1.12
-----BEGIN CERTIFICATE-----
[....]
-----END CERTIFICATE-----



4) and set correct permissions and ownership:

# chmod 600 client.crt
# chown nxhtd:nxhtd client.crt



5) You can then delete the nx_host_rsa_key.crt file copied from testdrive:

# rm nx_host_rsa_key.crt

IMPORTANT:

This procedure must be repeated for each server host you want to connect by Cloud Server and NX protocol.

 

b) ConnectionMethod is set to 'SYSTEM'  or 'NOMACHINE' in the cloud.cfg configuration file

When the ConnectionMethod key it's set in the cloud.cfg file to 'SYSTEM' or 'NOMACHINE', web connections will use SSH + system login or SSH + NoMachine login respectively.

To connect via web and SSH protocol to another server than localhost,  you have to update the list of allowed hosts in the known_hosts file.

This file is placed in the home of the nxhtd user at:

/var/NX/nxhtd/.ssh/ on Linux

%PROGRAMDATA%\NoMachine\nxhtd\.ssh on Windows Vista, 7 and 8

/Library/Application\ Support/NoMachine/var/nxhtd/.ssh on Mac OS X

1) Rename the original known_hosts file:

# mv known_hosts  known_hosts.ori


2) Then execute the ssh-keyscan tool for building and verifying ssh_known_hosts files.

For example, if the Cloud Server is installed on testdrive and you want to let it connect to another NoMachine server on let's say 192.168.1.12, execute on testdrive:

# ssh-keyscan -p 22 -t rsa,dsa 192.168.1.12 >> known_hosts

where 22 is the default port for SSH connections unless the SSH server (SSHD) has been configured for listening on a different port.