Blob


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