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 010fe6f0 2020-04-25 stsp .Dd $Mdocdate$
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 dcc182c0 2020-01-28 stsp is the run-time configuration file for
25 dcc182c0 2020-01-28 stsp .Xr gotweb 8 .
27 06dbbefa 2020-01-28 stsp The file format is line-based, with one configuration directive per line.
28 06dbbefa 2020-01-28 stsp Any lines beginning with a
30 06dbbefa 2020-01-28 stsp are treated as comments and ignored.
32 dcc182c0 2020-01-28 stsp Paths mentioned in
34 dcc182c0 2020-01-28 stsp must be relative to
35 dcc182c0 2020-01-28 stsp .Pa /var/www ,
37 dcc182c0 2020-01-28 stsp .Xr chroot 2
38 dcc182c0 2020-01-28 stsp environment of
39 dcc182c0 2020-01-28 stsp .Xr httpd 8 .
40 0f97c5ad 2020-01-15 tracey .Sh GLOBAL CONFIGURATION
41 06dbbefa 2020-01-28 stsp The available configuration directives are as follows:
42 0f97c5ad 2020-01-15 tracey .Bl -tag -width Ds
43 71317958 2020-01-28 stsp .It Ic got_max_commits_display Ar number
44 3f145c31 2020-01-28 stsp Set the maximum amount of commits displayed per page.
45 ee882e75 2020-01-28 stsp .It Ic got_logo Ar path
46 ee882e75 2020-01-28 stsp Set the path to an image file containing a logo to be displayed.
47 ee882e75 2020-01-28 stsp .It Ic got_logo_url Ar url
48 06c41672 2020-01-28 stsp Set a hyperlink for the logo.
49 87db323e 2020-01-15 tracey .It Ic got_max_repos Ar number
50 86a8f423 2020-01-28 stsp Set the maximum amount of repositories
51 86a8f423 2020-01-28 stsp .Xr gotweb 8
52 86a8f423 2020-01-28 stsp will work with.
53 87db323e 2020-01-15 tracey .It Ic got_max_repos_display Ar number
54 87db323e 2020-01-15 tracey Set the maximum amount of repositories displayed on the index screen.
55 ee882e75 2020-01-28 stsp .It Ic got_show_repo_age Ar on | off
56 ee882e75 2020-01-28 stsp Toggle display of last repository modification date.
57 ee882e75 2020-01-28 stsp .It Ic got_show_repo_cloneurl Ar on | off
58 ee882e75 2020-01-28 stsp Toggle display of clone URLs for a repository.
59 ee882e75 2020-01-28 stsp This requires the creation of a
60 ee882e75 2020-01-28 stsp .Pa cloneurl
61 ee882e75 2020-01-28 stsp file inside the repository which contains one URL per line.
62 ee882e75 2020-01-28 stsp .It Ic got_show_repo_description Ar on | off
63 ee882e75 2020-01-28 stsp Toggle display of the repository description.
65 ee882e75 2020-01-28 stsp .Pa description
66 ee882e75 2020-01-28 stsp file in the repository should be updated with an appropriate description.
67 ee882e75 2020-01-28 stsp .It Ic got_repos_path Ar path
68 ee882e75 2020-01-28 stsp Set the path to the directory which contains Git repositories that
69 ee882e75 2020-01-28 stsp .Xr gotweb 8
70 ee882e75 2020-01-28 stsp should publish.
71 ee882e75 2020-01-28 stsp .It Ic got_show_repo_owner Ar on | off
72 ee882e75 2020-01-28 stsp Set whether to display the repository owner.
73 ee882e75 2020-01-28 stsp Displaying the owner requires owner information to be added to the
75 ee882e75 2020-01-28 stsp file in the repository.
76 86a8f423 2020-01-28 stsp .Xr gotweb 8
77 705044c5 2020-01-28 stsp will parse owner information from either a [gotweb] or a [gitweb] section.
78 87db323e 2020-01-15 tracey For example:
79 87db323e 2020-01-15 tracey .Bd -literal -offset indent
81 87db323e 2020-01-15 tracey owner = "Your Name"
83 87db323e 2020-01-15 tracey .It Ic got_site_link Ar string
84 87db323e 2020-01-15 tracey Set the displayed site link name for the index page.
85 87db323e 2020-01-15 tracey .It Ic got_site_name Ar string
86 87db323e 2020-01-15 tracey Set the displayed site name title.
87 87db323e 2020-01-15 tracey .It Ic got_site_owner Ar string
88 87db323e 2020-01-15 tracey Set the displayed site owner.
89 ee882e75 2020-01-28 stsp .It Ic got_show_site_owner Ar on | off
90 ee882e75 2020-01-28 stsp Toggle display of the site owner.
91 9f6f3943 2020-09-24 tracey .It Ic got_www_path Ar string
92 9f6f3943 2020-09-24 tracey Set the public gotweb httpd path.
94 add40c4f 2020-01-15 tracey .Sh EXAMPLES
95 9db6255d 2020-01-28 stsp These are the currently configurable items for
96 9db6255d 2020-01-28 stsp .Xr gotweb 8
97 9db6255d 2020-01-28 stsp with their default values.
98 add40c4f 2020-01-15 tracey .Bd -literal -offset indent
101 add40c4f 2020-01-15 tracey # gotweb options
102 add40c4f 2020-01-15 tracey # all paths relative to /var/www (httpd chroot jail)
105 add40c4f 2020-01-15 tracey got_repos_path "/got/public"
106 9f6f3943 2020-09-24 tracey got_www_path "/gotweb"
108 add40c4f 2020-01-15 tracey #got_max_repos 100
109 add40c4f 2020-01-15 tracey #got_max_repos_display 25
110 add40c4f 2020-01-15 tracey got_max_commits_display 50
112 add40c4f 2020-01-15 tracey got_site_name "my public repos"
113 add40c4f 2020-01-15 tracey got_site_owner "Got Owner"
114 add40c4f 2020-01-15 tracey got_site_link "repos"
116 add40c4f 2020-01-15 tracey got_logo "got.png"
117 add40c4f 2020-01-15 tracey got_logo_url "https://gameoftrees.org"
119 add40c4f 2020-01-15 tracey # on by default
120 add40c4f 2020-01-15 tracey #got_show_site_owner off
121 add40c4f 2020-01-15 tracey #got_show_repo_owner off
122 add40c4f 2020-01-15 tracey #got_show_repo_age false
123 add40c4f 2020-01-15 tracey #got_show_repo_description no
124 add40c4f 2020-01-15 tracey #got_show_repo_cloneurl off
126 0f97c5ad 2020-01-15 tracey .Sh FILES
127 0f97c5ad 2020-01-15 tracey .Bl -tag -width Ds -compact
128 0f97c5ad 2020-01-15 tracey .It Pa /var/www/etc/gotweb.conf
129 82013002 2020-01-28 stsp Location of the
131 82013002 2020-01-28 stsp configuration file.
133 0f97c5ad 2020-01-15 tracey .Sh SEE ALSO
134 0f97c5ad 2020-01-15 tracey .Xr got 1 ,
135 fd4ad5d4 2020-01-28 stsp .Xr gotweb 8
