root/plugins/gpe/README

Revision 2516, 3.1 kB (checked in by gcobb, 1 year ago)

gpe-sync: port gpe-sync plugin to Opensync 0.3x

Line 
1 This is a plugin for opensync (www.opensync.org) to sync with handhelds
2 using GPE (http://gpe.handhelds.org).
3
4 General information
5 -------------------
6 You need to install the gpesyncd on the gpe side. This will read out the
7 sqlite databases and convert the data into vcards, vevents and vtodos.
8
9 Syncing can be done by using tcp/ip or over ssh. Both have their advantages
10 and disadvantages. But anyway I would recommend anyone to do syncing over
11 ssh.
12
13 Syncing over ssh
14 ----------------
15 By using ssh, you need to additionally install the sshd on the gpe side. If
16 you want to use it, just set in the configuration xml file "use_ssh" to 1
17 (which is default).
18
19 To have it as comfortable as with the syncing over tcp/ip, you should use
20 key authentication. To do so, you need to generate a new ssh-key pair with
21
22 $ ssh-keygen -t dsa
23
24 I recommend you to choose a passphrase although you don't need one. After it
25 you have two keys: id_dsa and id_dsa.pub. The id_dsa is you private
26 key, never loose it, never give it away.
27 Now you need to append the contents of id_dsa.pub to ~/.ssh/authorized_keys
28 on the gpe device. If the file does not exist, create one.
29 Now on your desktop run
30
31 $ ssh-add ~/.ssh/id_dsa
32
33 And enter the passphrase for you private key. This will add your key to the
34 ssh-agent, which manages all the authentication of the ssh-connections.
35 Now you won't anymore need to re-enter you passphrase while your X-session
36 is running and you can connect to the gpe device without typing in any
37 passwords.
38
39 If this didn't work or you want more information, go to
40 http://sial.org/howto/openssh/publickey-auth/
41
42 Syncing over tcp/ip
43 -------------------
44 For this you need to run the gpesyncd on the gpe device as the user with
45 whom you want to sync. You also need to run it with the -D parameter so
46 that it will be in the "daemon mode". Optionaly you can specify a port after
47 the -D parameter. If you provide none, the default port 6446 will be used.
48
49 Additionally you need to list the ip(s) from the computer(s) you want to
50 allow to sync the file $HOME/.gpe/gpesyncd.allow . If you don't have
51 this file, or it is empty, the gpesyncd will block all incoming connections.
52 Whenever a connection is blocked and you try to sync, you should get an
53 error like "Your're not allowed to connect!" from opensync.
54
55 In the configuration xml file you need to set "use_ssh" to 0.
56
57 Syncing locally
58 ---------------
59 If you are running Opensync and GPE on the same system, you can just fork gpesyncd
60 locally.  In order to do that, set "use_local" to 1 in the configuration file.
61
62 Troubleshooting
63 ---------------
64 Should there be any problems with the conversion, the problems are probably
65 adressed to gpesyncd. Please look at its BUGS file before reporting a
66 conversion problem.
67
68 Otherwise, see BUGS for known problems.
69
70 Have fun.
71 Martin (martin@silef.de)
72 Graham (g+opensync@cobb.uk.net)
73
74 Some personal notes:
75
76 A BIG THANKS to google, for making the "Summer of Code"
77 (http://code.google.com/summerofcode.html).
78 and a BIG THANK AS LEAST AS BIG AS TO GOOGLE, to handhelds.org for doing all
79 this great stuff and letting me code this while the summer of code for you.
80 I REALLY enjoyed it (and hopefully still enjoy it).
Note: See TracBrowser for help on using the browser.