Skip to content

Commit

Permalink
Update set-up-x11-forwarding.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kbeutel authored Dec 7, 2023
1 parent 0f33d88 commit 7e04e6e
Showing 1 changed file with 20 additions and 21 deletions.
41 changes: 20 additions & 21 deletions GetStarted/set-up-x11-forwarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,37 +12,36 @@ If you will be running on a remote Linux system, you need to set up X11 forwardi

Example file (note that the Host * section might be different on your system or might not be required):

Host *
ControlMaster auto
ControlPath /tmp/%r@%h:%p
ControlPersist 12h
```
Host *
ControlMaster auto
ControlPath /tmp/%r@%h:%p
ControlPersist 12h
Host yourshortcuthere
Host yourShortcutHere
HostName yourhostname.example.edu
User exampleuser001
IdentityFile ~/.ssh/youridentityfilename
ForwardX11 yes
```

Note: X11Forwarding yes applies forwarding to ALL ssh commands. If you think this is too aggressive, you can also pass the “-X” flag to ssh. However, it is not sufficient to pass it in the ProxyCommand, but an alias such as [my shortcut]=ssh -X [server name] should work.
Note: **ForwardX11 yes** applies forwarding to ALL ssh commands. If you think this is too aggressive, you can also pass the “-X” flag to ssh. It is not sufficient to pass it in the ProxyCommand, but an alias such as **[my shortcut]=ssh -X [server name]** should work.

Note: If you open an ssh connection without X11 forwarding, you must close this one before you can open a new terminal that does have X11 forwarding.

Note for Apple silicon users: When running Genvisis on your server with X11 forwarding, set this option to prevent odd rendering issues: -Dsun.java2d.xrender=false
-Example of the full command: java -Dsun.java2d.xrender=false -jar genvisis.jar
Note: If you open an ssh connection without X11 forwarding, you must close it before you can open a new terminal that does have X11 forwarding.

Note for Apple silicon users: When running Genvisis with X11 forwarding on your server, set this option to prevent odd rendering issues: **-Dsun.java2d.xrender=false**. For example, the full command might be **java -Dsun.java2d.xrender=false -jar genvisis.jar**.


**Windows**
1. Download [Xming](https://xming.en.softonic.com/download) and [PuTTY](https://www.putty.org/).
2. In PuTTY, set up your ssh connection and X11 forwarding. Create a saved session with these instructions and the following settings:
* Session > Host Name: [your host name here, e.g., mesabi.msi.umn.edu]
* Connection>Proxy (not necessary on all systems)
* Proxy hostname: [your login node, if you have one]
* Telnet command, or local proxy command relies on having plink.exe (the TTY client, not the genetics toolset PLINK) on your path. Renaming this to plink_ssh.exe or something similar and then modifying the command to match may be advisable.
* Connection>SSH
* Check box for Share SSH connections if possible
* Connection>SSH>X11
* Ensure Enable X11 forwarding is checked

2. In PuTTY, set up your ssh connection and X11 forwarding. Create a saved session with the following settings:
- Session > Host Name: [your host name here, e.g., mesabi.msi.umn.edu]
- Connection > Proxy (not necessary on all systems)
- Proxy hostname: [your login node, if you have one]
- Telnet command, or local proxy command relies on having plink.exe (the TTY client, not the genetics toolset PLINK) on your path. Renaming this plink_ssh.exe or something similar and then modifying the command to match may be advisable.
- Connection > SSH
- Check box for **Share SSH connections** if possible
- Connection > SSH > X11
- Ensure **Enable X11 forwarding** is checked
3. We recommend that you save your session as something you will remember to access next time you log in.
4. For convenience, you can set up PuTTY to Automatically Load a Session. (COPY TEXT FROM PUTTY WEBSITE)
4. For convenience, you can set up PuTTY to [automatically load a saved session](https://documentation.help/PuTTY/using-cmdline-load.html).

0 comments on commit 7e04e6e

Please sign in to comment.