diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/assistant.mdwn | 2 | ||||
-rw-r--r-- | doc/assistant/share_with_a_friend_walkthrough.mdwn | 58 | ||||
-rw-r--r-- | doc/assistant/share_with_a_friend_walkthrough/xmppalert.png | bin | 4070 -> 0 bytes | |||
-rw-r--r-- | doc/bugs/assistant_-_GTalk_collision.mdwn | 2 | ||||
-rw-r--r-- | doc/bugs/problems_with_android_and_xmpp.mdwn | 2 | ||||
-rw-r--r-- | doc/git-annex-xmppgit.mdwn | 23 | ||||
-rw-r--r-- | doc/git-annex.mdwn | 20 | ||||
-rw-r--r-- | doc/special_remotes/xmpp.mdwn | 43 | ||||
-rw-r--r-- | doc/todo/windows_support.mdwn | 41 | ||||
-rw-r--r-- | doc/todo/wishlist__58___Advanced_settings_for_xmpp_and_webdav.mdwn | 2 | ||||
-rw-r--r-- | doc/todo/xmpp_removal.mdwn | 2 |
11 files changed, 16 insertions, 179 deletions
diff --git a/doc/assistant.mdwn b/doc/assistant.mdwn index 2ed35d6df..f625ebeed 100644 --- a/doc/assistant.mdwn +++ b/doc/assistant.mdwn @@ -24,8 +24,6 @@ instructions. * Or perhaps you want to share files between computers in different locations, like home and work? Follow the [[remote_sharing_walkthrough]]. -* Want to share a synchronised folder with a friend? - Follow the [[share_with_a_friend_walkthrough]]. * Want to archive data to a drive or the cloud? Follow the [[archival_walkthrough]]. diff --git a/doc/assistant/share_with_a_friend_walkthrough.mdwn b/doc/assistant/share_with_a_friend_walkthrough.mdwn deleted file mode 100644 index 38544d111..000000000 --- a/doc/assistant/share_with_a_friend_walkthrough.mdwn +++ /dev/null @@ -1,58 +0,0 @@ -Want to share all the files in your repository with a friend? - -Let's suppose you use Google Mail, and so does your friend, and you -sometimes also chat in Google Talk. The git-annex assistant will -use your Google account to share with your friend. (This actually -works with any Jabber account you use, not just Google Talk.) - -Start by opening up your git annex dashboard. - -[[!img local_pairing_walkthrough/addrepository.png alt="Add another repository button"]] - -`*click*` - -[[!img pairing.png alt="Share with a friend"]] - -`*click*` - -[[!img xmpp.png alt="Configuring Jabber account"]] - -Fill that out, and git-annex will be able to show you a list of your -friends. - -[[!img buddylist.png alt="Buddy list"]] - -This list will refresh as friends log on and off, so you can -leave it open in a tab until a friend is available to start pairing. - -(If your friend is not using git-annex yet, now's a great time to spread -the word!) - -Once you click on "Start Pairing", your friend will see this pop up -on their git annex dashboard. - -[[!img xmppalert.png alt="Pair request"]] - -Once your friend clicks on that, your repositories will be paired. - -### But, wait, there's one more step... - -Despite the repositories being paired now, you and your friend can't yet -quite share files. You'll start to see your friend's files show up in your -git-annex folder, but you won't be able to open them yet. - -What you need to do now is set up a repository out there in the cloud, -that both you and your friend can access. This will be used to transfer -files between the two of you. - -At the end of the pairing process, a number of cloud providers are -suggested, and the git-annex assistant makes it easy to configure one of -them. Once you or your friend sets it up, it'll show up in the other -one's list of repositories: - -[[!img repolist.png alt="Repository list"]] - -The final step is to share the login information for the cloud repository -with your friend, so they can enable it too. - -With that complete, you'll be able to open your friend's files! diff --git a/doc/assistant/share_with_a_friend_walkthrough/xmppalert.png b/doc/assistant/share_with_a_friend_walkthrough/xmppalert.png Binary files differdeleted file mode 100644 index 5e2d56289..000000000 --- a/doc/assistant/share_with_a_friend_walkthrough/xmppalert.png +++ /dev/null diff --git a/doc/bugs/assistant_-_GTalk_collision.mdwn b/doc/bugs/assistant_-_GTalk_collision.mdwn index b814166ae..a950dcdbc 100644 --- a/doc/bugs/assistant_-_GTalk_collision.mdwn +++ b/doc/bugs/assistant_-_GTalk_collision.mdwn @@ -15,3 +15,5 @@ I expect to remain invisible, but I get the following warning: "Oops! You are no Syncing between the repositories works ok. [[!tag /design/assistant]] + +> [[done]]; xmpp support has been removed. --[[Joey]] diff --git a/doc/bugs/problems_with_android_and_xmpp.mdwn b/doc/bugs/problems_with_android_and_xmpp.mdwn index 0b05c94bb..73ceab7b3 100644 --- a/doc/bugs/problems_with_android_and_xmpp.mdwn +++ b/doc/bugs/problems_with_android_and_xmpp.mdwn @@ -80,3 +80,5 @@ fatal: The remote end hung up unexpectedly [2014-02-13 13:18:25 CET] XMPPClient: to client: d6/tigase-14134 """]] + +> [[done]]; xmpp support has been removed --[[Joey]] diff --git a/doc/git-annex-xmppgit.mdwn b/doc/git-annex-xmppgit.mdwn deleted file mode 100644 index 76ae81cb4..000000000 --- a/doc/git-annex-xmppgit.mdwn +++ /dev/null @@ -1,23 +0,0 @@ -# NAME - -git-annex xmppgit - git to XMPP relay - -# SYNOPSIS - -git annex xmppgit - -# DESCRIPTION - -This command is used internally by the assistant to perform git pulls over XMPP. - -# SEE ALSO - -[[git-annex]](1) - -[[git-annex-assistant]](1) - -# AUTHOR - -Joey Hess <id@joeyh.name> - -Warning: Automatically converted into a man page by mdwn2man. Edit with care. diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn index d0cc31019..ca1ac3620 100644 --- a/doc/git-annex.mdwn +++ b/doc/git-annex.mdwn @@ -385,12 +385,6 @@ subdirectories). See [[git-annex-repair]](1) for details. -* `remotedaemon` - - Persistent communication with remotes. - - See [[git-annex-remotedaemon]](1) for details. - * `p2p` Configure peer-2-Peer links between repositories. @@ -670,12 +664,11 @@ subdirectories). See [[git-annex-smudge]](1) for details. -* `xmppgit` +* `remotedaemon` - This command is used internally by the assistant to perform git pulls - over XMPP. - - See [[git-annex-xmppgit]](1) for details. + Detects when network remotes have received git pushes and fetches from them. + + See [[git-annex-remotedaemon]](1) for details. # TESTING COMMANDS @@ -1308,11 +1301,6 @@ Here are all the supported configuration settings. Used to identify tahoe special remotes. Points to the configuration directory for tahoe. -* `remote.<name>.annex-xmppaddress` - - Used to identify the XMPP address of a Jabber buddy. - Normally this is set up by the git-annex assistant when pairing over XMPP. - * `remote.<name>.gcrypt` Used to identify gcrypt special remotes. diff --git a/doc/special_remotes/xmpp.mdwn b/doc/special_remotes/xmpp.mdwn index 0f1c93b25..0144a4243 100644 --- a/doc/special_remotes/xmpp.mdwn +++ b/doc/special_remotes/xmpp.mdwn @@ -1,39 +1,4 @@ -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. - -## XMPP server support status -[[!table data=""" -Provider|Status|Type|Notes -[[Gmail|http://gmail.com]]|Working|?|Google Apps: [setup your SRV records](http://www.olark.com/gtalk/check_srv) or configure `.git/annex/creds/xmpp` manually -[[Coderollers|http://www.coderollers.com/xmpp-server/]]|Working|[[Openfire|http://www.igniterealtime.org/projects/openfire/]] -[[jabber.me|http://jabber.me/]]|Working|[[Tigase|http://www.tigase.org/]] -[[xmpp.ru.net|https://www.xmpp.ru.net]]|Working|[[jabberd2|http://jabberd2.org/]] -[[jabber.org|http://jabber.org]]|Working|[[Isode M-Link|http://www.isode.com/products/m-link.html]] --|Working|[[Prosody|http://prosody.im/]]|No providers tested. --|Working|[[Metronome|http://www.lightwitch.org/]]|No providers tested. --|[[Failing|http://git-annex.branchable.com/forum/XMPP_authentication_failure/]]|ejabberd|[[Authentication bug|https://support.process-one.net/browse/EJAB-1632]]: Fixed in debian unstable (>= 2.1.10-5) and stable (>=2.1.10-4+deb7u1) --|[[Failing|http://git-annex.branchable.com/forum/XMPP_authentication_failure/#comment-4ce5aeabd12ca3016290b3d8255f6ef1]]|jabberd14|No further information -"""]] -List of providers: [[http://xmpp.net/]] - -See also: [[xmpp_protocol_design_notes|design/assistant/xmpp]] +XMPP (Jabber) used to be able to be used by the [[assistant]] as a git remote. +This never worked very well, and it was not entirely secure, since the XMPP +server saw the contents of git pushes without encryption. So, XMPP support +has been removed. diff --git a/doc/todo/windows_support.mdwn b/doc/todo/windows_support.mdwn index 4606f7f40..d45e9a821 100644 --- a/doc/todo/windows_support.mdwn +++ b/doc/todo/windows_support.mdwn @@ -21,8 +21,6 @@ Seems like this would need Windows 10. Workaround: Put your git-annex repo in `C:\annex` or some similar short path if possible. -* XMPP library not yet built. (See below.) - * Local pairing seems to fail, after acking on Linux box, it stalls. (Also, of course, the Windows box is unlikely to have a ssh server, so only pairing with a !Windows box will work.) @@ -88,42 +86,3 @@ seems unreliable/broken on Windows. it and files can be transferred to it and back * Does stopping in progress transfers work in the webapp? -## trying to build XMPP - -Lots of library deps: - -1. gsasl-$LATEST.zip from <http://josefsson.org/gnutls4win/> (includes - gnuidn and gnutls) -2. pkg-config from - <http://sourceforge.net/projects/pkgconfiglite/files/latest/download?source=files> -3. libxml2 from mingw: - <http://sourceforge.net/projects/mingw/files/MSYS/Extension/libxml2/libxml2-2.7.6-1/> - both the -dll and the -dev -3. Extract all the above into the Haskell platform's mingw directory. Note - that pkg-config needs to be moved out of a named subdirectory. -4. Run in DOS prompt (not cygwin!): cabal install network-protocol-xmpp - -Current FAIL: - -<pre> -Loading package gnutls-0.1.5 ... ghc.exe: internal error: Misaligned section: 18206e5b - (GHC version 7.6.3 for i386_unknown_mingw32) - Please report this as a GHC bug: - http://www.haskell.org/ghc/reportabug -</pre> - -<https://ghc.haskell.org/trac/ghc/ticket/8830> - -Note: This only happens in the TH link stage. So building w/o the webapp -works with XMPP. - -Options: - -1. Use EvilSplicer, building first without XMPP library, but with its UI, - and a second time without TH, but with the XMPP library. Partially done - on the `winsplicehack` branch, but requires building patched versions - of lots of yesod dependency chain to export modules referenced by TH - splices, like had to be done on Android. Horrible pain. Ugly as hell. -2. Make a helper program with the XMPP support in it, that does not use TH. -3. Swich to a different XMPP client library, like - <http://hackage.haskell.org/package/pontarius-xmpp> diff --git a/doc/todo/wishlist__58___Advanced_settings_for_xmpp_and_webdav.mdwn b/doc/todo/wishlist__58___Advanced_settings_for_xmpp_and_webdav.mdwn index 96552eecc..83f75bb93 100644 --- a/doc/todo/wishlist__58___Advanced_settings_for_xmpp_and_webdav.mdwn +++ b/doc/todo/wishlist__58___Advanced_settings_for_xmpp_and_webdav.mdwn @@ -5,3 +5,5 @@ Currently XMPP fails if you use a google apps account. Since the domain provided Same goes for webdav support. If i have my own webdav server somewhere on the internet there is no way to set it up in the assistant. [[!tag /design/assistant]] + +> [[done]]; xmpp support has been removed --[[Joey]] diff --git a/doc/todo/xmpp_removal.mdwn b/doc/todo/xmpp_removal.mdwn index c517c33f9..373c16ca1 100644 --- a/doc/todo/xmpp_removal.mdwn +++ b/doc/todo/xmpp_removal.mdwn @@ -25,3 +25,5 @@ The [[no-xmpp]] branch is ready for merging. Next step is probably to default the flag to false by default, except for in a few builds like the Debian package and standalone builds. + +> [[done]] |