Commit af5833a4 authored by Lisa Gerhardt's avatar Lisa Gerhardt Committed by Brandon

Lgerhard/tweak nx docs

parent 89b98ff1
# NX / NoMachine
# NoMachine / NX
NX (aka NoMachine) is a computer program that handles remote X Window
NoMachine (aka NX) is a computer program that handles remote X Window
System connections which offers several benefits over traditional X
forwarding.
NX can greatly improve the performance of X Windows, allowing users
NoMachine can greatly improve the performance of X Windows, allowing users
with slow, high latency connections (e.g. on cell phone network,
traveling in Africa) to use complex X Windows programs (such as
rotating a plot in Matlab).
NX provides functionality that allow a user to disconnect from the session
NoMachine provides functionality that allow a user to disconnect from the session
and reconnect to it at a later time while keeping the state of all
running applications inside the session.
!!! caution
Using NX requires both a recent NoMachine client and a recent connection file (specific
to accessing NERSC). Please make sure you have recently updated versions
of both of these.
Using NoMachine requires both a recent NoMachine client and a
connection file specific to accessing NERSC (see below for
instructions to create a new connection file). Please make sure
you have recently updated versions of both of these.
## Installing the NoMachine Client
......@@ -26,16 +27,7 @@ running applications inside the session.
#### DEB Package for Debian/Ubuntu: ([Download](https://www.nomachine.com/download/download&id=10))
#### RPM Package for Centos/Redhat/Fedora ([Download](https://www.nomachine.com/download/download&id=11))
## Installing the Configuration File
Download the most recent configuration file:
[NX configuration file](https://portal.nersc.gov/project/mpccc/nx/Connection_to_NERSC_NX_service.nxs.gz)
This is a compressed file, so you will need to extract/unzip it. Once you have
done this, you need to click on this file so the NoMachine client can be
configured. It will automatically open the NoMachine client when it does this.
To return to the main menu, you can close the client and re-open it. You will
need the main menu for the next steps of the connection process.
## Configuring the Connection File
**Depending on whether you are using the NERSC [sshproxy](https://www.nersc.gov/users/connecting-to-nersc/mfa/)
service, we have two different sets of connection instructions below.**
......@@ -43,14 +35,14 @@ service, we have two different sets of connection instructions below.**
## Creating a connection to NERSC **WITH sshproxy**
If you don't wish to re-authenticate with your password and a new
one-time password every time the NX Client is disconnected (e.g. if
one-time password every time the NoMachine Client is disconnected (e.g. if
you close your laptop), you can connect with an ssh key generated by
sshproxy. You will need to regenerate the ssh key with sshproxy once a
day, but otherwise the NX Client will automatically reconnect.
day, but otherwise the NoMachine Client will automatically reconnect.
!!! caution
Since the most recent NX update (Wednesday, April 10, 2019), using sshproxy
is broken by default in NX. NoMachine has provided a workaround which will require
Since the most recent NoMachine update (Wednesday, April 10, 2019), using sshproxy
is broken by default in NoMachine. NoMachine has provided a workaround which will require
you to manually edit one of your config files. **Following step 9 in the
directions below should fix this issue.**
......@@ -58,7 +50,7 @@ day, but otherwise the NX Client will automatically reconnect.
(instructions are
[here](https://www.nersc.gov/users/connecting-to-nersc/mfa/#toc-anchor-3)).
Note that you must do this once every day to generate a new key.
2. Open the NX client and click the "New" box in the upper right
2. Open the NoMachine client and click the "New" box in the upper right
corner of the menu.
3. Choose "SSH" for protocol and click Continue.
4. Type in "nxcloud01.nersc.gov" for Host (leave the port set to 22)
......@@ -75,29 +67,26 @@ day, but otherwise the NX Client will automatically reconnect.
connection.nxs") which will automatically load your NERSC connection settings.
If you do not create a desktop icon, you can just click the NoMachine icon and
then select the name of your connection.
9. **SSHPROXY WORKAROUND**: You will need to edit one of the NX config files on your
local machine:
```
cd $HOME/.nx/config
vi player.cfg
```
and change the following key from ``library`` to ``native``:
9. **SSHPROXY WORKAROUND**: You will need to edit one of the NoMachine
config files on your local machine. First exit the NoMachine
program and then edit ```$HOME/.nx/config/player.cfg``` and
change the following key from ``library`` to ``native``:
```
<option key="SSH client mode" value="native" />
```
This should enable sshproxy to work with NoMachine.
10. To log on to NERSC NX, click on the connection you just created. You should
10. To log on to NERSC NoMachine, click on the connection you just created. You should
not need to enter your username or password. At this point you should now be
logged onto the NX desktop.
logged onto the NoMachine desktop.
## Creating a connection to NERSC **WITHOUT sshproxy**
If you would prefer not to use the sshproxy service, you can still
connect to NX. You will need to enter your password + OTP (no spaces
in between) every time you log on to NX.
connect to NoMachine. You will need to enter your password + OTP (no spaces
in between) every time you log on to NoMachine.
1. Open the NX client and click the "New" box in the upper right
1. Open the NoMachine client and click the "New" box in the upper right
corner of the menu.
2. Choose "SSH" for protocol and click Continue.
3. Type in "nxcloud01.nersc.gov" for Host (leave the port set to 22)
......@@ -109,50 +98,59 @@ in between) every time you log on to NX.
connection.nxs") which will automatically load your NERSC connection settings.
If you do not create a desktop icon, you can just click the NoMachine icon and
then select the name of your connection.
7. To log on to NERSC NX, click on the connection you just created. You will need
7. To log on to NERSC NoMachine, click on the connection you just created. You will need
to enter your username and password+OTP. At this point you should now be
logged onto the NX desktop.
logged onto the NoMachine desktop.
## Troubleshooting
### Connecting to NX
### Connecting to NoMachine
If you are having trouble connecting to NX, please try these steps:
If you are having trouble connecting to NoMachine, please try these steps:
1. Log into [NIM](https://nim.nersc.gov) to clear any login
failures. Access to NX uses your NERSC user name and password. If
failures. Access to NoMachine uses your NERSC user name and password. If
your password is mistyped five times, NERSC will lock you out of
their systems. Logging into NIM will automatically clear these
failures. This will also let you know if your password is expired
(which would prevent you from accessing NX, among many other
(which would prevent you from accessing NoMachine, among many other
things).
2. Re-download
the
[NX configuration file](https://portal.nersc.gov/project/mpccc/nx/Connection_to_NERSC_NX_service.nxs.gz). NX
will often "update" the configuration file to try to save your
settings and sometimes this file can get some bad settings. You
must have the new NX player AND the new configuration file to
connect to the NX service.
3. Try to ssh directly to the NX server. You can do this with the
2. Create a new connection file following [the instructions
above](#configuring-the-connection-file). NX will often
"update" the configuration file to try to save your settings and
sometimes this file can get some bad settings. You must have the
new NoMachine player AND an updated configuration file to connect
to the NoMachine service.
3. Try to ssh directly to the NoMachine server. You can do this with the
command
```
ssh <nersc_username>@nxcloud01.nersc.gov
```
and your NERSC
user name and password+one-time MFA password (with no spaces in
between). If your access to the NX server is blocked by a local
between). If your access to the NoMachine server is blocked by a local
firewall or something else and you can't connect via ssh, you will
also not be able to connect with the NX client. If this is the case,
also not be able to connect with the NoMachine client. If this is the case,
please contact your local IT department.
4. If you're using sshproxy, test the sshproxy key by using it to ssh
to the NoMachine server. You can do this with the command
```
ssh -i ~/.ssh/nersc <nersc_username>@nxcloud01.nersc.gov
```
If this fails and Step 3 works, there may be a problem with your
sshproxy key, please open a ticket with NERSC to diagnose the issue.
If you've tried these steps and still cannot connect, please open a
help ticket. In this ticket, please include the following information:
1. The type of system you're trying to connect from (i.e. Mac,
Windows, Linux, etc.).
1. A screen capture of the error you get (if possible).
1. A tarball of the NX logs. You can find instructions for how to
bundle your NX logs on
1. A tarball of the NoMachine logs. You can find instructions for how to
bundle your NoMachine logs on
the [NoMachine website](https://www.nomachine.com/DT07M00098).
## Connecting via the Broswer Interface
......@@ -163,7 +161,7 @@ Point your browser at [nxcloud01](https://nxcloud01.nersc.gov).
The browser interface is still experimental and can sometimes
be slower than connecting via the client.
### Configuring the NX Environment
### Configuring the NoMachine Environment
#### Font size is too big or too small
......@@ -178,13 +176,13 @@ on an empty desktop then choose "Konsole", inside the Konsole, type
"kcmshell4 fonts". Then you have a dialog box to change your font
size.
#### Resizing the NX screen
#### Resizing the NoMachine screen
With the latest NX Player (5.0.63 or later), the most efficient way is
to enable "Remote Resize" in the NX menu:
With the latest NoMachine Player (5.0.63 or later), the most efficient way is
to enable "Remote Resize" in the NoMachine menu:
1. Connect to NX
1. From the desktop, bring up the NX player menu with a hotkey: Mac:
1. Connect to NoMachine
1. From the desktop, bring up the NoMachine player menu with a hotkey: Mac:
Ctrl+Option+0, Windows: Ctrl+Alt+0, Linux: Ctrl+Alt+0
1. Choose the "Display" submenu, then toggle the "Remote Resize"
button. You can also choose "Change Settings" to manually change
......@@ -195,9 +193,9 @@ to enable "Remote Resize" in the NX menu:
This is due to a problem with font server. Please use the following
command instead: `emacs -font 7x14`
#### Customize your NX termimal
#### Customize your NoMachine termimal
If you dislike the default NX terminal color scheme (white background, dark
If you dislike the default NoMachine terminal color scheme (white background, dark
text), you can open a terminal from the `Show Applications` menu at the bottom
of the menu bar on the left hand side of the screen (it looks like 9 dots).
Once you have opened your terminal, click `Edit` --> `Preferences` in the
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment