Differences

This shows you the differences between two versions of the page.

--- wiki:development:sessions-file [2012/03/10 11:21]
sunweaver [Session Options en Detail]
+++ wiki:development:sessions-file [2025/04/09 19:00] (current)
slatian
@@ Line 3: / Line 3: @@
 Default path name
-  * Linux, Mac OS X): $HOME/.x2goclient/sessions
+  * Linux, Mac OS X: ''$HOME/.x2goclient/sessions''
-  * Windows (non-portable mode): session profiles are stored in the Windows registry (HKEY_LOCAL_MACHINE\SOFTWARE\x2goclient)
+  * Windows X2GoClient (non-portable mode): session profiles are stored in the Windows registry (''HKEY_CURRENT_USER\Software\Obviously Nice\x2goclient\sessions'')
-  * Windows (portable mode): session profiles are stored in a file (location???)
+  * Windows X2GoClient (portable mode): session profiles are stored in a file: The one specified on the command line, or ''%LOCALAPPDATA%\VirtualStore\x2go_sessions.txt'' if you made manual changes using the UI. (Make sure to use CRLF line endings and the correct encoding.)
+  * Windows PyHoca-GUI: session profiles are stored in the file (''%USERPROFILE%\.x2goclient\sessions'')
 Related command line options:
@@ Line 44: / Line 46: @@
 ^ Option name ^ Data Type ^ Default value X2Go Client ^ Default value Python X2Go ^ Comment ^
 | name | String | | | Session profile name as shown in the application. PyHoca-GUI feature: using ,,/" as a separator in the session profile name creates menus and submenus in the PyHoca-GUI applet (e.g. CUSTOMER-1/HOST-1, CUSTOMER-1/HOST-2, CUSTOMER-2/HOST-1, ...) |
-| icon | Filename | :icons/128x128/x2gosession.png | :icons/128x128/x2gosession.png | Icon for Desktop Session Windows |
+| icon | Filename | :/img/icons/128x128/x2gosession.png | :icons/128x128/x2gosession.png | Icon for Desktop Session Windows |
 ==== Session Window Options ====
@@ Line 59: / Line 61: @@
 | host | String | | | FQDN Hostname or IP Adress |
 | user | String | | | Username on X2Go Server |
+| autologin   | Boolean | false   | false | Use SSH agent or default key files for session logon |
+| forwardsshagent  | Boolean | //not supported//   | false | Tunnel authentication requests back to the client side SSH agent, requires Paramiko/SSH (>= 1.9.0) |
 | key       | Filename | | | Filename to SSH private key file |
 | krblogin    | Boolean   | false | //not supported// | |
@@ Line 64: / Line 68: @@
 | quality     | [0..9] | 9        | 9        | NX compression quality |
 | speed       | [0..4] | 2        | 2        | 0=Modem, 1=ISDN, 2=ADSL, 3=WAN, 4=LAN |
 ==== SSH Proxy Options ====
-//... only available with Python X2Go / PyHoca //
 ^ Option name ^ Data Type ^ Default value X2Go Client ^ Default value Python X2Go ^ Comment ^
