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 # DESCRIPTION
  14
  15 `bup web` starts a web server that can browse bup repositories. The file
  16 hierarchy is the same as that shown by `bup-fuse`(1), `bup-ls`(1) and
  17 `bup-ftp`(1).
  18
  19 `hostname` and `port` default to 127.0.0.1 and 8080, respectively, and hence
  20 `bup web` will only offer up the web server to locally running clients. If
  21 you'd like to expose the web server to anyone on your network (dangerous!) you
  22 can omit the bind address to bind to all available interfaces: `:8080`.
  23
  24 A `SIGTERM` signal may be sent to the server to request an orderly
  25 shutdown.
  26
  27 # OPTIONS
  28
  29 --human-readable
  30 :   display human readable file sizes (i.e. 3.9K, 4.7M)
  31
  32 --browser
  33 :   open the site in the default browser
  34
  35 # EXAMPLES
  36
  37     $ bup web
  38     Serving HTTP on 127.0.0.1:8080...
  39     ^C
  40     Interrupted.
  41
  42     $ bup web :8080
  43     Serving HTTP on 0.0.0.0:8080...
  44     ^C
  45     Interrupted.
  46
  47     $ bup web &
  48     [1] 30980
  49     Serving HTTP on 127.0.0.1:8080...
  50     $ kill -s TERM 30980
  51     Shutdown requested
  52     $ wait 30980
  53     $ echo $?
  54     0
  55
  56 # SEE ALSO
  57
  58 `bup-fuse`(1), `bup-ls`(1), `bup-ftp`(1), `bup-restore`(1), `kill`(1)
  59
  60
  61 # BUP
  62
  63 Part of the `bup`(1) suite.