Difference between revisions of "Using a VNC Server/Client"

From Hall A Wiki
Jump to: navigation, search
(Setting up PuTTY)
Line 45: Line 45:
  
 
==== Save configuration ====
 
==== Save configuration ====
 +
[[Image:puttystart.png|thumb|PuTTY's config, main ]]
 
* Select the '''Session''' entry in the left column (scroll up if you have to), and click on the '''Save''' button.  This will save your settings for Step 1.
 
* Select the '''Session''' entry in the left column (scroll up if you have to), and click on the '''Save''' button.  This will save your settings for Step 1.
[[Image:puttystart.png|center|PuTTY's config, main ]]
+
<br clear=all>
  
 
=== Step 2:  Tunnel between your machine and '''hacuser@hacweb14''' ===
 
=== Step 2:  Tunnel between your machine and '''hacuser@hacweb14''' ===
Line 53: Line 54:
  
 
==== Configure host name of remote machine ====
 
==== Configure host name of remote machine ====
 +
[[Image:puttystart.png|thumb|PuTTY's connect dialog]]
 
* Set '''Host Name''' to '''localhost'''
 
* Set '''Host Name''' to '''localhost'''
 
* Set '''Port''' to the '''Source port''' you chose in Step 1 above (ie.  '''2321''' in the above example)
 
* Set '''Port''' to the '''Source port''' you chose in Step 1 above (ie.  '''2321''' in the above example)
 
* Set '''Saved Sessions''' field to '''Step 2'''
 
* Set '''Saved Sessions''' field to '''Step 2'''
[[Image:puttystart.png|center|PuTTY's connect dialog]]
+
<br clear=all>
  
 
==== Configure user name ====
 
==== Configure user name ====
 +
[[Image:puttyconfig2.png|thumb|PuTTY's config, username ]]
 
* Select the '''Data''' entry under '''Connection''' in the left column.   
 
* Select the '''Data''' entry under '''Connection''' in the left column.   
 
* Set '''Auto-login username''' field to '''hacuser'''
 
* Set '''Auto-login username''' field to '''hacuser'''
[[Image:puttyconfig2.png|center|PuTTY's config, username ]]
+
<br clear=all>
  
 
==== Configure tunnel ====
 
==== Configure tunnel ====
 +
[[Image:puttyconfig1.png|thumb|PuTTY's config, Tunnel Config ]]
 
* Click on the '''+''' next to '''SSH''' in the list on the left, then select '''Tunnels'''.   
 
* Click on the '''+''' next to '''SSH''' in the list on the left, then select '''Tunnels'''.   
 
* Set '''Source port''' to '''5901'''
 
* Set '''Source port''' to '''5901'''
Line 71: Line 75:
 
         5901    localhost:5901
 
         5901    localhost:5901
 
       If you see a second line, click on it, then click the '''Remove''' button to delete it.
 
       If you see a second line, click on it, then click the '''Remove''' button to delete it.
[[Image:puttyconfig1.png|center|PuTTY's config, Tunnel Config ]]
+
<br clear=all>
  
 
==== Save configuration ====
 
==== Save configuration ====
 +
[[Image:puttystart.png|thumb|PuTTY's config, main ]]
 
* Select the '''Session''' entry in the left column (scroll up if you have to), and click on the '''Save''' button.  This will save your settings for Step 2.
 
* Select the '''Session''' entry in the left column (scroll up if you have to), and click on the '''Save''' button.  This will save your settings for Step 2.
[[Image:puttystart.png|center|PuTTY's config, main ]]
+
<br clear=all>
  
 
== Setting up the Tunnel using your settings ==
 
== Setting up the Tunnel using your settings ==
 +
[[Image:puttyshell.png|thumb|PuTTY's shell ]]
 
* Run PuTTY and select '''Step 1''' from the Saved Sessions list and click '''Load'''.
 
* Run PuTTY and select '''Step 1''' from the Saved Sessions list and click '''Load'''.
 
** Click on the '''Open''' button at the bottom of the dialog box.  A black terminal will open and prompt you to login to the '''hallgw''' machine.  You will use ''your'' CUE password here.  Type it in and you should get a normal shell prompt '''[username@hallgw1]~%'''
 
** Click on the '''Open''' button at the bottom of the dialog box.  A black terminal will open and prompt you to login to the '''hallgw''' machine.  You will use ''your'' CUE password here.  Type it in and you should get a normal shell prompt '''[username@hallgw1]~%'''
Line 84: Line 90:
 
** Click on the '''Open''' button at the bottom of the dialog box.  A black terminal will open and prompt you to login to the '''hacweb14''' machine.  You will use the '''hacuser''' password here.  Type it in and you should get a normal shell prompt '''[hacuser@hacweb14]#'''
 
** Click on the '''Open''' button at the bottom of the dialog box.  A black terminal will open and prompt you to login to the '''hacweb14''' machine.  You will use the '''hacuser''' password here.  Type it in and you should get a normal shell prompt '''[hacuser@hacweb14]#'''
 
** You can now minimize this window (<i>do NOT</i> quit PuTTY) and move on to running the VNC client (''ie.'' UltraVNC)
 
** You can now minimize this window (<i>do NOT</i> quit PuTTY) and move on to running the VNC client (''ie.'' UltraVNC)
[[Image:puttyshell.png|center|PuTTY's shell ]]
+
<br clear=all>
  
 
== Running UltraVNC ==
 
== Running UltraVNC ==
  
 
====  Run '''vncviewer.exe''' ====
 
====  Run '''vncviewer.exe''' ====
 +
[[Image:vncconfig.png|thumb|UltraVNC config window]]
 
* Enter '''localhost:5901''' in the "VNC Server:" field at the top.
 
* Enter '''localhost:5901''' in the "VNC Server:" field at the top.
 
* Enable the '''Save connection settings as default''' at the bottom.
 
* Enable the '''Save connection settings as default''' at the bottom.
[[Image:vncconfig.png|center|UltraVNC config window]]
+
<br clear=all>
  
 
====  Connect to the VNC session ====
 
====  Connect to the VNC session ====
 +
[[Image:vncauth.png|thumb|UltraVNC auth and status windows]]
 
* Click on the Connect button and you should see a couple of windows pop up:
 
* Click on the Connect button and you should see a couple of windows pop up:
 
* Enter the '''hacuser''' password in the appropriate box and hit return.
 
* Enter the '''hacuser''' password in the appropriate box and hit return.
[[Image:vncauth.png|center|UltraVNC auth and status windows]]
 
 
* You should be rewarded with the hacuser window session.
 
* You should be rewarded with the hacuser window session.
 +
[[Image:vncwindow.png|thumb|UltraVNC Session]]
 
* '''NOTE''': If you get a black screen with yet another password prompt, it means the screen saver software has kicked in.  Just type in the 'hacuser' password again and you'll be good to go.
 
* '''NOTE''': If you get a black screen with yet another password prompt, it means the screen saver software has kicked in.  Just type in the 'hacuser' password again and you'll be good to go.
[[Image:vncwindow.png|center|UltraVNC Session]]
+
<br clear=all>
  
 
====  Quitting the VNC session ====
 
====  Quitting the VNC session ====

Revision as of 20:39, 30 October 2019

Instructions for Windows

Downloading the Software

You'll need two pieces of software:

UltraVNC and PuTTY icons on the Desktop
  • VNC client (lets you view the remote screen): UltraVNC
    • UltraVNC comes in a zip file. Open it and drag the executable inside to your desktop next to PuTTY.
  • PuTTY (lets the client talk to the remote machine through the firewall): PuTTY.
    • You want to save the putty.exe to your Desktop.


Setting up PuTTY


NOTE: The PuTTY screenshots below only examples.  Do not copy them blindly, be sure to read the notes in each section.

This is a 2-step process.

Step 1: Tunnel between your machine and JLab

Run PuTTY and create a Step 1 configuration.

Configure host name of remote machine

PuTTY's connect dialog
  • Set Host Name to hallgw.jlab.org
  • Set Saved Sessions field to Step 1


Configure user name

PuTTY's config, username
  • Select the Data entry under Connection in the left column.
  • Set Auto-login username field to your JLab username.


Configure tunnel

PuTTY's config, Tunnel Config
  • Click on the + next to SSH in the list on the left, then select Tunnels.
  • Set Source port to 2300 + the last 2 digits of your phone number.
    • Note: the port in this step just needs to be unique for each person connecting. The 'phone number' thing is just a way to make a number likely to be unique to you. For example, if your phone number ends with 4321 then set the port to 2321
  • Set Destination to hacweb14:22
  • Then click on the Add button.


Save configuration

PuTTY's config, main
  • Select the Session entry in the left column (scroll up if you have to), and click on the Save button. This will save your settings for Step 1.


Step 2: Tunnel between your machine and hacuser@hacweb14

We will now repeat the above steps to create a Step 2 configuration.

Configure host name of remote machine

PuTTY's connect dialog
  • Set Host Name to localhost
  • Set Port to the Source port you chose in Step 1 above (ie. 2321 in the above example)
  • Set Saved Sessions field to Step 2


Configure user name

PuTTY's config, username
  • Select the Data entry under Connection in the left column.
  • Set Auto-login username field to hacuser


Configure tunnel

PuTTY's config, Tunnel Config
  • Click on the + next to SSH in the list on the left, then select Tunnels.
  • Set Source port to 5901
  • Set Destination to localhost:5901
  • Then click on the Add button.
NOTE: After clicking Add you should only see a single line that looks like this in the Forwarded ports: field.
        5901    localhost:5901
     If you see a second line, click on it, then click the Remove button to delete it.


Save configuration

PuTTY's config, main
  • Select the Session entry in the left column (scroll up if you have to), and click on the Save button. This will save your settings for Step 2.


Setting up the Tunnel using your settings

PuTTY's shell
  • Run PuTTY and select Step 1 from the Saved Sessions list and click Load.
    • Click on the Open button at the bottom of the dialog box. A black terminal will open and prompt you to login to the hallgw machine. You will use your CUE password here. Type it in and you should get a normal shell prompt [username@hallgw1]~%
    • You can now minimize this window (do NOT quit PuTTY).
  • Run PuTTY a 2nd time and select Step 2 from the Saved Sessions list and click Load.
    • Click on the Open button at the bottom of the dialog box. A black terminal will open and prompt you to login to the hacweb14 machine. You will use the hacuser password here. Type it in and you should get a normal shell prompt [hacuser@hacweb14]#
    • You can now minimize this window (do NOT quit PuTTY) and move on to running the VNC client (ie. UltraVNC)


Running UltraVNC

Run vncviewer.exe

UltraVNC config window
  • Enter localhost:5901 in the "VNC Server:" field at the top.
  • Enable the Save connection settings as default at the bottom.


Connect to the VNC session

UltraVNC auth and status windows
  • Click on the Connect button and you should see a couple of windows pop up:
  • Enter the hacuser password in the appropriate box and hit return.
  • You should be rewarded with the hacuser window session.
UltraVNC Session
  • NOTE: If you get a black screen with yet another password prompt, it means the screen saver software has kicked in. Just type in the 'hacuser' password again and you'll be good to go.


Quitting the VNC session

  • Be sure to close the UltraVNC window, not one of the windows running

inside the VNC session.

  • Any program/stripchart that you start inside the VNC session will keep

running and updating in the background. You can reconnect to the VNC session anytime from (nearly) any machine.

To Summarize

After setting up the PuTTY configurations, you can do the following:

  1. Run PuTTY, select 'Step 1', and click 'Load', then 'Open', login, then minimize that PuTTY window (leave it running)
  2. Run PuTTY, select 'Step 2', and click 'Load', then 'Open', login, then minimize that PuTTY window (leave it running)
  3. Run UltraVNC and hit Connect (it'll use the default settings you saved earlier)

Instructions for Linux

  • Type the following at a shell prompt (ie. in an xterm)
 vncviewer -Shared -via hacuser@hacweb14 :1
  • When prompted, enter the hacuser password (twice)
  • NOTE: If you get a black screen with yet another password prompt, it means the screen saver software has kicked in. Just type in the 'hacuser' password again and you'll be good to go.

Setting up the VNC Server

NOTE: This rarely needs to be done.  Once it is started it will stay running even after you disconnect.
      In general, the vncserver will only need to be restarted if the hacweb14 machine is rebooted.
  • Log in to hacuser@hacweb14
  • Start the vncserver by running:
 [hacuser@hacweb14]# vncserver -geometry 1900x1100 :1

Killing the VNC Server

This will quit the server and all applications that were running under that server.

 [hacuser@hacweb14]# vncserver -kill :1