Differences

This shows you the differences between two versions of the page.

--- wiki:components:x2goplugin [2012/07/05 11:18]
ncryer [create a properties file]
+++ — (current)
@@ Line 1: / Line 1: @@
-====== X2Go Browser Plugin ======
-FIXME FIXME FIXME FIXME
-THE BELOW INFORMATION IS NOT UP-TO-DATE, IT HAS TO BE REWRITTEN!!!!
-FIXME FIXME FIXME FIXME
-[[wiki:components:x2goplugin-example|plugin example page]]
-x2goplugin is a Firefox plugin.
-//On supported systems//, this plugin acts as a web portal which can be used to access an x2go session via Firefox web browser instead of using one of the x2goclients.  Note: the current plugin does not yet support Firefox 4.x.
-===== Installation of x2goplugin =====
-Please visit the webssite http://plugin.x2go.org. This website will offer you a x2goplugin suitable for your operating system and system architecture.
-Currently the x2goplugin is available for the following systems:
-  * Linux 32 bit
-  * Linux 64 bit
-  * Windows 32 bit
-===== Inserting x2goplugin into a webpage =====
-This is a short tutorial how to integrate the x2go plugin into a website.
-==== building a minimal website ====
-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:
-<code>
-<!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>
-</code>
-You can use either use a <div></div> 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 <div></div> container for this purpose and to set the <option></option> with and height value to 100%.
-==== inserting the <object></object> code ====
-Please paste the following code inside your website between the <div></div> command:
-<code>
-    <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>
-</code>
-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).
-note: 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 <div></div> container, you should take care of reasonable height and width settings.
-==== checking if the plugin is already installed (and offering it if not) ====
-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:
-<code>
-  <head>
-    <title>x2go Plugin</title>
-    <script src="http://plugin.x2go.org/media/x2goplugin.js" type="text/javascript"></script>
-  </head>
-</code>
-The javascript will need to be started, so you should add the the command "onLoad" to the <body></body> tag of the website:
-<code>
-<body onload="checkPlugin()">
-</code>
-==== a complete website example ====
-Your whole Website should now look something like this (This site makes use of an already existing css file on our server. You can also use the <div id="x2goplugin" style="width: auto; hight: auto;"> settings as described before):
-<code>
-<!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>
-</code>

X2Go - everywhere@home

User Tools

Site Tools

Differences

Page Tools