Blame


1 b2c82ae2 2020-02-17 stsp <!DOCTYPE html>
2 b2c82ae2 2020-02-17 stsp <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>
5 b2c82ae2 2020-02-17 stsp
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.
9 b2c82ae2 2020-02-17 stsp
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.
17 b2c82ae2 2020-02-17 stsp -->
18 b2c82ae2 2020-02-17 stsp <head>
19 b2c82ae2 2020-02-17 stsp <meta charset="utf-8"/>
20 a954aa0a 2021-06-22 stsp <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
21 5ca479d6 2021-11-21 stsp <link rel="stylesheet" href="mandoc.css" type="text/css" media="all"/>
22 b2c82ae2 2020-02-17 stsp <title>GOTWEB.CONF(5)</title>
23 b2c82ae2 2020-02-17 stsp </head>
24 b2c82ae2 2020-02-17 stsp <body>
25 b2c82ae2 2020-02-17 stsp <table class="head">
26 b2c82ae2 2020-02-17 stsp <tr>
27 b2c82ae2 2020-02-17 stsp <td class="head-ltitle">GOTWEB.CONF(5)</td>
28 b2c82ae2 2020-02-17 stsp <td class="head-vol">File Formats Manual</td>
29 b2c82ae2 2020-02-17 stsp <td class="head-rtitle">GOTWEB.CONF(5)</td>
30 b2c82ae2 2020-02-17 stsp </tr>
31 b2c82ae2 2020-02-17 stsp </table>
32 b2c82ae2 2020-02-17 stsp <div class="manual-text">
33 b2c82ae2 2020-02-17 stsp <section class="Sh">
34 b2c82ae2 2020-02-17 stsp <h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
35 b2c82ae2 2020-02-17 stsp <p class="Pp"><code class="Nm">gotweb.conf</code> &#x2014;
36 b2c82ae2 2020-02-17 stsp <span class="Nd">gotweb configuration file</span></p>
37 b2c82ae2 2020-02-17 stsp </section>
38 b2c82ae2 2020-02-17 stsp <section class="Sh">
39 b2c82ae2 2020-02-17 stsp <h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
40 b2c82ae2 2020-02-17 stsp <p class="Pp"><code class="Nm">gotweb.conf</code> is the run-time configuration
41 b2c82ae2 2020-02-17 stsp file for <a class="Xr">gotweb(8)</a>.</p>
42 b2c82ae2 2020-02-17 stsp <p class="Pp">The file format is line-based, with one configuration directive
43 b2c82ae2 2020-02-17 stsp per line. Any lines beginning with a &#x2018;#&#x2019; are treated as
44 b2c82ae2 2020-02-17 stsp comments and ignored.</p>
45 b2c82ae2 2020-02-17 stsp <p class="Pp">Paths mentioned in <code class="Nm">gotweb.conf</code> must be
46 b2c82ae2 2020-02-17 stsp relative to <span class="Pa">/var/www</span>, the
47 b2c82ae2 2020-02-17 stsp <a class="Xr">chroot(2)</a> environment of <a class="Xr">httpd(8)</a>.</p>
48 b2c82ae2 2020-02-17 stsp </section>
49 b2c82ae2 2020-02-17 stsp <section class="Sh">
50 b2c82ae2 2020-02-17 stsp <h1 class="Sh" id="GLOBAL_CONFIGURATION"><a class="permalink" href="#GLOBAL_CONFIGURATION">GLOBAL
51 b2c82ae2 2020-02-17 stsp CONFIGURATION</a></h1>
52 b2c82ae2 2020-02-17 stsp <p class="Pp">The available configuration directives are as follows:</p>
53 b2c82ae2 2020-02-17 stsp <dl class="Bl-tag">
54 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>
55 b2c82ae2 2020-02-17 stsp <var class="Ar">number</var></dt>
56 b2c82ae2 2020-02-17 stsp <dd>Set the maximum amount of commits displayed per page.</dd>
57 2dbbbc3a 2020-07-23 stsp <dt id="got_logo"><a class="permalink" href="#got_logo"><code class="Ic">got_logo</code></a>
58 b2c82ae2 2020-02-17 stsp <var class="Ar">path</var></dt>
59 b2c82ae2 2020-02-17 stsp <dd>Set the path to an image file containing a logo to be displayed.</dd>
60 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>
61 b2c82ae2 2020-02-17 stsp <var class="Ar">url</var></dt>
62 b2c82ae2 2020-02-17 stsp <dd>Set a hyperlink for the logo.</dd>
63 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>
64 b2c82ae2 2020-02-17 stsp <var class="Ar">number</var></dt>
65 b2c82ae2 2020-02-17 stsp <dd>Set the maximum amount of repositories <a class="Xr">gotweb(8)</a> will
66 b2c82ae2 2020-02-17 stsp work with.</dd>
67 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>
68 b2c82ae2 2020-02-17 stsp <var class="Ar">number</var></dt>
69 b2c82ae2 2020-02-17 stsp <dd>Set the maximum amount of repositories displayed on the index screen.</dd>
70 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>
71 b2c82ae2 2020-02-17 stsp <var class="Ar">on</var> | <var class="Ar">off</var></dt>
72 b2c82ae2 2020-02-17 stsp <dd>Toggle display of last repository modification date.</dd>
73 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>
74 b2c82ae2 2020-02-17 stsp <var class="Ar">on</var> | <var class="Ar">off</var></dt>
75 b2c82ae2 2020-02-17 stsp <dd>Toggle display of clone URLs for a repository. This requires the creation
76 b2c82ae2 2020-02-17 stsp of a <span class="Pa">cloneurl</span> file inside the repository which
77 b2c82ae2 2020-02-17 stsp contains one URL per line.</dd>
78 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>
79 b2c82ae2 2020-02-17 stsp <var class="Ar">on</var> | <var class="Ar">off</var></dt>
80 b2c82ae2 2020-02-17 stsp <dd>Toggle display of the repository description. The
81 b2c82ae2 2020-02-17 stsp <span class="Pa">description</span> file in the repository should be
82 b2c82ae2 2020-02-17 stsp updated with an appropriate description.</dd>
83 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>
84 b2c82ae2 2020-02-17 stsp <var class="Ar">path</var></dt>
85 b2c82ae2 2020-02-17 stsp <dd>Set the path to the directory which contains Git repositories that
86 b2c82ae2 2020-02-17 stsp <a class="Xr">gotweb(8)</a> should publish.</dd>
87 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>
88 b2c82ae2 2020-02-17 stsp <var class="Ar">on</var> | <var class="Ar">off</var></dt>
89 b2c82ae2 2020-02-17 stsp <dd>Set whether to display the repository owner. Displaying the owner requires
90 b2c82ae2 2020-02-17 stsp owner information to be added to the <span class="Pa">config</span> file
91 b2c82ae2 2020-02-17 stsp in the repository. <a class="Xr">gotweb(8)</a> will parse owner
92 b2c82ae2 2020-02-17 stsp information from either a [gotweb] or a [gitweb] section. For example:
93 a954aa0a 2021-06-22 stsp <div class="Bd Pp Bd-indent Li">
94 a954aa0a 2021-06-22 stsp <pre>[gotweb]
95 a954aa0a 2021-06-22 stsp owner = &quot;Your Name&quot;</pre>
96 b2c82ae2 2020-02-17 stsp </div>
97 b2c82ae2 2020-02-17 stsp </dd>
98 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>
99 b2c82ae2 2020-02-17 stsp <var class="Ar">string</var></dt>
100 b2c82ae2 2020-02-17 stsp <dd>Set the displayed site link name for the index page.</dd>
101 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>
102 b2c82ae2 2020-02-17 stsp <var class="Ar">string</var></dt>
103 b2c82ae2 2020-02-17 stsp <dd>Set the displayed site name title.</dd>
104 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>
105 b2c82ae2 2020-02-17 stsp <var class="Ar">string</var></dt>
106 b2c82ae2 2020-02-17 stsp <dd>Set the displayed site owner.</dd>
107 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>
108 b2c82ae2 2020-02-17 stsp <var class="Ar">on</var> | <var class="Ar">off</var></dt>
109 b2c82ae2 2020-02-17 stsp <dd>Toggle display of the site owner.</dd>
110 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>
111 f2e17eed 2020-11-14 stsp <var class="Ar">string</var></dt>
112 f2e17eed 2020-11-14 stsp <dd>Set the public gotweb httpd path.</dd>
113 b2c82ae2 2020-02-17 stsp </dl>
114 b2c82ae2 2020-02-17 stsp </section>
115 b2c82ae2 2020-02-17 stsp <section class="Sh">
116 b2c82ae2 2020-02-17 stsp <h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1>
117 b2c82ae2 2020-02-17 stsp <p class="Pp">These are the currently configurable items for
118 b2c82ae2 2020-02-17 stsp <a class="Xr">gotweb(8)</a> with their default values.</p>
119 a954aa0a 2021-06-22 stsp <div class="Bd Pp Bd-indent Li">
120 b2c82ae2 2020-02-17 stsp <pre>
121 b2c82ae2 2020-02-17 stsp #
122 b2c82ae2 2020-02-17 stsp # gotweb options
123 b2c82ae2 2020-02-17 stsp # all paths relative to /var/www (httpd chroot jail)
124 b2c82ae2 2020-02-17 stsp #
125 b2c82ae2 2020-02-17 stsp
126 b2c82ae2 2020-02-17 stsp got_repos_path &quot;/got/public&quot;
127 f2e17eed 2020-11-14 stsp got_www_path &quot;/gotweb&quot;
128 b2c82ae2 2020-02-17 stsp
129 b2c82ae2 2020-02-17 stsp #got_max_repos 100
130 b2c82ae2 2020-02-17 stsp #got_max_repos_display 25
131 b2c82ae2 2020-02-17 stsp got_max_commits_display 50
132 b2c82ae2 2020-02-17 stsp
133 b2c82ae2 2020-02-17 stsp got_site_name &quot;my public repos&quot;
134 b2c82ae2 2020-02-17 stsp got_site_owner &quot;Got Owner&quot;
135 b2c82ae2 2020-02-17 stsp got_site_link &quot;repos&quot;
136 b2c82ae2 2020-02-17 stsp
137 b2c82ae2 2020-02-17 stsp got_logo &quot;got.png&quot;
138 b2c82ae2 2020-02-17 stsp got_logo_url &quot;https://gameoftrees.org&quot;
139 b2c82ae2 2020-02-17 stsp
140 b2c82ae2 2020-02-17 stsp # on by default
141 b2c82ae2 2020-02-17 stsp #got_show_site_owner off
142 b2c82ae2 2020-02-17 stsp #got_show_repo_owner off
143 b2c82ae2 2020-02-17 stsp #got_show_repo_age false
144 b2c82ae2 2020-02-17 stsp #got_show_repo_description no
145 a954aa0a 2021-06-22 stsp #got_show_repo_cloneurl off</pre>
146 b2c82ae2 2020-02-17 stsp </div>
147 b2c82ae2 2020-02-17 stsp </section>
148 b2c82ae2 2020-02-17 stsp <section class="Sh">
149 b2c82ae2 2020-02-17 stsp <h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1>
150 b2c82ae2 2020-02-17 stsp <dl class="Bl-tag Bl-compact">
151 b2c82ae2 2020-02-17 stsp <dt><span class="Pa">/var/www/etc/gotweb.conf</span></dt>
152 b2c82ae2 2020-02-17 stsp <dd>Location of the <code class="Nm">gotweb.conf</code> configuration
153 b2c82ae2 2020-02-17 stsp file.</dd>
154 b2c82ae2 2020-02-17 stsp </dl>
155 b2c82ae2 2020-02-17 stsp </section>
156 b2c82ae2 2020-02-17 stsp <section class="Sh">
157 b2c82ae2 2020-02-17 stsp <h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
158 b2c82ae2 2020-02-17 stsp ALSO</a></h1>
159 b2c82ae2 2020-02-17 stsp <p class="Pp"><a class="Xr">got(1)</a>, <a class="Xr">gotweb(8)</a></p>
160 b2c82ae2 2020-02-17 stsp </section>
161 b2c82ae2 2020-02-17 stsp </div>
162 b2c82ae2 2020-02-17 stsp <table class="foot">
163 b2c82ae2 2020-02-17 stsp <tr>
164 03b138b5 2022-05-10 stsp <td class="foot-date">May 10, 2022</td>
165 15ba8349 2022-04-24 stsp <td class="foot-os">OpenBSD 7.1</td>
166 b2c82ae2 2020-02-17 stsp </tr>
167 b2c82ae2 2020-02-17 stsp </table>
168 b2c82ae2 2020-02-17 stsp </body>
169 b2c82ae2 2020-02-17 stsp </html>