-| usesshproxy | Boolean | //not supported// | false | Connect via a SSH proxy |
+| usesshproxy | Boolean | false | false | Connect via a SSH proxy |
-| sshproxyhost | String | //not supported// |  | Format: <hostname>[:<port>] |
+| sshproxytype | String | SSH | SSH | Also available: HTTP (X2Go Client only, not working on most systems as it relies on a not-yet released feature in libssh2 |
-| sshproxyuser | String | //not supported// |  | Username for connecting to SSH proxy server |
+| sshproxyhost | String |  |  | Format: <hostname>[:<port>] |
-| sshproxykeyfile | Filename | //not supported// |  | Filename of local SSH private key |
+| sshproxyuser | String |  |  | Username for connecting to SSH proxy server |
-| sshproxytunnel | String | //not supported// |  | localhost:<port-on-proxy>:<x2goserver-hostname-or-ip>:<x2goserver-port> |
+| sshproxykeyfile | Filename |  |  | Filename of local SSH private key |
+| sshproxytunnel | String |  | //deprecated since 0.4.0.0// | localhost:<port-on-proxy>:<x2goserver-hostname-or-ip>:<x2goserver-port> |
+| sshproxyautologin   | Boolean | false   | false | Use SSH agent or default key files for SSH proxy logon |
+| sshproxysameuser   | Boolean | false   | false | Use the same user name on the SSH proxy as on the X2Go Server |
+| sshproxysamepass   | Boolean | false   | false | Password for X2Go Server and SSH proxy are identical |
 ==== Display Options ====
@@ Line 83: / Line 91: @@
 | dpi         | Integer | 96 | 96 | Use the dpi value to manipulate the font size in a session |
 | fullscreen  | Boolean | false   | false | |
+| maxdim   | Boolean | //not supported// | false | Detect the maximum size for a new session window on the current screen |
 | multidisp | Boolean | false | //not supported// | |
 | xinerama    | Boolean | false   | //not supported// | |
@@ Line 113: / Line 122: @@
 | fstunnel    | Boolean | true    | true | On Python X2Go, file systems are always tunneled through SSH |
 | print       | Boolean | true    | true              | |
+Use ~ in the folder path to refer to the User Home Directory ($HOME or %HomePath%)((Supported in X2GO Client >= 4.0.1.2)).
 ==== MIME Box Options ====
@@ Line 126: / Line 137: @@
 ^ Option name ^ Data Type ^ Default value X2Go Client ^ Default value Python X2Go ^ Comment ^
-| autostart   | Boolean | false   | //not supported// | |
+| autostart   | Boolean | false   | false | |
-| autologin   | Boolean | false   | //not supported// | Only available if SSH private key is provided |
 | xdmcpserver | String  | localhost | localhost | Only used if ''command=XDMCP'' |
 | rdpserver   | String  | | | FQDN Hostname or IP of Windows server, only used if ''command=RDP'' |
@@ Line 142: / Line 152: @@
     * KDE (startkde)
     * GNOME (gnome-session)
-    * LDXDE (lxde-session)
+    * LXDE (lxde-session)
     * XFCE4 (xfce4-session, Python X2Go only)
     * TRINITY (starttrinity, Python X2Go only, don't miss the [[http://code.x2go.org/gitweb?p=python-x2go.git;a=blob;f=README.Trinity-Desktop|README.Trinity-Desktop]] file!!)
@@ Line 154: / Line 164: @@
   * Remote Desktop (''command=RDP''):
-    * Setting the command to RDP will turn X2Go into an RDP proxy (RDP via NX). RDP will receive a peformance improvement on WAN connections and X2Go will guarantee SSH encryption (whereas RDP drops encryption if the bandwith won't suffice).
+    * Setting the command to RDP will turn X2Go into an RDP proxy (RDP via NX). RDP will receive a performance improvement on WAN connections and X2Go will guarantee SSH encryption (whereas RDP drops encryption if the bandwidth won't suffice).
     * Make sure to use the options rdpserver and rdpoptions properly.
-  * XDCMP (''command=XDCMP''):
+  * XDMCP (''command=XDMCP''):
-    * Do an XDCP query for the XDMCP server specified by the xdcmpserver option. Usefull if you have a complex terminal server setup behind one X2Go gateway (e.g. handled by an XDMCP chooser).
+    * Do an XDMCP query for the XDMCP server specified by the xdmcpserver option. Useful if you have a complex terminal server setup behind one X2Go gateway (e.g. handled by an XDMCP chooser).
   * Other applications (''command=<unix-application-on-server>''):
-    * Specify any application (by its name) that is avaiable via $PATH. No full path names are allowed here, the path will be stripped off of the file name provided. Make sure your $PATH environment variable resolves to the wanted application properly.
+    * Specify any application (by its name) that is available via $PATH. No full path names are allowed here, the path will be stripped off of the file name provided. Make sure your $PATH environment variable resolves to the wanted application properly.
   * Published applications mode (''command=, published=true''):
     * Leave the command option empty and enable the option published

X2Go - everywhere@home

User Tools

Site Tools

Differences

Page Tools