Menu
▾
▴
[Opensync-commits] r5124 - plugins/gpe
|
From: <dg...@su...> - 2009-01-12 20:39:46
|
Author: Graham Cobb Date: Mon Jan 12 21:39:01 2009 New Revision: 5124 URL: http://www.opensync.org/changeset/5124 Log: gpe-sync: bring README up to date Modified: plugins/gpe/ChangeLog plugins/gpe/README Modified: plugins/gpe/ChangeLog ============================================================================== --- plugins/gpe/ChangeLog Mon Jan 12 01:58:48 2009 (r5123) +++ plugins/gpe/ChangeLog Mon Jan 12 21:39:01 2009 (r5124) @@ -1,3 +1,7 @@ +2009-01-12 Graham Cobb <g+...@co...> + + * README: Rewrite to bring up to date + 2009-01-03 Graham Cobb <g+...@co...> * src/gpe_sync.c (discover): Only parse config during discover phase. Modified: plugins/gpe/README ============================================================================== --- plugins/gpe/README Mon Jan 12 01:58:48 2009 (r5123) +++ plugins/gpe/README Mon Jan 12 21:39:01 2009 (r5124) @@ -1,27 +1,39 @@ -This is a plugin for opensync (www.opensync.org) to sync with handhelds -using GPE (http://gpe.handhelds.org). += GPE plugin = -General information -------------------- -You need to install the gpesyncd on the gpe side. This will read out the -sqlite databases and convert the data into vcards, vevents and vtodos. +This is a sync plugin for [http://www.opensync.org/ OpenSync] to sync with handhelds +using the [http://gpe.linuxtogo.org/ GPE] PIM applications. +For more information on the supported peers see [wiki:peers/gpe]. + +This plugin implements a proprietary protocol implemented by ''gpesyncd''. +''gpesyncd'' is the daemon on the GPE side which reads out the +sqlite databases and converts the data into vcards, vevents and vtodos. Syncing can be done by using tcp/ip or over ssh. Both have their advantages and disadvantages. But anyway I would recommend anyone to do syncing over ssh. -Syncing over ssh ----------------- -By using ssh, you need to additionally install the sshd on the gpe side. If -you want to use it, just set in the configuration xml file "use_ssh" to 1 -(which is default). +== Syncing over ssh == +By using ssh, you need to additionally install the sshd on the gpe side. +To configure it you need to set the following information in the configuration file: +{{{ +<Authentication><Username>gpeuser</Username></Authentication> +<Connection><ActiveConnection>Network</ActiveConnection> + <Network> + <Address>hostname</Address> + <Protocol>ssh</Protocol> + </Network> + </Connection> +}}} + +''gpeuser'' should be replaced with the username in use with SSH on the device. +''hostname'' should be replaced by the host name or IP address of the device. To have it as comfortable as with the syncing over tcp/ip, you should use key authentication. To do so, you need to generate a new ssh-key pair with $ ssh-keygen -t dsa -I recommend you to choose a passphrase although you don't need one. After it +Do not specify a passphrase. After it you have two keys: id_dsa and id_dsa.pub. The id_dsa is you private key, never loose it, never give it away. Now you need to append the contents of id_dsa.pub to ~/.ssh/authorized_keys @@ -30,7 +42,8 @@ $ ssh-add ~/.ssh/id_dsa -And enter the passphrase for you private key. This will add your key to the +And enter the passphrase for your private key if you specified one. +This will add your key to the ssh-agent, which manages all the authentication of the ssh-connections. Now you won't anymore need to re-enter you passphrase while your X-session is running and you can connect to the gpe device without typing in any @@ -39,42 +52,54 @@ If this didn't work or you want more information, go to http://sial.org/howto/openssh/publickey-auth/ -Syncing over tcp/ip -------------------- -For this you need to run the gpesyncd on the gpe device as the user with -whom you want to sync. You also need to run it with the -D parameter so +== Syncing over tcp/ip == +For this you need to run the ''gpesyncd'' on the gpe device as the user with +whom you want to sync. You also need to run it with the ''-d'' parameter so that it will be in the "daemon mode". Optionaly you can specify a port after -the -D parameter. If you provide none, the default port 6446 will be used. +the ''-d'' parameter. If you provide none, the default port 6446 will be used. Additionally you need to list the ip(s) from the computer(s) you want to -allow to sync the file $HOME/.gpe/gpesyncd.allow . If you don't have -this file, or it is empty, the gpesyncd will block all incoming connections. +allow to sync the file ''$HOME/.gpe/gpesyncd.allow''. If you don't have +this file, or it is empty, the ''gpesyncd'' will block all incoming connections. Whenever a connection is blocked and you try to sync, you should get an error like "Your're not allowed to connect!" from opensync. -In the configuration xml file you need to set "use_ssh" to 0. - -Syncing locally ---------------- -If you are running Opensync and GPE on the same system, you can just fork gpesyncd -locally. In order to do that, set "use_local" to 1 in the configuration file. +In the configuration xml file you need to specify: +{{{ + <Connection><ActiveConnection>Network</ActiveConnection> + <Network> + <Address>hostname</Address> + <Port>6446</Port> + <Protocol>gpesyncd</Protocol> + </Network> + </Connection> +}}} +''hostname'' should be replaced by the host name or IP address of the device. + +== Syncing locally == +If you are running !OpenSync and GPE on the same system, you can just fork ''gpesyncd'' +locally. In order to do that, do not specify any ''<Connection>'' tag in the config file. -Troubleshooting ---------------- +== Troubleshooting == Should there be any problems with the conversion, the problems are probably -adressed to gpesyncd. Please look at its BUGS file before reporting a +addressed to ''gpesyncd''. Please look at its BUGS file before reporting a conversion problem. Otherwise, see BUGS for known problems. -Have fun. -Martin (ma...@si...) -Graham (g+o...@co...) - -Some personal notes: - -A BIG THANKS to google, for making the "Summer of Code" -(http://code.google.com/summerofcode.html). -and a BIG THANK AS LEAST AS BIG AS TO GOOGLE, to handhelds.org for doing all -this great stuff and letting me code this while the summer of code for you. -I REALLY enjoyed it (and hopefully still enjoy it). +== Features == + +'' + * what parts of those specs it implements, what not? +'' + +== Related OpenSync Pages == + + * Information on GPE peer devices: [wiki:peers/gpe] + +'' +Link here relevant pages from different releases: + * installation guides + * related other plugin pages (dependencies, format plugins etc) + * track ticket listing +'' |
