summaryrefslogtreecommitdiff
path: root/doc/special_remotes/xmpp.mdwn
blob: 1286829ee6a0f099b4d10051d157c94ba0c50012 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
XMPP (Jabber) is used by the [[assistant]] as a git remote. This is,
technically not a git-annex special remote (large files are not transferred
over XMPP; only git commits are sent).

Typically XMPP will be set up using the web app, but here's how a manual
set up could be accomplished:

1. xmpp login credentials need to be stored in `.git/annex/creds/xmpp`.
   Obviously this file should be mode 600. An example file:

	XMPPCreds {xmppUsername = "joeyhess", xmppPassword = "xxxx", xmppHostname = "xmpp.l.google.com.", xmppPort = 5222, xmppJID = "joeyhess@gmail.com"}

2. A git remote is created using a special url, of the form `xmpp::user@host`
   For the above example, it would be `url = xmpp::joeyhess@gmail.com`

3. The uuid of one of the other clients using XMPP should be configured
   using the `annex.uuid` setting, the same as is set up for other remotes.

With the above configuration, the [[assistant]] will use xmpp remotes much as
any other git remote. Since XMPP requires a client that is continually running
to see incoming pushes, the XMPP remote cannot be used with git at the
command line.

## Hosted server support status
[[!table  data="""
Server|Status|Notes
Gmail|Working|Google apps users will have to edit `.git/annex/creds/xmpp` manually
Facebook|Failing|Maybe non 2-factor will work
League Of Legends|Failing
"""]]

## Server daemon support status
[[!table  data="""
Server|Status|Notes
[[Prosody|http://prosody.im/]]|Working
[[Metronome|http://www.lightwitch.org/]]|Working
Ejabberd|[[Failing|http://git-annex.branchable.com/forum/XMPP_authentication_failure/]]|[[Authentication bug|https://support.process-one.net/browse/EJAB-1632]]: Fixed in debian unstable with version 2.1.10-5
jabberd14|[[Failing|http://git-annex.branchable.com/forum/XMPP_authentication_failure/#comment-4ce5aeabd12ca3016290b3d8255f6ef1]]|No further information
jabberd2|?|Please update
Openfire|?|Please update
Tigase|?|Please update
iChat Server|?|Please update
"""]]

See also: [[xmpp_protocol_design_notes|design/assistant/xmpp]]