[X2Go-Commits] [[X2Go Wiki]] page changed: wiki:advanced:x2gohtmlclient

[wiki-admin at x2go.org]

A page in your DokuWiki was added or changed. Here are the details:

Browser             : Mozilla/5.0 (X11; Fedora; Linux x86_64; rv:95.0) Gecko/20100101 Firefox/95.0
IP Address          : 137.26.240.242
Hostname            : 137-026-240-242.biz.spectrum.com
Old Revision        : https://wiki.x2go.org/doku.php/wiki:advanced:x2gohtmlclient?rev=1640984137
New Revision        : https://wiki.x2go.org/doku.php/wiki:advanced:x2gohtmlclient
Date of New Revision: 2021/12/31 21:20
Edit Summary        : Revise components section
User                : mikep

There may be newer changes after this revision. If this
happens, a message will be shown on the top of the rev page.

@@ -7,69 +7,39 @@
    * the CGI, JSON, Encode, Expect, and File::Touch Perl modules, and
    * python-websockify.
  X2Go provides instructions for configuring the NGINX web server, but you can substitute another server if you prefer. Your operating system distribution likely provides packages containing the dependencies not provided by X2Go.
  
- {{:wiki:advanced:client.png?400|}}
  {{:wiki:advanced:kdr.png?400|}}
  
  ====== Components ======
  
- ===== X2GoHTMLClient =====
+ ===== x2gohtmlclient =====
  
- ==== index.html ====
- 
- Client HTML page. This page can be modified or embedded in existing webpage. It has two modes: native client and embedded client. User can use native client if recent version of X2Go client is installed on the system. In this case, the page will generate x2go session file, which will be automatically opened with x2go client. Second mode is to use embedded HTML Client (only supports X2GoKdrive). The HTML page provides user input for the next settings:
- <code>
- X2Go Server address
- Username
- Password
- Command to execute (KDE, GNOME, ICEWM, etc)
- SSH Proxy (if not specified no proxy will be used)
- Proxy login
- Proxy password
- </code>
- The HTML page can be modified to predefine one or more of this settings. Important functions inside of this page should be defined:
- <code>function getServer()
- function getUname()
- function getPass()
- function getCommand()
- function getName()
- function getProxy()
- function getProxyUser()
- function getProxyPass()
- </code>
- 
- ==== x2gokdriveclient.html ====
- 
- The HTML Page to run X2Go client in separate window. By default the session's window is embedded in the start page. User can "detach" the session to separate window using "new window" button. After that session will be shown in the separate window and can be resized, opened in full screen, etc.
- 
- ==== CSS/x2gostyle.css ====
- 
- WEB styles for HTML pages
- 
- ==== SRC/*png SRC/*svg ====
- 
- Image resources
- 
- ==== SRC/x2godomcontroller.js ====
- 
- Communication between HTML page and X2Go HTML Client
- 
- ==== SRC/x2gohtmlclient.js ====
- 
- Communication between X2Go RPC script and X2Go HTML Client
+ {{:wiki:advanced:client.png?400|}}
  
- ==== SRC/x2gokdrivehtmlclient.js ====
+ Contains the JavaScript and other assets that are served to a browser. The main page is ''index.html'', and it provides two modes: a native client and an embedded client. The native client requires that a recent version of the X2Go client exists on the same computer as the browser. The embedded client provides the HTML5-based functionality. In any case, ''index.html'' prompts the user for:
+   * the X2Go server address,
+   * a username,
+   * a password,
+   * the desktop environment to start,
+   * whether to use an SSH proxy,
+   * an optional proxy username, and
+   * an optional proxy password.
+ ''index.html'' can be edited to set a default server and so on.
+ The file ''x2gokdriveclient.html'' allows for running the X2Go client in a separate window.
  
- X2GoKdrive JS client
+ The x2gohtmlclient package also provides CSS, images, and three JavaScript classes:
+   1. ''x2godomcontroller.js'', which handles communication between the HTML page and the X2Go HTML client;
+   2. ''x2gohtmlclient.js'', which handles communication between the X2Go RPC script and the X2Go HTML client; and
+   3. ''x2gokdrivehtmlclient.js'', which implements the X2Go KDrive client.
  
- ===== x2gorpc.cgi =====
+ ===== x2gowebrpc =====
  
- CGI script for communication between HTML Client and X2Go server. It connects to X2Go server using ssh, starts/resuming sessions, opens SSH tunnels, etc
+ The x2gorpc.cgi CGI script connects to the X2Go server using SSH and starts sessions, resumes sessions, starts SSH tunnels and so on in response to requests from the browser.
  
  ===== x2gowswrapper =====
  
- The application that is connecting TCP sockets of X2GoKdrive agent with web sockets for HTML Client.
+ The x2gowswrapper program connects the TCP sockets of the X2Go KDrive agent with WebSockets created by the browser.
  
  ====== Configuring the Web Server ======
  
  We describe how to configure NGINX and fcgiwrap, but you can substitute any web server that provides the needed features.


-- 
This mail was generated by DokuWiki at
https://wiki.x2go.org/