<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect2 SYSTEM "../../../dtd/dblite.dtd">

<sect2 lang="en" id="git-instaweb(1)">
    <title>git-instaweb(1)</title>
    <date>2024-07-02</date>
<revhistory><revision><date>2024-07-02</date></revision></revhistory>
<indexterm>
<primary>git-instaweb(1)</primary>
</indexterm>
<simplesect id="git-instaweb(1)__name">
<title>NAME</title>
<simpara>git-instaweb - Instantly browse your working repository in gitweb</simpara>
</simplesect>
<simplesect id="git-instaweb(1)__synopsis">
<title>SYNOPSIS</title>
<blockquote>
<literallayout><emphasis>git instaweb</emphasis> [--local] [--httpd=&lt;httpd&gt;] [--port=&lt;port&gt;]
               [--browser=&lt;browser&gt;]
<emphasis>git instaweb</emphasis> [--start] [--stop] [--restart]</literallayout>
</blockquote>
</simplesect>
<simplesect id="git-instaweb(1)__description">
<title>DESCRIPTION</title>
<simpara>A simple script to set up <emphasis>gitweb</emphasis> and a web server for browsing the local
repository.</simpara>
</simplesect>
<simplesect id="git-instaweb(1)__options">
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>
-l
</term>
<term>
--local
</term>
<listitem>
<simpara>
        Only bind the web server to the local IP (127.0.0.1).
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
-d
</term>
<term>
--httpd
</term>
<listitem>
<simpara>
        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, python and
        webrick are supported.
        (Default: lighttpd)
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
-m
</term>
<term>
--module-path
</term>
<listitem>
<simpara>
        The module path (only needed if httpd is Apache).
        (Default: /usr/lib/apache2/modules)
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
-p
</term>
<term>
--port
</term>
<listitem>
<simpara>
        The port number to bind the httpd to.  (Default: 1234)
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
-b
</term>
<term>
--browser
</term>
<listitem>
<simpara>
        The web browser that should be used to view the gitweb
        page. This will be passed to the <emphasis>git web&#45;&#45;browse</emphasis> helper
        script along with the URL of the gitweb instance. See
        <xref linkend="git-web&#45;&#45;browse(1)" /> for more information about this. If
        the script fails, the URL will be printed to stdout.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
start
</term>
<term>
--start
</term>
<listitem>
<simpara>
        Start the httpd instance and exit.  Regenerate configuration files
        as necessary for spawning a new instance.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
stop
</term>
<term>
--stop
</term>
<listitem>
<simpara>
        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.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
restart
</term>
<term>
--restart
</term>
<listitem>
<simpara>
        Restart the httpd instance and exit.  Regenerate configuration files
        as necessary for spawning a new instance.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</simplesect>
<simplesect id="git-instaweb(1)__configuration">
<title>CONFIGURATION</title>
<simpara>You may specify configuration in your .git/config</simpara>
<screen>[instaweb]
        local = true
        httpd = apache2 -f
        port = 4321
        browser = konqueror
        modulePath = /usr/lib/apache2/modules</screen>
<simpara>If the configuration variable <emphasis>instaweb.browser</emphasis> is not set,
<emphasis>web.browser</emphasis> will be used instead if it is defined. See
<xref linkend="git-web&#45;&#45;browse(1)" /> for more information about this.</simpara>
</simplesect>
<simplesect id="git-instaweb(1)__see_also">
<title>SEE ALSO</title>
<simpara><xref linkend="gitweb(1)" /></simpara>
</simplesect>
<simplesect id="git-instaweb(1)__git">
<title>GIT</title>
<simpara>Part of the <xref linkend="git(1)" /> suite</simpara>
</simplesect>
</sect2>
