git.cworth.org Git - notmuch-wiki/blob - remoteusage.mdwn

   1 [[!img notmuch-logo.png alt="Notmuch logo" class="left"]]
   2 #Using notmuch remotely#
   3
   4 ##Why?##
   5 It is hard to keep nomuch tags in sync across multiple instances of
   6 notmuch, on multiple computers. Though you can do this with "notmuch
   7 dump" and "notmuch restore", it is often preferable to be able to use
   8 notmuch on a remote computer as if it were present on a local
   9 computer.
  10
  11 The following guidelines show how I have accomplished this. It isn't
  12 perfect, but it works pretty well, and allows me to access notmuch on
  13 my home computer, using only an emacs client on my netbook or work
  14 computer, a trivial shell script, a few settings in my .emacs, and a
  15 couple of common unix utilities (ssh and dtach).
  16
  17 ##What you will need##
  18 You will need to have the following items in place:
  19
  20 1.  a working notmuch on one computer (let's call that computer
  21 "server").
  22
  23 2.  a working notmuch emacs interface on another computer (let's call
  24 that computer "client")
  25
  26 3.  `ssh` and `dtach` on your client computer. (TODO: Make dtach
  27 optional, or allow screen or tmux to be used instead.)
  28
  29 4.  password-free login (public key authentication) from client to
  30 server. [Here](http://www.debian-administration.org/articles/152) is a
  31 good page on how to set it up.
  32
  33 5.  a reasonably fast connection. (This isn't really *neccessary*, but
  34 if your connection is too slow, this won't be very pleasant to use,
  35 and certainly won't seem transparent.)
  36
  37
  38 ##Write a wrapper shell script##
  39
  40 Now we will need to write a simple shell script that does two things:
  41
  42 1.  replaces the call to the notmuch binary with a call to notmuch
  43 over ssh.
  44
  45 2.  sets up a running, detached, ssh connection to the server, so that
  46 future calls can reuse the socket.
  47
  48         #!/usr/bin/env bash
  49
  50         SSH_BIN="ssh"
  51         USER="example_user"
  52         SSH_HOST="example.com"
  53         SSH_SOCKET="/tmp/notmuch_ssh.socket"
  54         NOTMUCH_REMOTE_BIN="notmuch"
  55         DTACH="dtach"
  56         DTACH_SOCKET="/tmp/notmuch_dtach.socket"
  57
  58         check_for_socket ()
  59         {
  60             [ -S "${SSH_SOCKET}" ]
  61         }
  62
  63         check_if_socket_alive ()
  64         {
  65             timeout 1 $SSH_BIN -S ${SSH_SOCKET} $USER@$SSH_HOST true > /dev/null
  66         }
  67
  68         start_socket ()
  69         {
  70             dtach_command="${DTACH} -n ${DTACH_SOCKET} ${SSH_BIN} -M -S ${SSH_SOCKET} ${USER}@${SSH_HOST}"
  71             command -v ${DTACH} &>/dev/null && ${dtach_command} ||
  72             echo "${DTACH} not installed"
  73         }
  74
  75         notmuch_run ()
  76         {
  77             check_for_socket || start_socket
  78             CMD=$1
  79             shift
  80             printf -v ARGS "%q " "$@"
  81             $SSH_BIN -S $SSH_SOCKET $USER@$SSH_HOST $NOTMUCH_REMOTE_BIN ${CMD} ${ARGS}
  82         }
  83
  84         notmuch_run $@
  85
  86
  87 Save this to a file, "remote-notmuch.sh", in your path.
  88
  89 Now you can run "remote-notmuch.sh new". You can call the script
  90 anything you like. I actually have $HOME/bin/notmuch linked to that
  91 script, so I can have transparent
  92 usage.
  93
  94 ##Configure your emacs client##
  95
  96 The only thing you need to do is tell your emacs client to use the
  97 script. Add the following to your .emacs (this is on your client
  98 machine):
  99
 100     (setq notmuch-command "/path/to/your/remote-notmuch.sh")
 101
 102 ##Problems##
 103 Some things probably won't work perfectly, and there might be some unexpected
 104 mismatches between normal usage and this sort of usage. If you're
 105 using this approach and run into any problems, please feel free to
 106 list them here. And, of course, if you improve on any of these
 107 approaches, please do edit this page and let people know!