1 b2c82ae2 2020-02-17 stsp <!DOCTYPE html>
3 b2c82ae2 2020-02-17 stsp <!-- This is an automatically generated file. Do not edit.
4 b2c82ae2 2020-02-17 stsp Copyright (c) 2020 Tracey Emery <tracey@traceyemery.net>
6 b2c82ae2 2020-02-17 stsp Permission to use, copy, modify, and distribute this software for any
7 b2c82ae2 2020-02-17 stsp purpose with or without fee is hereby granted, provided that the above
8 b2c82ae2 2020-02-17 stsp copyright notice and this permission notice appear in all copies.
10 b2c82ae2 2020-02-17 stsp THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 b2c82ae2 2020-02-17 stsp WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 b2c82ae2 2020-02-17 stsp MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 b2c82ae2 2020-02-17 stsp ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 b2c82ae2 2020-02-17 stsp WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 b2c82ae2 2020-02-17 stsp ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 b2c82ae2 2020-02-17 stsp OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19 b2c82ae2 2020-02-17 stsp <meta charset="utf-8"/>
21 b2c82ae2 2020-02-17 stsp table.head, table.foot { width: 100%; }
22 b2c82ae2 2020-02-17 stsp td.head-rtitle, td.foot-os { text-align: right; }
23 b2c82ae2 2020-02-17 stsp td.head-vol { text-align: center; }
24 b2c82ae2 2020-02-17 stsp .Nd, .Bf, .Op { display: inline; }
25 b2c82ae2 2020-02-17 stsp .Pa, .Ad { font-style: italic; }
26 b2c82ae2 2020-02-17 stsp .Ms { font-weight: bold; }
27 b2c82ae2 2020-02-17 stsp .Bl-diag > dt { font-weight: bold; }
28 b2c82ae2 2020-02-17 stsp code.Nm, .Fl, .Cm, .Ic, code.In, .Fd, .Fn, .Cd { font-weight: bold;
29 b2c82ae2 2020-02-17 stsp font-family: inherit; }
31 b2c82ae2 2020-02-17 stsp <title>GOTWEB.CONF(5)</title>
34 b2c82ae2 2020-02-17 stsp <table class="head">
36 b2c82ae2 2020-02-17 stsp <td class="head-ltitle">GOTWEB.CONF(5)</td>
37 b2c82ae2 2020-02-17 stsp <td class="head-vol">File Formats Manual</td>
38 b2c82ae2 2020-02-17 stsp <td class="head-rtitle">GOTWEB.CONF(5)</td>
41 b2c82ae2 2020-02-17 stsp <div class="manual-text">
42 b2c82ae2 2020-02-17 stsp <section class="Sh">
43 b2c82ae2 2020-02-17 stsp <h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
44 b2c82ae2 2020-02-17 stsp <p class="Pp"><code class="Nm">gotweb.conf</code> —
45 b2c82ae2 2020-02-17 stsp <span class="Nd">gotweb configuration file</span></p>
47 b2c82ae2 2020-02-17 stsp <section class="Sh">
48 b2c82ae2 2020-02-17 stsp <h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
49 b2c82ae2 2020-02-17 stsp <p class="Pp"><code class="Nm">gotweb.conf</code> is the run-time configuration
50 b2c82ae2 2020-02-17 stsp file for <a class="Xr">gotweb(8)</a>.</p>
51 b2c82ae2 2020-02-17 stsp <p class="Pp">The file format is line-based, with one configuration directive
52 b2c82ae2 2020-02-17 stsp per line. Any lines beginning with a ‘#’ are treated as
53 b2c82ae2 2020-02-17 stsp comments and ignored.</p>
54 b2c82ae2 2020-02-17 stsp <p class="Pp">Paths mentioned in <code class="Nm">gotweb.conf</code> must be
55 b2c82ae2 2020-02-17 stsp relative to <span class="Pa">/var/www</span>, the
56 b2c82ae2 2020-02-17 stsp <a class="Xr">chroot(2)</a> environment of <a class="Xr">httpd(8)</a>.</p>
58 b2c82ae2 2020-02-17 stsp <section class="Sh">
59 b2c82ae2 2020-02-17 stsp <h1 class="Sh" id="GLOBAL_CONFIGURATION"><a class="permalink" href="#GLOBAL_CONFIGURATION">GLOBAL
60 b2c82ae2 2020-02-17 stsp CONFIGURATION</a></h1>
61 b2c82ae2 2020-02-17 stsp <p class="Pp">The available configuration directives are as follows:</p>
62 b2c82ae2 2020-02-17 stsp <dl class="Bl-tag">
63 2dbbbc3a 2020-07-23 stsp <dt id="got_max_commits_display"><a class="permalink" href="#got_max_commits_display"><code class="Ic">got_max_commits_display</code></a>
64 b2c82ae2 2020-02-17 stsp <var class="Ar">number</var></dt>
65 b2c82ae2 2020-02-17 stsp <dd>Set the maximum amount of commits displayed per page.</dd>
66 2dbbbc3a 2020-07-23 stsp <dt id="got_logo"><a class="permalink" href="#got_logo"><code class="Ic">got_logo</code></a>
67 b2c82ae2 2020-02-17 stsp <var class="Ar">path</var></dt>
68 b2c82ae2 2020-02-17 stsp <dd>Set the path to an image file containing a logo to be displayed.</dd>
69 2dbbbc3a 2020-07-23 stsp <dt id="got_logo_url"><a class="permalink" href="#got_logo_url"><code class="Ic">got_logo_url</code></a>
70 b2c82ae2 2020-02-17 stsp <var class="Ar">url</var></dt>
71 b2c82ae2 2020-02-17 stsp <dd>Set a hyperlink for the logo.</dd>
72 2dbbbc3a 2020-07-23 stsp <dt id="got_max_repos"><a class="permalink" href="#got_max_repos"><code class="Ic">got_max_repos</code></a>
73 b2c82ae2 2020-02-17 stsp <var class="Ar">number</var></dt>
74 b2c82ae2 2020-02-17 stsp <dd>Set the maximum amount of repositories <a class="Xr">gotweb(8)</a> will
75 b2c82ae2 2020-02-17 stsp work with.</dd>
76 2dbbbc3a 2020-07-23 stsp <dt id="got_max_repos_display"><a class="permalink" href="#got_max_repos_display"><code class="Ic">got_max_repos_display</code></a>
77 b2c82ae2 2020-02-17 stsp <var class="Ar">number</var></dt>
78 b2c82ae2 2020-02-17 stsp <dd>Set the maximum amount of repositories displayed on the index screen.</dd>
79 2dbbbc3a 2020-07-23 stsp <dt id="got_show_repo_age"><a class="permalink" href="#got_show_repo_age"><code class="Ic">got_show_repo_age</code></a>
80 b2c82ae2 2020-02-17 stsp <var class="Ar">on</var> | <var class="Ar">off</var></dt>
81 b2c82ae2 2020-02-17 stsp <dd>Toggle display of last repository modification date.</dd>
82 2dbbbc3a 2020-07-23 stsp <dt id="got_show_repo_cloneurl"><a class="permalink" href="#got_show_repo_cloneurl"><code class="Ic">got_show_repo_cloneurl</code></a>
83 b2c82ae2 2020-02-17 stsp <var class="Ar">on</var> | <var class="Ar">off</var></dt>
84 b2c82ae2 2020-02-17 stsp <dd>Toggle display of clone URLs for a repository. This requires the creation
85 b2c82ae2 2020-02-17 stsp of a <span class="Pa">cloneurl</span> file inside the repository which
86 b2c82ae2 2020-02-17 stsp contains one URL per line.</dd>
87 2dbbbc3a 2020-07-23 stsp <dt id="got_show_repo_description"><a class="permalink" href="#got_show_repo_description"><code class="Ic">got_show_repo_description</code></a>
88 b2c82ae2 2020-02-17 stsp <var class="Ar">on</var> | <var class="Ar">off</var></dt>
89 b2c82ae2 2020-02-17 stsp <dd>Toggle display of the repository description. The
90 b2c82ae2 2020-02-17 stsp <span class="Pa">description</span> file in the repository should be
91 b2c82ae2 2020-02-17 stsp updated with an appropriate description.</dd>
92 2dbbbc3a 2020-07-23 stsp <dt id="got_repos_path"><a class="permalink" href="#got_repos_path"><code class="Ic">got_repos_path</code></a>
93 b2c82ae2 2020-02-17 stsp <var class="Ar">path</var></dt>
94 b2c82ae2 2020-02-17 stsp <dd>Set the path to the directory which contains Git repositories that
95 b2c82ae2 2020-02-17 stsp <a class="Xr">gotweb(8)</a> should publish.</dd>
96 2dbbbc3a 2020-07-23 stsp <dt id="got_show_repo_owner"><a class="permalink" href="#got_show_repo_owner"><code class="Ic">got_show_repo_owner</code></a>
97 b2c82ae2 2020-02-17 stsp <var class="Ar">on</var> | <var class="Ar">off</var></dt>
98 b2c82ae2 2020-02-17 stsp <dd>Set whether to display the repository owner. Displaying the owner requires
99 b2c82ae2 2020-02-17 stsp owner information to be added to the <span class="Pa">config</span> file
100 b2c82ae2 2020-02-17 stsp in the repository. <a class="Xr">gotweb(8)</a> will parse owner
101 b2c82ae2 2020-02-17 stsp information from either a [gotweb] or a [gitweb] section. For example:
102 b2c82ae2 2020-02-17 stsp <div class="Bd Pp Bd-indent">
103 1b792db0 2020-12-13 stsp <pre>[gotweb]
104 1b792db0 2020-12-13 stsp owner = "Your Name"</pre>
107 2dbbbc3a 2020-07-23 stsp <dt id="got_site_link"><a class="permalink" href="#got_site_link"><code class="Ic">got_site_link</code></a>
108 b2c82ae2 2020-02-17 stsp <var class="Ar">string</var></dt>
109 b2c82ae2 2020-02-17 stsp <dd>Set the displayed site link name for the index page.</dd>
110 2dbbbc3a 2020-07-23 stsp <dt id="got_site_name"><a class="permalink" href="#got_site_name"><code class="Ic">got_site_name</code></a>
111 b2c82ae2 2020-02-17 stsp <var class="Ar">string</var></dt>
112 b2c82ae2 2020-02-17 stsp <dd>Set the displayed site name title.</dd>
113 2dbbbc3a 2020-07-23 stsp <dt id="got_site_owner"><a class="permalink" href="#got_site_owner"><code class="Ic">got_site_owner</code></a>
114 b2c82ae2 2020-02-17 stsp <var class="Ar">string</var></dt>
115 b2c82ae2 2020-02-17 stsp <dd>Set the displayed site owner.</dd>
116 2dbbbc3a 2020-07-23 stsp <dt id="got_show_site_owner"><a class="permalink" href="#got_show_site_owner"><code class="Ic">got_show_site_owner</code></a>
117 b2c82ae2 2020-02-17 stsp <var class="Ar">on</var> | <var class="Ar">off</var></dt>
118 b2c82ae2 2020-02-17 stsp <dd>Toggle display of the site owner.</dd>
119 f2e17eed 2020-11-14 stsp <dt id="got_www_path"><a class="permalink" href="#got_www_path"><code class="Ic">got_www_path</code></a>
120 f2e17eed 2020-11-14 stsp <var class="Ar">string</var></dt>
121 f2e17eed 2020-11-14 stsp <dd>Set the public gotweb httpd path.</dd>
124 b2c82ae2 2020-02-17 stsp <section class="Sh">
125 b2c82ae2 2020-02-17 stsp <h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1>
126 b2c82ae2 2020-02-17 stsp <p class="Pp">These are the currently configurable items for
127 b2c82ae2 2020-02-17 stsp <a class="Xr">gotweb(8)</a> with their default values.</p>
128 b2c82ae2 2020-02-17 stsp <div class="Bd Pp Bd-indent">
131 b2c82ae2 2020-02-17 stsp # gotweb options
132 b2c82ae2 2020-02-17 stsp # all paths relative to /var/www (httpd chroot jail)
135 b2c82ae2 2020-02-17 stsp got_repos_path "/got/public"
136 f2e17eed 2020-11-14 stsp got_www_path "/gotweb"
138 b2c82ae2 2020-02-17 stsp #got_max_repos 100
139 b2c82ae2 2020-02-17 stsp #got_max_repos_display 25
140 b2c82ae2 2020-02-17 stsp got_max_commits_display 50
142 b2c82ae2 2020-02-17 stsp got_site_name "my public repos"
143 b2c82ae2 2020-02-17 stsp got_site_owner "Got Owner"
144 b2c82ae2 2020-02-17 stsp got_site_link "repos"
146 b2c82ae2 2020-02-17 stsp got_logo "got.png"
147 b2c82ae2 2020-02-17 stsp got_logo_url "https://gameoftrees.org"
149 b2c82ae2 2020-02-17 stsp # on by default
150 b2c82ae2 2020-02-17 stsp #got_show_site_owner off
151 b2c82ae2 2020-02-17 stsp #got_show_repo_owner off
152 b2c82ae2 2020-02-17 stsp #got_show_repo_age false
153 b2c82ae2 2020-02-17 stsp #got_show_repo_description no
154 1b792db0 2020-12-13 stsp #got_show_repo_cloneurl off</pre>
157 b2c82ae2 2020-02-17 stsp <section class="Sh">
158 b2c82ae2 2020-02-17 stsp <h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1>
159 b2c82ae2 2020-02-17 stsp <dl class="Bl-tag Bl-compact">
160 b2c82ae2 2020-02-17 stsp <dt><span class="Pa">/var/www/etc/gotweb.conf</span></dt>
161 b2c82ae2 2020-02-17 stsp <dd>Location of the <code class="Nm">gotweb.conf</code> configuration
165 b2c82ae2 2020-02-17 stsp <section class="Sh">
166 b2c82ae2 2020-02-17 stsp <h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
167 b2c82ae2 2020-02-17 stsp ALSO</a></h1>
168 b2c82ae2 2020-02-17 stsp <p class="Pp"><a class="Xr">got(1)</a>, <a class="Xr">gotweb(8)</a></p>
171 b2c82ae2 2020-02-17 stsp <table class="foot">
173 1b792db0 2020-12-13 stsp <td class="foot-date">December 13, 2020</td>
174 f2e17eed 2020-11-14 stsp <td class="foot-os">OpenBSD 6.8</td>