2006-07-01 22:14:14 +00:00
|
|
|
git-instaweb(1)
|
|
|
|
|
===============
|
|
|
|
|
|
|
|
|
|
NAME
|
|
|
|
|
----
|
2007-01-18 23:53:37 +00:00
|
|
|
git-instaweb - Instantly browse your working repository in gitweb
|
2006-07-01 22:14:14 +00:00
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
|
--------
|
2007-05-18 13:39:34 +00:00
|
|
|
[verse]
|
2008-06-30 06:09:04 +00:00
|
|
|
'git instaweb' [--local] [--httpd=<httpd>] [--port=<port>]
|
2007-05-18 13:39:34 +00:00
|
|
|
[--browser=<browser>]
|
2008-06-30 06:09:04 +00:00
|
|
|
'git instaweb' [--start] [--stop] [--restart]
|
2006-07-01 22:14:14 +00:00
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
2008-06-30 18:56:34 +00:00
|
|
|
A simple script to set up `gitweb` and a web server for browsing the local
|
2006-07-01 22:14:14 +00:00
|
|
|
repository.
|
|
|
|
|
|
|
|
|
|
OPTIONS
|
|
|
|
|
-------
|
|
|
|
|
|
2008-06-08 01:36:09 +00:00
|
|
|
-l::
|
|
|
|
|
--local::
|
2006-07-01 22:14:14 +00:00
|
|
|
Only bind the web server to the local IP (127.0.0.1).
|
|
|
|
|
|
2008-06-08 01:36:09 +00:00
|
|
|
-d::
|
|
|
|
|
--httpd::
|
2006-07-01 22:14:14 +00:00
|
|
|
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.
|
git-instaweb: Add support for running gitweb via 'plackup'
PSGI is an interface between Perl web applications and web servers, and
Plack is a Perl module and toolkit that contains PSGI middleware, helpers
and adapters to web servers; see http://plackperl.org
PSGI and Plack are inspired by Python's WSGI and Ruby's Rack (and
probably JavaScript's Jack/JSGI).
Plack core distribution includes HTTP::Server::PSGI, a reference PSGI
standalone web server implementation. 'plackup' is a command line
launcher to run PSGI applications from command line, connecting web
app to a web server via Plack::Runner module. By default it uses
HTTP::Server::PSGI as a web server.
git-instaweb generates gitweb.psgi wrapper (in $GIT_DIR/gitweb). This
wrapper uses Plack::App::WrapCGI to compile gitweb.cgi (which is a CGI
script) into a PSGI application using CGI::Compile and CGI::Emulate::PSGI.
git-instaweb then runs this wrapper, using by default HTTP::Server::PSGI
standalone Perl server, via Plack::Runner.
The configuration for 'plackup' is currently embedded in generated
gitweb.psgi wrapper, instead of using httpd.conf ($conf).
To run git-instaweb with '--httpd=plackup', you need to have instaled
Plack core, CGI::Emulate::PSGI, CGI::Compile. Those modules have to be
available for Perl scripts (which can be done for example by setting
PERL5LIB environment variable). This is currently not documented.
Signed-off-by: Jakub Narebski <jnareb@gmail.com>
Acked-by: Petr Baudis <pasky@suse.cz>
Acked-by: Eric Wong <normalperson@yhbt.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-05-28 19:11:25 +00:00
|
|
|
Currently apache2, lighttpd, mongoose, plackup and webrick are supported.
|
2006-07-01 22:14:14 +00:00
|
|
|
(Default: lighttpd)
|
|
|
|
|
|
2008-06-08 01:36:09 +00:00
|
|
|
-m::
|
|
|
|
|
--module-path::
|
2006-07-01 22:14:14 +00:00
|
|
|
The module path (only needed if httpd is Apache).
|
|
|
|
|
(Default: /usr/lib/apache2/modules)
|
|
|
|
|
|
2008-06-08 01:36:09 +00:00
|
|
|
-p::
|
|
|
|
|
--port::
|
2006-07-01 22:14:14 +00:00
|
|
|
The port number to bind the httpd to. (Default: 1234)
|
|
|
|
|
|
2008-06-08 01:36:09 +00:00
|
|
|
-b::
|
|
|
|
|
--browser::
|
2008-02-09 06:10:57 +00:00
|
|
|
The web browser that should be used to view the gitweb
|
2010-08-23 21:20:25 +00:00
|
|
|
page. This will be passed to the 'git web{litdd}browse' helper
|
2008-02-14 07:01:23 +00:00
|
|
|
script along with the URL of the gitweb instance. See
|
2010-08-23 21:20:25 +00:00
|
|
|
linkgit:git-web{litdd}browse[1] for more information about this. If
|
2008-02-14 07:01:23 +00:00
|
|
|
the script fails, the URL will be printed to stdout.
|
2006-07-01 22:14:14 +00:00
|
|
|
|
2010-08-02 18:20:38 +00:00
|
|
|
start::
|
2006-07-01 22:14:14 +00:00
|
|
|
--start::
|
2011-06-23 21:01:03 +00:00
|
|
|
Start the httpd instance and exit. Regenerate configuration files
|
|
|
|
|
as necessary for spawning a new instance.
|
2006-07-01 22:14:14 +00:00
|
|
|
|
2010-08-02 18:20:38 +00:00
|
|
|
stop::
|
2006-07-01 22:14:14 +00:00
|
|
|
--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.
|
|
|
|
|
|
2010-08-02 18:20:38 +00:00
|
|
|
restart::
|
2006-07-01 22:14:14 +00:00
|
|
|
--restart::
|
2011-06-23 21:01:03 +00:00
|
|
|
Restart the httpd instance and exit. Regenerate configuration files
|
|
|
|
|
as necessary for spawning a new instance.
|
2006-07-01 22:14:14 +00:00
|
|
|
|
|
|
|
|
CONFIGURATION
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
You may specify configuration in your .git/config
|
|
|
|
|
|
|
|
|
|
-----------------------------------------------------------------------
|
|
|
|
|
[instaweb]
|
|
|
|
|
local = true
|
|
|
|
|
httpd = apache2 -f
|
|
|
|
|
port = 4321
|
|
|
|
|
browser = konqueror
|
2015-03-11 20:32:45 +00:00
|
|
|
modulePath = /usr/lib/apache2/modules
|
2006-07-01 22:14:14 +00:00
|
|
|
|
|
|
|
|
-----------------------------------------------------------------------
|
|
|
|
|
|
2016-06-08 17:23:16 +00:00
|
|
|
If the configuration variable `instaweb.browser` is not set,
|
|
|
|
|
`web.browser` will be used instead if it is defined. See
|
2010-08-23 21:20:25 +00:00
|
|
|
linkgit:git-web{litdd}browse[1] for more information about this.
|
2008-02-09 06:10:57 +00:00
|
|
|
|
2011-10-16 11:07:33 +00:00
|
|
|
SEE ALSO
|
|
|
|
|
--------
|
|
|
|
|
linkgit:gitweb[1]
|
|
|
|
|
|
2006-07-01 22:14:14 +00:00
|
|
|
GIT
|
|
|
|
|
---
|
2008-06-06 07:07:32 +00:00
|
|
|
Part of the linkgit:git[1] suite
|