Google Git
Sign in
googlers / jrn / git / ef5aef5ee0f8ff932f8beb21ff33a4dafee214b5 / . / Documentation / git-instaweb.txt
blob: a54fe4401bd1a21c6bd133745ab8864882ca73d4 [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.
Arti Zirk2eb14bb2019-01-28 15:24:59 +0200[diff] [blame]32 Currently apache2, lighttpd, mongoose, plackup, python and
33 webrick are supported.
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]34 (Default: lighttpd)
35
Stephan Beyer32402402008-06-08 03:36:09 +0200[diff] [blame]36-m::
37--module-path::
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]38 The module path (only needed if httpd is Apache).
39 (Default: /usr/lib/apache2/modules)
40
Stephan Beyer32402402008-06-08 03:36:09 +0200[diff] [blame]41-p::
42--port::
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]43 The port number to bind the httpd to. (Default: 1234)
44
Stephan Beyer32402402008-06-08 03:36:09 +0200[diff] [blame]45-b::
46--browser::
Christian Couderb261ec42008-02-09 07:10:57 +0100[diff] [blame]47 The web browser that should be used to view the gitweb
Junio C Hamano28394782010-08-23 14:20:25 -0700[diff] [blame]48 page. This will be passed to the 'git web{litdd}browse' helper
Christian Coudercb45f832008-02-14 08:01:23 +0100[diff] [blame]49 script along with the URL of the gitweb instance. See
Junio C Hamano28394782010-08-23 14:20:25 -0700[diff] [blame]50 linkgit:git-web{litdd}browse[1] for more information about this. If
Christian Coudercb45f832008-02-14 08:01:23 +0100[diff] [blame]51 the script fails, the URL will be printed to stdout.
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]52
Jared Hanceb73f2942010-08-02 14:20:38 -0400[diff] [blame]53start::
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]54--start::
Jakub Narebski5ad6d382011-06-23 23:01:03 +0200[diff] [blame]55 Start the httpd instance and exit. Regenerate configuration files
56 as necessary for spawning a new instance.
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]57
Jared Hanceb73f2942010-08-02 14:20:38 -0400[diff] [blame]58stop::
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]59--stop::
60 Stop the httpd instance and exit. This does not generate
61 any of the configuration files for spawning a new instance,
62 nor does it close the browser.
63
Jared Hanceb73f2942010-08-02 14:20:38 -0400[diff] [blame]64restart::
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]65--restart::
Jakub Narebski5ad6d382011-06-23 23:01:03 +0200[diff] [blame]66 Restart the httpd instance and exit. Regenerate configuration files
67 as necessary for spawning a new instance.
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]68
69CONFIGURATION
70-------------
71
72You may specify configuration in your .git/config
73
74-----------------------------------------------------------------------
75[instaweb]
76 local = true
77 httpd = apache2 -f
78 port = 4321
79 browser = konqueror
Nguyễn Thái Ngọc Duyda0005b2015-03-11 16:32:45 -0400[diff] [blame]80 modulePath = /usr/lib/apache2/modules
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]81
82-----------------------------------------------------------------------
83
Tom Russelloae9f6312016-06-08 19:23:16 +0200[diff] [blame]84If the configuration variable `instaweb.browser` is not set,
85`web.browser` will be used instead if it is defined. See
Junio C Hamano28394782010-08-23 14:20:25 -0700[diff] [blame]86linkgit:git-web{litdd}browse[1] for more information about this.
Christian Couderb261ec42008-02-09 07:10:57 +0100[diff] [blame]87
Jakub Narebski86ce2d52011-10-16 13:07:33 +0200[diff] [blame]88SEE ALSO
89--------
90linkgit:gitweb[1]
91
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]92GIT
93---
Christian Couder9e1f0a82008-06-06 09:07:32 +0200[diff] [blame]94Part of the linkgit:git[1] suite