NAME

git-instaweb - Instantly browse your working repository in gitweb

SYNOPSIS

  1. git instaweb [--local] [--httpd=<httpd>] [--port=<port>]
  2. [--browser=<browser>]
  3. git instaweb [--start] [--stop] [--restart]

DESCRIPTION

A simple script to set up gitweb and a web server for browsing the localrepository.

OPTIONS

  • -l
  • —local
  • Only bind the web server to the local IP (127.0.0.1).

  • -d

  • —httpd
  • The HTTP daemon command-line that will be executed.Command-line options may be specified here, and theconfiguration file will be added at the end of the command-line.Currently apache2, lighttpd, mongoose, plackup, python andwebrick are supported.(Default: lighttpd)

  • -m

  • —module-path
  • The module path (only needed if httpd is Apache).(Default: /usr/lib/apache2/modules)

  • -p

  • —port
  • The port number to bind the httpd to. (Default: 1234)

  • -b

  • —browser
  • The web browser that should be used to view the gitwebpage. This will be passed to the git web{litdd}browse helperscript along with the URL of the gitweb instance. Seegit-web{litdd}browse[1] for more information about this. Ifthe script fails, the URL will be printed to stdout.

  • start

  • —start
  • Start the httpd instance and exit. Regenerate configuration filesas necessary for spawning a new instance.

  • stop

  • —stop
  • Stop the httpd instance and exit. This does not generateany of the configuration files for spawning a new instance,nor does it close the browser.

  • restart

  • —restart
  • Restart the httpd instance and exit. Regenerate configuration filesas necessary for spawning a new instance.

CONFIGURATION

You may specify configuration in your .git/config

  1. [instaweb]
  2. local = true
  3. httpd = apache2 -f
  4. port = 4321
  5. browser = konqueror
  6. modulePath = /usr/lib/apache2/modules

If the configuration variable instaweb.browser is not set,web.browser will be used instead if it is defined. Seegit-web{litdd}browse[1] for more information about this.

SEE ALSO

gitweb[1]

GIT

Part of the git[1] suite