www.LinuxHowtos.org

GIT\-INSTAWEB

Section: Git Manual (1)
Updated: 11/29/2016
Index Return to Main Contents

NAME

git-instaweb - Instantly browse your working repository in gitweb

SYNOPSIS

git instaweb [--local] [--httpd=<httpd>] [--port=<port>]
               [--browser=<browser>]
git instaweb [--start] [--stop] [--restart]

DESCRIPTION

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

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 the configuration file will be added at the end of the command-line. Currently apache2, lighttpd, mongoose, plackup and webrick 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 gitweb page. This will be passed to the git web--browse helper script along with the URL of the gitweb instance. See git-web--browse(1) for more information about this. If the script fails, the URL will be printed to stdout.

start, --start

: Start the httpd instance and exit. Regenerate configuration files as necessary for spawning a new instance.

stop, --stop

: Stop the httpd instance and exit. This does not generate any 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 files as necessary for spawning a new instance.

CONFIGURATION

You may specify configuration in your .git/config

[instaweb]
        local = true
        httpd = apache2 -f
        port = 4321
        browser = konqueror
        modulePath = /usr/lib/apache2/modules

If the configuration variable instaweb.browser is not set, web.browser will be used instead if it is defined. See git-web--browse(1) for more information about this.

GIT

Part of the git(1) suite