Google Git
Sign in
googlers / jrn / git / 8963bb0c2d023738f8ea021b512ed83cd79ee754 / . / Documentation / git-instaweb.txt
blob: e8ecdbf927ba5e7af79d3852a9a939c10052e45f [file] [log] [blame]
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]1git-instaweb(1)
2===============
3
4NAME
5----
Junio C Hamanoc3f0baa2007-01-18 15:53:37 -0800[diff] [blame]6git-instaweb - Instantly browse your working repository in gitweb
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]7
8SYNOPSIS
9--------
Matthias Kestenholz97925fd2007-05-18 15:39:34 +0200[diff] [blame]10[verse]
Jonathan Niederb1889c32008-06-30 01:09:04 -0500[diff] [blame]11'git instaweb' [--local] [--httpd=<httpd>] [--port=<port>]
Matthias Kestenholz97925fd2007-05-18 15:39:34 +0200[diff] [blame]12 [--browser=<browser>]
Jonathan Niederb1889c32008-06-30 01:09:04 -0500[diff] [blame]13'git instaweb' [--start] [--stop] [--restart]
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]14
15DESCRIPTION
16-----------
Jonathan Nieder483bc4f2008-06-30 13:56:34 -0500[diff] [blame]17A simple script to set up `gitweb` and a web server for browsing the local
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]18repository.
19
20OPTIONS
21-------
22
Stephan Beyer32402402008-06-08 03:36:09 +0200[diff] [blame]23-l::
24--local::
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]25 Only bind the web server to the local IP (127.0.0.1).
26
Stephan Beyer32402402008-06-08 03:36:09 +0200[diff] [blame]27-d::
28--httpd::
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]29 The HTTP daemon command-line that will be executed.
30 Command-line options may be specified here, and the
31 configuration file will be added at the end of the command-line.
Jakub Narebski78646982010-05-28 21:11:25 +0200[diff] [blame]32 Currently apache2, lighttpd, mongoose, plackup and webrick are supported.
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]33 (Default: lighttpd)
34
Stephan Beyer32402402008-06-08 03:36:09 +0200[diff] [blame]35-m::
36--module-path::
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]37 The module path (only needed if httpd is Apache).
38 (Default: /usr/lib/apache2/modules)
39
Stephan Beyer32402402008-06-08 03:36:09 +0200[diff] [blame]40-p::
41--port::
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]42 The port number to bind the httpd to. (Default: 1234)
43
Stephan Beyer32402402008-06-08 03:36:09 +0200[diff] [blame]44-b::
45--browser::
Christian Couderb261ec42008-02-09 07:10:57 +0100[diff] [blame]46 The web browser that should be used to view the gitweb
Junio C Hamano28394782010-08-23 14:20:25 -0700[diff] [blame]47 page. This will be passed to the 'git web{litdd}browse' helper
Christian Coudercb45f832008-02-14 08:01:23 +0100[diff] [blame]48 script along with the URL of the gitweb instance. See
Junio C Hamano28394782010-08-23 14:20:25 -0700[diff] [blame]49 linkgit:git-web{litdd}browse[1] for more information about this. If
Christian Coudercb45f832008-02-14 08:01:23 +0100[diff] [blame]50 the script fails, the URL will be printed to stdout.
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]51
Jared Hanceb73f2942010-08-02 14:20:38 -0400[diff] [blame]52start::
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]53--start::
Jakub Narebski5ad6d382011-06-23 23:01:03 +0200[diff] [blame]54 Start the httpd instance and exit. Regenerate configuration files
55 as necessary for spawning a new instance.
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]56
Jared Hanceb73f2942010-08-02 14:20:38 -0400[diff] [blame]57stop::
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]58--stop::
59 Stop the httpd instance and exit. This does not generate
60 any of the configuration files for spawning a new instance,
61 nor does it close the browser.
62
Jared Hanceb73f2942010-08-02 14:20:38 -0400[diff] [blame]63restart::
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]64--restart::
Jakub Narebski5ad6d382011-06-23 23:01:03 +0200[diff] [blame]65 Restart the httpd instance and exit. Regenerate configuration files
66 as necessary for spawning a new instance.
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]67
68CONFIGURATION
69-------------
70
71You may specify configuration in your .git/config
72
73-----------------------------------------------------------------------
74[instaweb]
75 local = true
76 httpd = apache2 -f
77 port = 4321
78 browser = konqueror
Nguyễn Thái Ngọc Duyda0005b2015-03-11 16:32:45 -0400[diff] [blame]79 modulePath = /usr/lib/apache2/modules
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]80
81-----------------------------------------------------------------------
82
Tom Russelloae9f6312016-06-08 19:23:16 +0200[diff] [blame]83If the configuration variable `instaweb.browser` is not set,
84`web.browser` will be used instead if it is defined. See
Junio C Hamano28394782010-08-23 14:20:25 -0700[diff] [blame]85linkgit:git-web{litdd}browse[1] for more information about this.
Christian Couderb261ec42008-02-09 07:10:57 +0100[diff] [blame]86
Jakub Narebski86ce2d52011-10-16 13:07:33 +0200[diff] [blame]87SEE ALSO
88--------
89linkgit:gitweb[1]
90
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]91GIT
92---
Christian Couder9e1f0a82008-06-06 09:07:32 +0200[diff] [blame]93Part of the linkgit:git[1] suite