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 # OPTIONS
  25
  26 --human-readable
  27 :   display human readable file sizes (i.e. 3.9K, 4.7M)
  28
  29 --browser
  30 :   open the site in the default browser
  31
  32 # EXAMPLES
  33
  34     $ bup web
  35     Serving HTTP on 127.0.0.1:8080...
  36     ^C
  37
  38     $ bup web :8080
  39     Serving HTTP on 0.0.0.0:8080...
  40     ^C
  41
  42
  43 # SEE ALSO
  44
  45 `bup-fuse`(1), `bup-ls`(1), `bup-ftp`(1), `bup-restore`(1)
  46
  47
  48 # BUP
  49
  50 Part of the `bup`(1) suite.