1GIT-INSTAWEB(1)                   Git Manual                   GIT-INSTAWEB(1)
2
3
4

NAME

6       git-instaweb - Instantly browse your working repository in gitweb
7

SYNOPSIS

9       git instaweb [--local] [--httpd=<httpd>] [--port=<port>]
10                      [--browser=<browser>]
11       git instaweb [--start] [--stop] [--restart]
12

DESCRIPTION

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

OPTIONS

18       -l, --local
19           Only bind the web server to the local IP (127.0.0.1).
20
21       -d, --httpd
22           The HTTP daemon command-line that will be executed. Command-line
23           options may be specified here, and the configuration file will be
24           added at the end of the command-line. Currently apache2, lighttpd,
25           mongoose, plackup, python and webrick are supported. (Default:
26           lighttpd)
27
28       -m, --module-path
29           The module path (only needed if httpd is Apache). (Default:
30           /usr/lib/apache2/modules)
31
32       -p, --port
33           The port number to bind the httpd to. (Default: 1234)
34
35       -b, --browser
36           The web browser that should be used to view the gitweb page. This
37           will be passed to the git web--browse helper script along with the
38           URL of the gitweb instance. See git-web--browse(1) for more
39           information about this. If the script fails, the URL will be
40           printed to stdout.
41
42       start, --start
43           Start the httpd instance and exit. Regenerate configuration files
44           as necessary for spawning a new instance.
45
46       stop, --stop
47           Stop the httpd instance and exit. This does not generate any of the
48           configuration files for spawning a new instance, nor does it close
49           the browser.
50
51       restart, --restart
52           Restart the httpd instance and exit. Regenerate configuration files
53           as necessary for spawning a new instance.
54

CONFIGURATION

56       You may specify configuration in your .git/config
57
58           [instaweb]
59                   local = true
60                   httpd = apache2 -f
61                   port = 4321
62                   browser = konqueror
63                   modulePath = /usr/lib/apache2/modules
64
65       If the configuration variable instaweb.browser is not set, web.browser
66       will be used instead if it is defined. See git-web--browse(1) for more
67       information about this.
68

SEE ALSO

70       gitweb(1)
71

GIT

73       Part of the git(1) suite
74
75
76
77Git 2.31.1                        2021-03-26                   GIT-INSTAWEB(1)