62a399233a377141bf1c795dc34da95f4e58dae0
faq-remote-X11-beta.md
... | ... | @@ -1,22 +1,15 @@ |
1 | -# Remote X11 (beta) - x2go and xpra |
|
1 | +# Creating and connecting to persistent remote X11 sessions |
|
2 | 2 | |
3 | -In general x2go is easier to use and sufficient for most scenarios. Xpra has better performance and uses less resources. Both clients connect through ssh and are generally faster than ssh -Y. Support for these is beta, x2go is more familiar to the support staff. Most linux systems do not have these tools installed, so you may need to request them. |
|
4 | - |
|
5 | -We recommend using x2go. x2go is more familiar to the support staff and it is easier to use. |
|
3 | +[X2GO](x2go.org) and [XPRA](xpra.org) can be used to run (and interact with) GUI applications on remote hosts. |
|
4 | +For all systems off of the sbgrid network it will be easiest if you use the [cmcd-vpn](faq-connecting-to-cmcd-vpn). |
|
5 | +Please [contact us](mailto:help@sbgrid.org) if your SBGrid-supported remote host lacks pre-requisite server-side software, such as the `xpra` program. |
|
6 | 6 | |
7 | 7 | ## x2go |
8 | 8 | |
9 | -### download |
|
10 | - |
|
11 | -x2go can be downloaded from this page. |
|
12 | - |
|
13 | -* <https://wiki.x2go.org/doku.php/download:start> |
|
14 | - |
|
15 | -#### Additional Steps |
|
9 | +[Download](https://wiki.x2go.org/doku.php/download:start) and install the X2GO client. |
|
16 | 10 | |
17 | 11 | You will need to open System Preferences - Security - General - Temporarily 'Allow from anywhere' open the application, make sure you can reopen it. Then change your security setting back to 'App Store and Identified Developers' |
18 | 12 | |
19 | -For all systems off of the sbgrid network it will be easiest if you use the [cmcd-vpn](faq-connecting-to-cmcd-vpn). |
|
20 | 13 | |
21 | 14 | x2go requires XQuartz - see [faq-using-sbgrid-programs](faq-using-sbgrid-programs) if you do not already have it installed. |
22 | 15 | |
... | ... | @@ -29,66 +22,60 @@ Make sure you fill out the following - |
29 | 22 | 3. port - 22 |
30 | 23 | 4. Session type - Mate |
31 | 24 | |
32 | -You can adjust the resolution after the session has started. |
|
33 | - |
|
34 | -### Xpra |
|
25 | +You can adjust the desktop size after the session has started. |
|
35 | 26 | |
36 | -xpra has been described as 'tmux for X11'. It uses x264 encoding. |
|
27 | +## Xpra |
|
37 | 28 | |
38 | -#### OSX to Linux workstation usage |
|
29 | +### macOS (x86_64) to remote Linux workstation |
|
30 | +[Download](https://xpra.org/dists/osx/x86_64/Xpra.pkg) the installer. |
|
39 | 31 | |
40 | -For Mac OSX newer than 10.9 the installer is on their downloads page |
|
41 | -<https://www.xpra.org/trac/wiki/Download> |
|
32 | +### On remote workstation |
|
42 | 33 | |
43 | -GUI version - |
|
44 | -<https://xpra.org/dists/osx/x86_64/Xpra.pkg> |
|
45 | - |
|
46 | -For command line usage please us the 'pkg' installer located here - |
|
47 | -<https://xpra.org/dists/osx/x86_64/Xpra.pkg> |
|
48 | - |
|
49 | -#### xpra gui |
|
50 | - |
|
51 | -On remote system - copy xpra-launch.sh to your home folder and ./xpra-launch.sh or useone of the lines below. |
|
34 | +Copy `xpra-launch.sh` to your home folder and `./xpra-launch.sh`, or use one of the commands below. |
|
52 | 35 | |
53 | 36 | #### Full desktop |
54 | 37 | |
55 | -tmux new-session -d -s "xpra-desktop" "xpra start-desktop --start=mate-session :$((10 + RANDOM % 999)) --pulseaudio=no --daemon=no" |
|
38 | +`tmux new-session -d -s "xpra-desktop" "xpra start-desktop --start=mate-session :$((10 + RANDOM % 999)) --pulseaudio=no --daemon=no"` |
|
56 | 39 | |
57 | 40 | #### Minimal termial window |
58 | 41 | |
59 | -tmux new-session -d -s "xpra-terminal" "xpra start --start=mate-terminal :$((10 + RANDOM % 999)) --pulseaudio=no --daemon=no" |
|
42 | +`tmux new-session -d -s "xpra-terminal" "xpra start --start=mate-terminal :$((10 + RANDOM % 999)) --pulseaudio=no --daemon=no"` |
|
60 | 43 | |
61 | -#### open xpra gui |
|
44 | +### On local computer |
|
62 | 45 | |
63 | -Select mode ssh - enter username, host and password info. If there is only one xpra session it will automatically connect to it. You can also save that info to a config file and launch that after. |
|
46 | +Launch the XPRA gui. Select mode ssh - enter username, host and password info. If there is only one xpra session it will automatically connect to it. You can also save that info to a config file and launch that after. |
|
64 | 47 | |
65 | 48 | To end the session on the remote system either tmux a and Ctrl-c or 'xpra stop' |
66 | 49 | |
67 | -### xpra cli - keep it simple |
|
50 | +#### xpra cli - keep it simple (for more experienced XPRA users) |
|
51 | +This subsection includes support staff notes is not needed for basic remote work with GUI applications. You need to modify these commands according to your circumstances, *should* you decide to use these commands. |
|
52 | + |
|
53 | +On the local Mac OSX system one can open a terminal window and run something like |
|
68 | 54 | |
69 | -On your local Mac OSX system open a terminal window and run |
|
70 | -`xpra start ssh/oconnor@sch-boltzmann/42 --start-child=xterm` |
|
55 | +`xpra start ssh/<username>@<remotehost>/42 --start-child=xterm` |
|
71 | 56 | |
72 | 57 | With this one command you should have a remote xterm window come up. From there you can launch whatever application you need to run on the other system, including applications that need GLX extensions such as coot. |
73 | 58 | |
74 | -To disconnect, just ^c from the original terminal window(not the xterm that you connected to), or if you connect from another system it will automatically detach. |
|
59 | +To disconnect, just Ctrl-c from the original terminal window (not the xterm that you connected to), or if you connect from another system it will automatically detach. |
|
75 | 60 | |
76 | -reattach to attach - |
|
61 | +##### Reattach to existing desktop |
|
77 | 62 | |
78 | 63 | `xpra attach ssh/oconnor@sch-boltzmann/42` |
79 | 64 | |
80 | -Note the number 42. You need to pick a number that someone else on the system is not using. Do not use a low number that could be inuse by the system like 0 - 5, instead pick a higher number up to 999. |
|
65 | +Note the number 42. You need to pick a number that someone else on the system is not using. Do not use a low number that could be in use by the system, like 0 - 5. Pick a higher number up to 999 instead. |
|
81 | 66 | |
82 | -Note, if you simply close all the windows, including xterm, the remote server is still running |
|
83 | -`ssh oconnor@sch-boltzmann` |
|
84 | -`xpra list` |
|
67 | +Note, if you simply close all the windows, including xterm, the remote server is still running: |
|
68 | +``` |
|
69 | +$ ssh oconnor@sch-boltzmann |
|
70 | +$ xpra list |
|
85 | 71 | Found the following xpra sessions: |
86 | 72 | /run/user/46627/xpra: |
87 | 73 | LIVE session at :666 |
88 | -`xpra stop :666` |
|
74 | +$ xpra stop :666 |
|
89 | 75 | xpra at :666 has exited. |
76 | +``` |
|
77 | +Or if you wanted the session to end when you opened the window: |
|
90 | 78 | |
91 | -Or if you wantesd the session to end when you opened the window - |
|
92 | 79 | `xpra start ssh/oconnor@sch-boltzmann/42 --start-child=xterm --window-close=shutdown` |
93 | 80 | |
94 | 81 | For all systems off of the sbgrid network it will be easiest if you use the [cmcd-vpn](faq-connecting-to-cmcd-vpn). |
... | ... | @@ -101,21 +88,27 @@ Make sure you can ssh to the host without error. You should not need to type 'ye |
101 | 88 | |
102 | 89 | Press enter one time - is it waiting for password input? |
103 | 90 | |
104 | -connect to the remote host and type - |
|
91 | +connect to the remote host and type: |
|
92 | + |
|
105 | 93 | `xpra list` |
106 | 94 | |
107 | -If there is an active session you can connect to it via `xpra attach ssh/user@host/42' from your client. |
|
95 | +If there is an active session you can connect to it via |
|
96 | + `xpra attach ssh/user@host/42` |
|
97 | +from your client. |
|
108 | 98 | |
109 | 99 | There could be an active session with no windows open. Stop the session and start again. |
110 | -'xpra stop :42` |
|
111 | 100 | |
112 | -Try to launch a session from the host in a tmux or screen session on the remote server - |
|
113 | -`ssh user@myhost` |
|
114 | -`tmux` |
|
115 | -`xpra start :617 --daemon=no --start-child=xterm` |
|
101 | +`xpra stop :42` |
|
102 | + |
|
103 | +Launch a session from the host in a tmux or screen session on the remote server: |
|
104 | +``` |
|
105 | +$ ssh user@myhost |
|
106 | +$ tmux |
|
107 | +$ xpra start :617 --daemon=no --start-child=xterm |
|
108 | +``` |
|
116 | 109 | You should see a line that that contains `xpra is ready.` |
117 | -Detach with CTRL-b - d keys and then you can attach from your own system |
|
110 | +Detach with CTRL-b - d keys and then you can attach from your own system |
|
118 | 111 | `xpra attach ssh/oconnor@sch-boltzmann/617` |
119 | 112 | |
120 | 113 | See Also |
121 | -`man xpra' |
|
114 | +`man xpra` |