[X2Go-Commits] page changed: doc:installation:x2gobroker

[wiki-admin at x2go.org]

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

Date        : 2013/05/12 12:44
Browser     : Mozilla/5.0 (X11; Linux x86_64; rv:18.0) Gecko/20100101 Firefox/18.0 Iceweasel/18.0.1
IP-Address  : 46.115.54.165
Hostname    : 46.115.54.165
Old Revision: http://wiki.x2go.org/doku.php/doc:installation:x2gobroker?rev=1363304973
New Revision: http://wiki.x2go.org/doku.php/doc:installation:x2gobroker
Edit Summary: 
User        : sunweaver

@@ -1,4 +1,105 @@
  ====== Installing X2Go Session Broker ======
  
- FIXME
+ The X2Go Session Broker falls into two components.
+ 
+   * X2Go Session Broker Daemon/WSGI
+   * X2Go Session Broker Authentication Service
+   * X2Go Session Broker Agent
+ 
+ X2Go Session Broker can either be installed as a standalone Daemon, or it can be integrated into Apache2 (or other httpd) using '''mod_wsgi'''.
+ 
+ ===== X2Go Session Broker Daemon =====
+ 
+ Package name: '''x2gobroker-daemon'''
+ 
+ On Debian based systems:
+ 
+ <code bash>
+ $ sudo
apt-get install x2gobroker-daemon
+ </code>
+ 
+ The standalone daemon setup works out of the box, but can only bind to IP ports greater than 1024. However, for security, the X2Go Session Broker standalone daemon only binds to the IPv4 localhost device.
+ 
+ Check ''/etc/defaults/x2gobroker-daemon'' for modifying the daemon's bind address.
+ 
+ ===== X2Go Session Broker WSGI =====
+ 
+ Package name: '''x2gobroker-wsgi'''
+ 
+ On Debian based systems:
+ 
+ <code bash>
+ $ sudo apt-get install x2gobroker-wsgi
+ </code>
+ 
+ For production deployments, the WSGI based setup is probably preferrable. With Apache2+WSGI you can provide VirtualHost setups with many different broker configurations on the same machine. You can also use the Apache2-way of setting up SSL support. 
+ 
+ With the Apache2+WSGI setup you can integrate the X2Go Session Broker functionality into a complex X2Go Broker site (e.g. with a session configuration WebUI).
+ 
+ In the source code of X2Go Session Broker we
provide two example configurations for Apache2+X2GoBroker:
+ 
+   * [[http://code.x2go.org/gitweb?p=x2gobroker.git;a=blob_plain;f=etc/x2gobroker-wsgi.apache.conf|X2Go Session Broker WSGI support added globally]]
+   * [[http://code.x2go.org/gitweb?p=x2gobroker.git;a=blob_plain;f=etc/x2gobroker-wsgi.apache.vhost|X2Go Session Broker WSGI support as VirtualHost]]
+ 
+ 
+ ===== X2Go Session Broker: Backends and Frontends =====
+ 
+ The concept of X2Go Session Broker as provided in [[http://code.x2go.org/gitweb?p=x2gobroker.git|X2Go Git]] is highly modular. The X2Go Session Broker Daemon can be easily extended with //broker backends// and //WebUI frontends//.
+ 
+ ==== Currently available broker backends ====
+ 
+   * ZeroConf backend (name: zeroconf), set up by default, allows one to test the broker and see that client <-> broker configuration basically works
+   * INI File backend (name: inifile), text file (INI format) based configuration of the X2Go Session Broker backend
+ 
+ Other
broker backends (written in Python) can be added easily if needed. Contact the X2Go developers for further information on custom broker backend development.
+ 
+ ==== Currently available WebUI frontends ====
+ 
+   * The '''plain''' WebUI frontend: usable with X2Go Client
+   * The '''uccs''' WebUI frontend: usable with Unity Greeter (experimental)
+ 
+ 
+ ===== Testing Your X2Go Session Broker Setup =====
+ 
+ ==== Enabling Debug Mode ====
+ 
+ If you want to check the broker funtionality with your web browser, please make sure you have enabled the debug mode of the broker. Make sure that before launching the '''x2gobroker''' executable the environment variable ''X2GOBROKER_DEBUG'' is set to 1.
+ 
+ On Debian based systems, this can be done in ''/etc/defaults/x2gobroker-daemon'' or the Apache2-WSGI configuration of X2Go Session Broker in ''/etc/x2go/x2gobroker-wsgi.apache.*''. Make sure to restart the corresponding service (x2gobroker-daemon resp. apache2) after you have changed
either of those config files:
+ 
+ For ''x2gobroker-daemon''...
+ 
+ <code bash>
+ $ invoke-rc.d x2gobroker-daemon restart
+ </code>
+ 
+ For Apache2/WSGI/X2Go Session Broker setup...
+ 
+ <code bash>
+ $ invoke-rc.d apache2 restart
+ </code>
+ 
+ ==== Testing X2Go Session Broker with a Browser ====
+ 
+ The different backends and frontends can be accessed with this URL pattern:
+ 
+ <code>
+ http(s)://<broker-base-url>/<frontend>/<backend>
+ </code>
+ 
+ Where...
+   * ''<broker-base-url>'' is <hostname>:<port>/<broker-base-path>
+   * ''<frontend>'' can be either of [[http://code.x2go.org/gitweb?p=x2gobroker.git;a=blob_plain;f=x2gobroker/web|the available broker WebUI frontends]] (except the files base.py and extras.py all files here are broker WebUI frontends)
+   * ''<backend>'' can be either of [[http://code.x2go.org/gitweb?p=x2gobroker.git;a=blob_plain;f=x2gobroker/web|the available broker WebUI frontends]]
+ 
+ **Example:** ''http://localhost:8080/plain/zeroconf''
+ 
+ 
+ 
+

+ 
+ 
+ 
+ 
+ 
  



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