User Tools

Site Tools


X2Go Server

:!: This wiki page needs much more work!!! Any help is appreciated!!!

X2Go's Server Download

Binary packages for various distros are available.

X2Go's Server: base package and extensions

The x2goserver package (Debian/Raspbian/Ubuntu) provides the server-side core of X2Go. If you want to run the legacy X2Go client (X2Go Client) on the client-side systems then the installation of this package is sufficient.

However, in 2011 many new features/capabilities were added to X2Go.

One feature was an x2goserver-extensions package (Debian/Raspbian/Ubuntu) that we consider as a namespace for X2Go server contributions. For example, the Python X2Go implementation requires some scripts available in this package. If you work on coding some other X2Go client implementation you are invited to contribute your server extensions within this namespace.

Also, if the remote server already has a desktop environment installed then one more X2Go package (besides x2goserver) must now be installed on the server before the X2Go Client can successfully initiate/start a remote desktop X2Go session.

Newer versions of the GNOME 3 and UNITY desktop environments have compatibility issues with X2Go. See the page Desktop Environment Compatibility for more details.

This additional X2Go package is called x2goserver-xsession. This must be installed for the X2Go Client to successfully start the remote desktop X2Go session unless the X2Go Server is intended for use with the new X2Go Published Apps capability (see NOTE below).

$ sudo apt-get install x2goserver-xsession

NOTE: - this is a change from older versions of x2goserver installs where in previous versions the only requirement was to just execute sudo apt-get install x2goserver .

x2goserver-xsession was originally introduced so that X2Go can be installed on Debian/Raspbian/Ubuntu Edu terminal servers and the sessions would look like they do on Debian Edu (aka Skolelinux) desktops. It actually does a lot more: start gpg-agent, start ssh-agent, desktop branding, etc.

X2Go's Server: What is it? What does it do?

The base X2Go Server and also the X2go Server Extensions are basically a collection of Bash and Perl scripts that take care over X2Go server session management and communication between client and server.

X2Go server currently uses NXv3 based libraries and tools for the backend implementation of X2Go (graphical compression & caching for low bandwidth connections).

The individual X2Go Server scripts do have (rudimentary) man pages. Some of the X2Go server scripts are used internally (by other X2Go server scripts), others are designed to be available to X2Go Client implementations (e.g. x2goruncommand, x2gosuspend-session, x2goterminate-session, etc.).

The latest status of the X2Go server's manual pages can be viewed via the gitweb tool of X2Go's Git:

The latest status of the X2Go server extension's manual pages can found here:

X2Go's Server: How it actually works

Starting a New Session

When starting a new session the script called x2gostartagent gets executed on the server. x2gostartagent creates a new session in three phases:

  1. Find unique $DISPLAY number and unique session ID. This will insert a new session in the database.
  2. Find free ports for sound, graphic, file sharing. After that the the database entry will get updated with these discovered values.
  3. Start x2goagent (NX-like XServer): after that the database entry gets updated with the PID of the x2goagent process.

CAVEAT for client implementations: if you query the session entry from the database with x2golistsessions some time between phases 1 and 3 some of the returned values (ports, agent PID) will not be set.

Resuming a Session


Suspending/Terminated a Session


X2Go's Server: Improving documentation...

REQUEST TO X2Go USERS: For the improvement of the X2Go server manual pages we request everyone's help here.


  • improve manual page contents (what is the script for, what does it do, what values does it return, etc.)
wiki/advanced/x2goserver-in-detail.txt · Last modified: 2016/11/24 12:30 by ionic