Documentation/bup-web.md

   1 % bup-ftp(1) Bup %BUP_VERSION%
   2 % Joe Beda <jbeda@gmail.com>
   3 % %BUP_DATE%
   4
   5 # NAME
   6
   7 bup-web - Start web server to browse bup repositiory
   8
   9 # SYNOPSIS
  10
  11 bup web [[hostname]:port]
  12
  13 bup web unix://path
  14
  15 # DESCRIPTION
  16
  17 `bup web` starts a web server that can browse bup repositories. The file
  18 hierarchy is the same as that shown by `bup-fuse`(1), `bup-ls`(1) and
  19 `bup-ftp`(1).
  20
  21 `hostname` and `port` default to 127.0.0.1 and 8080, respectively, and hence
  22 `bup web` will only offer up the web server to locally running clients. If
  23 you'd like to expose the web server to anyone on your network (dangerous!) you
  24 can omit the bind address to bind to all available interfaces: `:8080`.
  25
  26 When `unix://path` is specified, the server will listen on the
  27 filesystem socket at `path` rather than a network socket.
  28
  29 A `SIGTERM` signal may be sent to the server to request an orderly
  30 shutdown.
  31
  32 # OPTIONS
  33
  34 \--human-readable
  35 :   display human readable file sizes (i.e. 3.9K, 4.7M)
  36
  37 \--browser
  38 :   open the site in the default browser
  39
  40 # EXAMPLES
  41
  42     $ bup web
  43     Serving HTTP on 127.0.0.1:8080...
  44     ^C
  45     Interrupted.
  46
  47     $ bup web :8080
  48     Serving HTTP on 0.0.0.0:8080...
  49     ^C
  50     Interrupted.
  51
  52     $ bup web unix://socket &
  53     Serving HTTP on filesystem socket 'socket'
  54     $ curl --unix-socket ./socket http://localhost/
  55     $ fg
  56     bup web unix://socket
  57     ^C
  58     Interrupted.
  59
  60     $ bup web &
  61     [1] 30980
  62     Serving HTTP on 127.0.0.1:8080...
  63     $ kill -s TERM 30980
  64     Shutdown requested
  65     $ wait 30980
  66     $ echo $?
  67     0
  68
  69 # SEE ALSO
  70
  71 `bup-fuse`(1), `bup-ls`(1), `bup-ftp`(1), `bup-restore`(1), `kill`(1)
  72
  73
  74 # BUP
  75
  76 Part of the `bup`(1) suite.