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 3.  `ssh` and `dtach` on your client computer. (TODO: Make dtach
  26 optional, or allow screen or tmux to be used instead.)
  27 4.  password-free login (public key authentication) from client to
  28 server. [Here](http://www.debian-administration.org/articles/152) is a
  29 good page on how to set it up.
  30 5.  a reasonably fast connection. (This isn't really *neccessary*, but
  31 if your connection is too slow, this won't be very pleasant to use,
  32 and certainly won't seem transparent.)
  33
  34
  35 ##Write a wrapper shell script##
  36
  37 Now we will need to write a simple shell script that does two things:
  38
  39 1.  replaces the call to the notmuch binary with a call to notmuch
  40 over ssh.
  41 2.  sets up a running, detached, ssh connection to the server, so that
  42 future calls can reuse the socket.
  43
  44      #!/usr/bin/env bash
  45
  46      SSH_BIN="ssh"
  47      USER="example_user"
  48      SSH_HOST="example.com"
  49      SSH_SOCKET="/tmp/notmuch_ssh.socket"
  50      NOTMUCH_REMOTE_BIN="notmuch"
  51      DTACH="dtach"
  52      DTACH_SOCKET="/tmp/notmuch_dtach.socket"
  53
  54      check_for_socket ()
  55      {
  56          [ -S "${SSH_SOCKET}" ]
  57      }
  58
  59      check_if_socket_alive ()
  60      {
  61          timeout 1 $SSH_BIN -S ${SSH_SOCKET} $USER@$SSH_HOST true > /dev/null
  62      }
  63
  64      start_socket ()
  65      {
  66          dtach_command="${DTACH} -n ${DTACH_SOCKET} ${SSH_BIN} -M -S ${SSH_SOCKET} ${USER}@${SSH_HOST}"
  67          command -v ${DTACH} &>/dev/null && ${dtach_command} ||
  68          echo "${DTACH} not installed"
  69      }
  70
  71      notmuch_run ()
  72      {
  73          check_for_socket || start_socket
  74          CMD=$1
  75          shift
  76          printf -v ARGS "%q " "$@"
  77          $SSH_BIN -S $SSH_SOCKET $USER@$SSH_HOST $NOTMUCH_REMOTE_BIN ${CMD} ${ARGS}
  78      }
  79
  80      notmuch_run $@
  81
  82
  83 Save this to a file, "remote-notmuch.sh", in your path.
  84
  85 Now you can run "remote-notmuch.sh new". You can call the script
  86 anything you like. I actually have $HOME/bin/notmuch linked to that
  87 script, so I can have transparent
  88 usage.
  89
  90 ##Configure your emacs client##
  91
  92 The only thing you need to do is tell your emacs client to use the
  93 script. Add the following to your .emacs (this is on your client
  94 machine):
  95
  96     (setq notmuch-command "/path/to/your/remote-notmuch.sh")
  97
  98 ##Problems##
  99 Some things probably won't work perfectly, and there might be some unexpected
 100 mismatches between normal usage and this sort of usage. If you're
 101 using this approach and run into any problems, please feel free to
 102 list them here. And, of course, if you improve on any of these
 103 approaches, please do edit this page and let people know!