2 0f97c5ad 2020-01-15 tracey .\" Copyright (c) 2020 Tracey Emery <tracey@traceyemery.net>
4 0f97c5ad 2020-01-15 tracey .\" Permission to use, copy, modify, and distribute this software for any
5 0f97c5ad 2020-01-15 tracey .\" purpose with or without fee is hereby granted, provided that the above
6 0f97c5ad 2020-01-15 tracey .\" copyright notice and this permission notice appear in all copies.
8 0f97c5ad 2020-01-15 tracey .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 0f97c5ad 2020-01-15 tracey .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 0f97c5ad 2020-01-15 tracey .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 0f97c5ad 2020-01-15 tracey .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 0f97c5ad 2020-01-15 tracey .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 0f97c5ad 2020-01-15 tracey .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 0f97c5ad 2020-01-15 tracey .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 0f97c5ad 2020-01-15 tracey .Dd $Mdocdate: January 15 2020 $
17 0f97c5ad 2020-01-15 tracey .Dt GOTWEB.CONF 5
20 0f97c5ad 2020-01-15 tracey .Nm gotweb.conf
21 0f97c5ad 2020-01-15 tracey .Nd gotweb configuration file
22 0f97c5ad 2020-01-15 tracey .Sh DESCRIPTION
24 0f97c5ad 2020-01-15 tracey is the configuration file for gotweb.
25 0f97c5ad 2020-01-15 tracey .Sh GLOBAL CONFIGURATION
26 0f97c5ad 2020-01-15 tracey Here are the settings that can be set globally:
27 0f97c5ad 2020-01-15 tracey .Bl -tag -width Ds
28 87db323e 2020-01-15 tracey .It Ic got_commits_display Ar number
29 0f97c5ad 2020-01-15 tracey Set the maximum amount of log lines displayed.
30 0f97c5ad 2020-01-15 tracey .It Ic got_logo Ar string
31 0f97c5ad 2020-01-15 tracey Set the displayed logo.
32 0f97c5ad 2020-01-15 tracey .It Ic got_logo_url Ar string
33 0f97c5ad 2020-01-15 tracey Set the href link for the logo.
34 87db323e 2020-01-15 tracey .It Ic got_max_repos Ar number
35 87db323e 2020-01-15 tracey Set the maximum amount of repositories gotweb will work with.
36 87db323e 2020-01-15 tracey .It Ic got_max_repos_display Ar number
37 87db323e 2020-01-15 tracey Set the maximum amount of repositories displayed on the index screen.
38 0f97c5ad 2020-01-15 tracey .It Ic got_repo_age Ar string
39 0f97c5ad 2020-01-15 tracey Set whether to display the repository age, or not.
40 0f97c5ad 2020-01-15 tracey .It Ic got_repo_cloneurl Ar string
41 0f97c5ad 2020-01-15 tracey Set whether to display clone URLs for a repository.
42 0f97c5ad 2020-01-15 tracey This requires the creation of a cloneurl file in the repository.
43 87db323e 2020-01-15 tracey .It Ic got_repo_description Ar string
44 87db323e 2020-01-15 tracey Set whether to display the repository description, or not.
45 87db323e 2020-01-15 tracey This requires the description file to be edited in the repository.
46 87db323e 2020-01-15 tracey .It Ic got_repos_path Ar string
47 87db323e 2020-01-15 tracey Set the default git repository path.
48 87db323e 2020-01-15 tracey .It Ic got_repo_owner Ar string
49 87db323e 2020-01-15 tracey Set whether to display the repository owner, or not.
50 87db323e 2020-01-15 tracey This requires the owner to be added to the config file in the repository.
51 87db323e 2020-01-15 tracey The gotweb code will parse either [gotweb] or [gitweb] owner information.
52 87db323e 2020-01-15 tracey For example:
53 87db323e 2020-01-15 tracey .Bd -literal -offset indent
55 87db323e 2020-01-15 tracey owner = "Your Name"
57 87db323e 2020-01-15 tracey .It Ic got_site_link Ar string
58 87db323e 2020-01-15 tracey Set the displayed site link name for the index page.
59 87db323e 2020-01-15 tracey .It Ic got_site_name Ar string
60 87db323e 2020-01-15 tracey Set the displayed site name title.
61 87db323e 2020-01-15 tracey .It Ic got_site_owner Ar string
62 87db323e 2020-01-15 tracey Set the displayed site owner.
63 87db323e 2020-01-15 tracey .It Ic got_show_site_owner Ar string
64 87db323e 2020-01-15 tracey Set whether to display the site owner, or not.
65 87db323e 2020-01-15 tracey .It Ic got_www_path Ar string
66 87db323e 2020-01-15 tracey Set the public gotweb httpd path.
68 add40c4f 2020-01-15 tracey .Sh EXAMPLES
69 add40c4f 2020-01-15 tracey These are the currently configurable items for Gotweb.
70 add40c4f 2020-01-15 tracey The configuration file gotweb.conf must be located at /var/www/etc/gotweb.conf.
71 add40c4f 2020-01-15 tracey .Bd -literal -offset indent
74 add40c4f 2020-01-15 tracey # gotweb options
75 add40c4f 2020-01-15 tracey # all paths relative to /var/www (httpd chroot jail)
78 add40c4f 2020-01-15 tracey got_repos_path "/got/public"
79 add40c4f 2020-01-15 tracey got_www_path "/gotweb"
81 add40c4f 2020-01-15 tracey #got_max_repos 100
82 add40c4f 2020-01-15 tracey #got_max_repos_display 25
83 add40c4f 2020-01-15 tracey got_max_commits_display 50
85 add40c4f 2020-01-15 tracey got_site_name "my public repos"
86 add40c4f 2020-01-15 tracey got_site_owner "Got Owner"
87 add40c4f 2020-01-15 tracey got_site_link "repos"
89 add40c4f 2020-01-15 tracey got_logo "got.png"
90 add40c4f 2020-01-15 tracey got_logo_url "https://gameoftrees.org"
92 add40c4f 2020-01-15 tracey # on by default
93 add40c4f 2020-01-15 tracey #got_show_site_owner off
94 add40c4f 2020-01-15 tracey #got_show_repo_owner off
95 add40c4f 2020-01-15 tracey #got_show_repo_age false
96 add40c4f 2020-01-15 tracey #got_show_repo_description no
97 add40c4f 2020-01-15 tracey #got_show_repo_cloneurl off
100 0f97c5ad 2020-01-15 tracey .Bl -tag -width Ds -compact
101 0f97c5ad 2020-01-15 tracey .It Pa /var/www/etc/gotweb.conf
102 0f97c5ad 2020-01-15 tracey gotweb configuration file.
104 0f97c5ad 2020-01-15 tracey .Sh SEE ALSO
105 0f97c5ad 2020-01-15 tracey .Xr got 1 ,
106 0f97c5ad 2020-01-15 tracey .Xr tog 1
107 0f97c5ad 2020-01-15 tracey .Sh HISTORY
110 0f97c5ad 2020-01-15 tracey file format first appeared in
111 0f97c5ad 2020-01-15 tracey .Ox 6.7 .
