User Tools

Site Tools


doc:installation:x2gobroker

This is an old revision of the document!


Installing X2Go Session Broker

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:

$ sudo apt-get install x2gobroker-daemon

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:

$ sudo apt-get install x2gobroker-wsgi

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:

X2Go Session Broker: Backends and Frontends

The concept of X2Go Session Broker as provided in 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

$ invoke-rc.d x2gobroker-daemon restart

For Apache2/WSGI/X2Go Session Broker setup…

$ invoke-rc.d apache2 restart

Testing X2Go Session Broker with a Browser

The different backends and frontends can be accessed with this URL pattern:

http(s)://<broker-base-url>/<frontend>/<backend>

Where…

Example: http://localhost:8080/plain/zeroconf

doc/installation/x2gobroker.1368362674.txt.gz · Last modified: 2013/05/12 12:44 by sunweaver