.\" Automatically generated by Pandoc 3.1.8
.\"
.TH "RGITRC" "5" "16 December 2023" "version 0.1.2" "rgit Configuration"
.SH NAME
rgitrc - runtime configuration for rgit
.SH SYNOPSIS
\f[CR]rgitrc\f[R] contains all runtime settings for rgit, formatted as a
line-separated list of \f[CR]NAME = VALUE\f[R] pairs.
Blank lines, and lines starting with \f[I]#\f[R], are ignored.
.SH LOCATION
The default location of \f[CR]rgitrc\f[R], defined at compile time, is
\f[CR]/etc/rgitrc\f[R].
At runtime, rgit will consult the \f[CR]--config\f[R] option and use its
value.
.SH GLOBAL SETTINGS
.TP
\f[B]clone_prefix\f[R]
Specifies the URL to prepend to clone urls.
.RS
.PP
If unset and \f[CR]enable_http_clone\f[R] is enabled, the clone url will
not be displayed.
.PP
Default value: unset
.PP
See also: \f[CR]enable_http_clone\f[R], \f[CR]ssh_clone_prefix\f[R]
.RE
.TP
\f[B]css\f[R]
Specifies an absolute path on the filesystem to the css document to
include in all pages.
.RS
.PP
If set, the default stylesheet will replaced with this one.
.PP
Default value: None
.RE
.TP
\f[B]enable_http_clone\f[R]
If set to \f[I]true\f[R], rgit will act as a dumb HTTP endpoint for git
clones.
.RS
.PP
If unset, this will also hide clone urls from repository pages.
.PP
If the git binary is not present, this will be forced to
\f[I]false\f[R].
.PP
Default value: true
.PP
See also: \f[CR]clone_prefix\f[R], \f[CR]ssh_clone_prefix\f[R]
.RE
.TP
\f[B]enable_index_links\f[R]
When set to \f[I]true\f[R], rgit will display a column with extra links
for each repo in the repository index (specifically, to the
\[lq]summary\[rq], \[lq]commit\[rq], and \[lq]tree\[rq] pages).
.RS
.PP
Default value: false
.RE
.TP
\f[B]enable_index_owner\f[R]
When set to \f[I]true\f[R], rgit will display a column with the name of
each repo\[cq]s owner in the repository index.
.RS
.PP
Default value: true
.RE
.TP
\f[B]favicon\f[R]
Specifies an absolute path on the filesystem to a shortcut icon for
rgit.
.RS
.PP
This will be served as \f[I]/favicon.ico\f[R] since certain browsers
will ignore other values.
.PP
Default value: unset
.RE
.TP
\f[B]logo\f[R] \  \ 
Specifies an absolute path on the filesystem to a logo image which will
be used as a logo on all rgit pages.
.RS
.PP
If unset, the image will be replaced with text, and \f[CR]logo_alt\f[R]
will be used instead.
.PP
Default value: unset
.PP
See also: \f[CR]logo_alt\f[R], \f[CR]logo_link\f[R]
.RE
.TP
\f[B]logo_alt\f[R]
Specifies \f[CR]alt\f[R] for the logo image.
.RS
.PP
If \f[CR]logo\f[R] is unset, this value will be printed instead of an
\f[CR]<img>\f[R] attribute.
.PP
Default value: \[lq]🏡\[rq]
.PP
See also: \f[CR]logo\f[R], \f[CR]logo_link\f[R]
.RE
.TP
\f[B]logo_link\f[R]
Url loaded when clicking on the logo image.
.RS
.PP
If unspecified the calculated url of the repository index page will be
used.
.PP
Default value: \[lq]/\[rq]
.PP
See also: \f[CR]logo\f[R], \f[CR]logo_alt\f[R]
.RE
.TP
\f[B]max_commit_message_length\f[R]
Specifies the maximum number of commit message characters to display in
\[lq]log\[rq] view.
.RS
.PP
If unset or set to \[lq]0\[rq], commit messages will not be truncated.
.PP
Default value: \[lq]0\[rq]
.RE
.TP
\f[B]max_repo_desc_length\f[R]
Specifies the maximum number of description characters to display on the
repository index page.
.RS
.PP
If unset or set to \[lq]0\[rq], repository descriptions will not be
truncated.
.PP
Default value: \[lq]0\[rq]
.RE
.TP
\f[B]robots_txt\f[R]
Specifies an absolute path on the filesystem to the file to serve at
\f[CR]/robots.txt\f[R].
.RS
.PP
If set, the default \f[CR]robots.txt\f[R] will replaced with this one.
.PP
Default value: None
.RE
.TP
\f[B]root_description\f[R]
Text printed below the heading (\f[CR]root_title\f[R]) on the repository
index page.
.RS
.PP
Default value: unset
.PP
See also: \f[CR]root_title\f[R]
.RE
.TP
\f[B]root_readme\f[R]
The content of the file specified with this option will be rendered from
markdown to html below the \[lq]about\[rq] link on the repository index
page.
.RS
.PP
Default value: unset
.RE
.TP
\f[B]root_title\f[R]
Text printed as a heading on the repository index page.
.RS
.PP
Default value: \[lq]Git repository browser\[rq]
.RE
.TP
\f[B]snapshots\f[R]
Array which specifies the default set of snapshot formats that rgit
displays links for.
.RS
.PP
The value is a comma-separated array of zero or more of the following
values:
.PP
[\[lq]\f[CR]tar\f[R]\[rq], \[lq]\f[CR]tar.gz\f[R]\[rq],
\[lq]\f[CR]tar.bz2\f[R]\[rq], \[lq]\f[CR]tar.lz\f[R]\[rq],
\[lq]\f[CR]tar.xz\f[R]\[rq], \[lq]\f[CR]tar.zst\f[R]\[rq],
\[lq]\f[CR]zip\f[R]\[rq], \[lq]\f[CR]all\f[R]\[rq]]
.PP
The value \[lq]all\[rq] enables all snapshot formats.
.PP
All compressors use default settings, and some settings can be
influenced with environment variables.
Refer to the manual for \f[CR]tar\f[R](1) and \f[CR]zip\f[R](1L) for
more information.
.PP
Default value: [\[lq]\f[CR]tar.gz\f[R]\[rq],
\[lq]\f[CR]tar.bz2\f[R]\[rq], \[lq]\f[CR]zip\f[R]\[rq]]
.PP
See also: \f[CR]tar\f[R](1) \f[CR]zip\f[R](1L)
.RE
.TP
\f[B]ssh_clone_prefix\f[R]
Specifies the URL to prepend to ssh clone urls.
.RS
.PP
If unset and \f[CR]enable_http_clone\f[R] is enabled, the ssh clone url
will not be displayed.
.PP
Default value: none
.PP
See also: \f[CR]clone_prefix\f[R], \f[CR]enable_http_clone\f[R]
.RE
.SH BUGS
https://github.com/w4/rgit/issues
.SH AUTHORS
Jordan Doyle <REDACTED>
.SH REPOSITORY
https://git.inept.dev/\[ti]doyle/rgit.git
.PP
https://github.com/w4/rgit