Allow disabling of HTTP clone URLs

[ps-cgit] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index ec004d42cfb3de2832c393b09295a73d215d189b..b8c69b893ec5c1b5255274dd69ff1d972878f43f 100644 (file)
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -95,6 +95,16 @@ enable-filter-overrides::
        Flag which, when set to "1", allows all filter settings to be
        overridden in repository-specific cgitrc files. Default value: none.
 
        Flag which, when set to "1", allows all filter settings to be
        overridden in repository-specific cgitrc files. Default value: none.
 

+enable-gitweb-owner::
+       If set to "1" and scan-path is enabled, we first check each repository
+       for the git config value "gitweb.owner" to determine the owner.
+       Default value: "1". See also: scan-path.
+
+enable-http-clone::
+       If set to "1", cgit will act as an dumb HTTP endpoint for git clones.
+       If you use an alternate way of serving git repositories, you may wish
+       to disable this. Default value: "1".
+

 enable-index-links::
        Flag which, when set to "1", will make cgit generate extra links for
        each repo in the repository index (specifically, to the "summary",
 enable-index-links::
        Flag which, when set to "1", will make cgit generate extra links for
        each repo in the repository index (specifically, to the "summary",


@@ -229,6 +239,15 @@ project-list::
        should loaded as git repositories. This must be defined prior to
        scan-path. Default value: none. See also: scan-path.
 
        should loaded as git repositories. This must be defined prior to
        scan-path. Default value: none. See also: scan-path.
 

+readme::
+       Text which will be used as default value for "repo.readme". Default
+       value: none.
+
+remove-suffix::
+       If set to "1" and scan-path is enabled, if any repositories are found
+       with a suffix of ".git", this suffix will be removed for the url and
+       name. Default value: "0". See also: scan-path.
+

 renamelimit::
        Maximum number of files to consider when detecting renames. The value
         "-1" uses the compiletime value in git (for further info, look at
 renamelimit::
        Maximum number of files to consider when detecting renames. The value
         "-1" uses the compiletime value in git (for further info, look at


@@ -268,6 +287,12 @@ section::
        after this option will inherit the current section name. Default value:
        none.
 
        after this option will inherit the current section name. Default value:
        none.
 

+section-from-path::
+       A number which, if specified before scan-path, specifies how many
+       path elements from each repo path to use as a default section name.
+       If negative, cgit will discard the specified number of path elements
+       above the repo directory. Default value: 0.
+

 side-by-side-diffs::
        If set to "1" shows side-by-side diffs instead of unidiffs per
        default. Default value: "0".
 side-by-side-diffs::
        If set to "1" shows side-by-side diffs instead of unidiffs per
        default. Default value: "0".


@@ -297,6 +322,13 @@ summary-tags::
        Specifies the number of tags to display in the repository "summary"
        view. Default value: "10".
 
        Specifies the number of tags to display in the repository "summary"
        view. Default value: "10".
 

+strict-export::
+       Filename which, if specified, needs to be present within the repository
+       for cgit to allow access to that repository. This can be used to emulate
+       gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's
+       repositories to match those exported by git-daemon. This option MUST come
+       before 'scan-path'.
+

 virtual-root::
        Url which, if specified, will be used as root for all cgit links. It
        will also cause cgit to generate 'virtual urls', i.e. urls like
 virtual-root::
        Url which, if specified, will be used as root for all cgit links. It
        will also cause cgit to generate 'virtual urls', i.e. urls like


@@ -361,7 +393,9 @@ repo.path::
 
 repo.readme::
        A path (relative to <repo.path>) which specifies a file to include
 
 repo.readme::
        A path (relative to <repo.path>) which specifies a file to include

-       verbatim as the "About" page for this repo. Default value: none.
+       verbatim as the "About" page for this repo. You may also specify a
+       git refspec by head or by hash by prepending the refspec followed by
+       a colon. For example, "master:docs/readme.mkd" Default value: <readme>.

 
 repo.snapshots::
        A mask of allowed snapshot-formats for this repo, restricted by the
 
 repo.snapshots::
        A mask of allowed snapshot-formats for this repo, restricted by the


@@ -402,7 +436,7 @@ cache-size=1000
 
 
 # Specify some default clone prefixes
 
 
 # Specify some default clone prefixes

-clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git
+clone-prefix=git://example.com ssh://example.com/pub/git http://example.com/git

 
 # Specify the css url
 css=/css/cgit.css
 
 # Specify the css url
 css=/css/cgit.css


@@ -433,14 +467,14 @@ max-stats=quarter
 
 
 # Set the title and heading of the repository index page
 
 
 # Set the title and heading of the repository index page

-root-title=foobar.com git repositories
+root-title=example.com git repositories

 
 
 # Set a subheading for the repository index page
 root-desc=tracking the foobar development
 
 
 
 
 # Set a subheading for the repository index page
 root-desc=tracking the foobar development
 
 

-# Include some more info about foobar.com on the index page
+# Include some more info about example.com on the index page

 root-readme=/var/www/htdocs/about.html
 
 
 root-readme=/var/www/htdocs/about.html
 
 


@@ -474,14 +508,14 @@ mimetype.svg=image/svg+xml
 repo.url=foo
 repo.path=/pub/git/foo.git
 repo.desc=the master foo repository
 repo.url=foo
 repo.path=/pub/git/foo.git
 repo.desc=the master foo repository

-repo.owner=fooman@foobar.com
+repo.owner=fooman@example.com

 repo.readme=info/web/about.html
 
 
 repo.url=bar
 repo.path=/pub/git/bar.git
 repo.desc=the bars for your foo
 repo.readme=info/web/about.html
 
 
 repo.url=bar
 repo.path=/pub/git/bar.git
 repo.desc=the bars for your foo

-repo.owner=barman@foobar.com
+repo.owner=barman@example.com

 repo.readme=info/web/about.html
 
 
 repo.readme=info/web/about.html
 
 


@@ -538,3 +572,4 @@ will generate the following html element:
 AUTHOR
 ------
 Lars Hjemli <hjemli@gmail.com>
 AUTHOR
 ------
 Lars Hjemli <hjemli@gmail.com>

+Jason A. Donenfeld <Jason@zx2c4.com>