User Tools

Site Tools


wiki:components:x2goplugin

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
wiki:components:x2goplugin [2010/06/30 17:25]
h1
wiki:components:x2goplugin [2013/03/14 22:35]
sunweaver removed
Line 1: Line 1:
-====== x2goplugin ======+====== 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.  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 any java enabled Web browser (Firefox, IE, Opera) instead of using one of the x2goclients. +//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 ===== ===== Installation of x2goplugin =====
Line 19: Line 27:
 This is a short tutorial how to integrate the x2go plugin into a website.  This is a short tutorial how to integrate the x2go plugin into a website. 
  
-==== create a properties file ==== 
- 
-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: 
- 
-<code> 
-session=mysessionname 
-server=myserver.org 
-user=myusername 
-sshport=22 
-command=KDE 
-rootless=false 
-sound=false 
-exportfs=false 
-speed=adsl 
-compression=16m-jpeg 
-quality=9 
-dpi=120 
-kbdlayout=de 
-kbdtype=pc105/de 
-showtoolbar=false 
-showstatusbar=false 
-</code> 
- 
-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 the SSH port number in the /etc/ssh/sshd_config file on the x2goserver.  
- 
-You can choose the used Desktop Environment or application by changing the value "command".   
-  * If you specify "KDE" or "GNOME" then x2go will present you __with__ an entire remote desktop. 
-  * If you specify any application (such as: firefox) which is executable by the user then only that application will appear __without__ the entire remote desktop.  
- 
-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. 
  
 ==== building a minimal website ==== ==== building a minimal website ====
Line 80: Line 50:
 ==== inserting the <object></object> code ==== ==== inserting the <object></object> code ====
  
-Please paste the following code inside you website inside the <div></div> command:+Please paste the following code inside your website between the <div></div> command:
  
 <code> <code>
Line 87: Line 57:
  pluginspage="http://plugin.x2go.org/index.html"   pluginspage="http://plugin.x2go.org/index.html" 
  pluginurl="http://plugin.x2go.org/download/x2goplugin_linux32.xpi"   pluginurl="http://plugin.x2go.org/download/x2goplugin_linux32.xpi" 
- data="x2go.server"  
- hidden="false"  
  name="x2goplugin"   name="x2goplugin" 
  palette="background"   palette="background" 
Line 94: Line 62:
  hspace="0"   hspace="0" 
  vspace="0"   vspace="0" 
- width="100%">+ width="100%
 +        x2goconfig=" 
 +session=mysessionname 
 +server=myserver.org 
 +user=myusername 
 +sshport=22 
 +command=KDE 
 +rootless=false 
 +sound=true 
 +exportfs=true 
 +speed=adsl 
 +compression=16m-jpeg 
 +quality=9 
 +dpi=120 
 +kbdlayout=de 
 +kbdtype=pc105/de 
 +showtoolbar=true 
 +showstatusbar=true 
 +">
         <--x2goplugin //-->         <--x2goplugin //-->
     </object>         </object>    
 </code> </code>
 +
 +
 +You can change the 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 the SSH port number in the /etc/ssh/sshd_config file on the x2goserver. 
 +
 +You can choose the used Desktop Environment or application by changing the value "command".  
 +  * If you specify "KDE" or "GNOME" then x2go will present you __with__ an entire remote desktop.
 +  * If you specify any application (such as: firefox) which is executable by the user then only that application will appear __without__ the entire remote desktop. 
 +
 +The value "rootless" should be set to false for use with a 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.
 +
  
 If you intend to utilize the automatic update service (recommended), do not change the urls used in the values "pluginspage" and "pluginurl" 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 <div></div> container, you shoult take care of reasonable height and width settings.+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) ==== ==== checking if the plugin is already installed (and offering it if not) ====
Line 131: Line 130:
 ==== a complete website example ==== ==== a complete website example ====
  
-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 <div id="x2goplugin" style="width: auto; hight: auto;"> settings as described before):+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> <code>
Line 155: Line 154:
  vspace="0"   vspace="0" 
  width="100%">  width="100%">
-        <--x2goplugin //-->+        <!--x2goplugin //-->
     </object>         </object>    
     </div>     </div>