This is an old revision of the document!
x2goplugin is a Firefox plugin. It can be used to access a x2go session via a Webbrowser instead of using x2goclient.
Please visit the webssite http://plugin.x2go.org. This website will offer you a x2goplugin suitable for your operating system and system architecture. The x2goplugin at the moment is available for Linux 32 and 64 bit and Windows 32 bit systems.
This is a short tutorial how to integrate the x2go plugin into a website.
First of all you'll need a properties file. This file should be stored accessible by the website, for example inside the same directory. You can choose a name by yourself, but in this tutorial the file will be called x2go.server. Please us a suitable file editor (re vi, nano, gedit) for editing:
session=phoca server=localhost user=verstandk sshport=22 command=KDE rootless=false
You can choose the value “session” to whatever you like - it is just the name of the session.
The value “server” should be the hostname or the IP-address of the x2goserver which should be contacted by the plugin as your target “desktop server”.
The value “user” can be left blank, otherwise this “username” will be used as login for the x2go session and the user will not be able to change that login ID.
The value “sshport” should be set to 22 - you should only change this if you've previously changed /etc/ssh/sshd config of the x2goserver.
You can choose the used Desktop Environment or application by changing the value “command”.
The value “rootless” should be false for the use with whole Desktop Environments and Window Manager.
If you plan to use single applications you can use this feature to use the local running window manager.
You'll need a Website to carry the plugin. Please feel free to use your own Website code. This is just a example which should be used to get started:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <title>x2go Plugin</title> </head> <body> <div id="x2goplugin" style="width: auto; hight: auto;"> <--x2goplugin //--> </div> </body> </html>
You can use either use a
container with the help of css to set the size of the plugin or with the help of the <option></option> tag. As the plugin and a connected x2go session can be resized inside a website, we recommend using a
container for this purpose and to set the <option></option> with and height value to 100%.
Please paste the following code inside you website inside the
command:
<object src="location" type="application/x2go" pluginspage="http://plugin.x2go.org/index.html" pluginurl="http://plugin.x2go.org/download/x2goplugin_linux32.xpi" data="x2go.server" hidden="false" name="x2goplugin" palette="background" height="100%" hspace="0" vspace="0" width="100%"> <--x2goplugin //--> </object>
If you intend to utilize the automatic update service (recommended), do not change the urls used in the values “pluginspage” and “pluginurl”.
The value “data” is the name of the previously created properties file (in our example: x2go.server).
Please make sure that this file is readable by the www-data (apache) user and that you've entered the exact path to the file. In this case, the file should be inside the same directory as the website.
The value “name” is mandatory and should not be changed. If you don't want to use the
container, you shoult take care of reasonable height and width settings.
If you are visiting the created website, you'll only get a x2goplugin shown if it was previously installed by the user. If not, only a white space will appear. To check whether the plugin is installed or not, we'll need to add a javascript to the website. This too will offer the user the plugin if it wasn't installed before or inform him about the availability.
Inside the website's <head> </head> section you'll need to add the needed javascript.
You should use the plugin directly from our server to make sure that you'll get the latest version. The download url of the x2goplugin can change, because we want to store it on the Mozilla Add On site in future. Of cause you can also download the script here (http://plugin.x2go.org/media/x2goplugin.js) but please make sure that you'll update it in case it was changed on our server:
<head> <title>x2go Plugin</title> <script src="http://plugin.x2go.org/media/x2goplugin.js" type="text/javascript"></script> </head>
The javascript will need to be started, so you should add the the command “onLoad” to the <body></body> tag of the website:
<body onload="checkPlugin()">
Your whole Website should be look something like this now (This site makes use of an already existing css file on our server. You can also use the
settings as described before):
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <title>x2go Plugin</title> <link rel="stylesheet" type="text/css" href="http://plugin.x2go.org/media/x2goplugin.css"> <script src="http://plugin.x2go.org/media/x2goplugin.js" type="text/javascript"></script> </head> <body onload="checkPlugin()"> <div id="x2goplugin"> <object src="location" type="application/x2go" pluginspage="http://plugin.x2go.org/index.html" pluginurl="http://plugin.x2go.org/download/x2goplugin_linux32.xpi" data="x2go.server" hidden="false" name="x2goplugin" palette="background" height="100%" hspace="0" vspace="0" width="100%"> <--x2goplugin //--> </object> </div> <div id="description"> <h4>x2goplugin</h4> <p>This website will offer you a plugin named "x2goplugin". With the installed plugin you'll be able to start or recover a session running on a x2goserver. The server needs to be preconfigured. To get more information about what x2go is, please visit <a href="http://www.x2go.org">http://www.x2go.org</a>. </p> </div> </body> </html>