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 dcc182c0 2020-01-28 stsp is the run-time configuration file for
25 dcc182c0 2020-01-28 stsp .Xr gotweb 8 .
27 dcc182c0 2020-01-28 stsp Paths mentioned in
29 dcc182c0 2020-01-28 stsp must be relative to
30 dcc182c0 2020-01-28 stsp .Pa /var/www ,
32 dcc182c0 2020-01-28 stsp .Xr chroot 2
33 dcc182c0 2020-01-28 stsp environment of
34 dcc182c0 2020-01-28 stsp .Xr httpd 8 .
35 0f97c5ad 2020-01-15 tracey .Sh GLOBAL CONFIGURATION
36 ee882e75 2020-01-28 stsp The available settings are as follows:
37 0f97c5ad 2020-01-15 tracey .Bl -tag -width Ds
38 71317958 2020-01-28 stsp .It Ic got_max_commits_display Ar number
39 0f97c5ad 2020-01-15 tracey Set the maximum amount of log lines displayed.
40 ee882e75 2020-01-28 stsp .It Ic got_logo Ar path
41 ee882e75 2020-01-28 stsp Set the path to an image file containing a logo to be displayed.
42 ee882e75 2020-01-28 stsp .It Ic got_logo_url Ar url
43 ee882e75 2020-01-28 stsp Set a hyperlink link for the logo.
44 87db323e 2020-01-15 tracey .It Ic got_max_repos Ar number
45 87db323e 2020-01-15 tracey Set the maximum amount of repositories gotweb will work with.
46 87db323e 2020-01-15 tracey .It Ic got_max_repos_display Ar number
47 87db323e 2020-01-15 tracey Set the maximum amount of repositories displayed on the index screen.
48 ee882e75 2020-01-28 stsp .It Ic got_show_repo_age Ar on | off
49 ee882e75 2020-01-28 stsp Toggle display of last repository modification date.
50 ee882e75 2020-01-28 stsp .It Ic got_show_repo_cloneurl Ar on | off
51 ee882e75 2020-01-28 stsp Toggle display of clone URLs for a repository.
52 ee882e75 2020-01-28 stsp This requires the creation of a
53 ee882e75 2020-01-28 stsp .Pa cloneurl
54 ee882e75 2020-01-28 stsp file inside the repository which contains one URL per line.
55 ee882e75 2020-01-28 stsp .It Ic got_show_repo_description Ar on | off
56 ee882e75 2020-01-28 stsp Toggle display of the repository description.
58 ee882e75 2020-01-28 stsp .Pa description
59 ee882e75 2020-01-28 stsp file in the repository should be updated with an appropriate description.
60 ee882e75 2020-01-28 stsp .It Ic got_repos_path Ar path
61 ee882e75 2020-01-28 stsp Set the path to the directory which contains Git repositories that
62 ee882e75 2020-01-28 stsp .Xr gotweb 8
63 ee882e75 2020-01-28 stsp should publish.
64 ee882e75 2020-01-28 stsp .It Ic got_show_repo_owner Ar on | off
65 ee882e75 2020-01-28 stsp Set whether to display the repository owner.
66 ee882e75 2020-01-28 stsp Displaying the owner requires owner information to be added to the
68 ee882e75 2020-01-28 stsp file in the repository.
69 87db323e 2020-01-15 tracey The gotweb code will parse either [gotweb] or [gitweb] owner information.
70 87db323e 2020-01-15 tracey For example:
71 87db323e 2020-01-15 tracey .Bd -literal -offset indent
73 87db323e 2020-01-15 tracey owner = "Your Name"
75 87db323e 2020-01-15 tracey .It Ic got_site_link Ar string
76 87db323e 2020-01-15 tracey Set the displayed site link name for the index page.
77 87db323e 2020-01-15 tracey .It Ic got_site_name Ar string
78 87db323e 2020-01-15 tracey Set the displayed site name title.
79 87db323e 2020-01-15 tracey .It Ic got_site_owner Ar string
80 87db323e 2020-01-15 tracey Set the displayed site owner.
81 ee882e75 2020-01-28 stsp .It Ic got_show_site_owner Ar on | off
82 ee882e75 2020-01-28 stsp Toggle display of the site owner.
84 add40c4f 2020-01-15 tracey .Sh EXAMPLES
85 9db6255d 2020-01-28 stsp These are the currently configurable items for
86 9db6255d 2020-01-28 stsp .Xr gotweb 8
87 9db6255d 2020-01-28 stsp with their default values.
89 add40c4f 2020-01-15 tracey The configuration file gotweb.conf must be located at /var/www/etc/gotweb.conf.
90 add40c4f 2020-01-15 tracey .Bd -literal -offset indent
93 add40c4f 2020-01-15 tracey # gotweb options
94 add40c4f 2020-01-15 tracey # all paths relative to /var/www (httpd chroot jail)
97 add40c4f 2020-01-15 tracey got_repos_path "/got/public"
99 add40c4f 2020-01-15 tracey #got_max_repos 100
100 add40c4f 2020-01-15 tracey #got_max_repos_display 25
101 add40c4f 2020-01-15 tracey got_max_commits_display 50
103 add40c4f 2020-01-15 tracey got_site_name "my public repos"
104 add40c4f 2020-01-15 tracey got_site_owner "Got Owner"
105 add40c4f 2020-01-15 tracey got_site_link "repos"
107 add40c4f 2020-01-15 tracey got_logo "got.png"
108 add40c4f 2020-01-15 tracey got_logo_url "https://gameoftrees.org"
110 add40c4f 2020-01-15 tracey # on by default
111 add40c4f 2020-01-15 tracey #got_show_site_owner off
112 add40c4f 2020-01-15 tracey #got_show_repo_owner off
113 add40c4f 2020-01-15 tracey #got_show_repo_age false
114 add40c4f 2020-01-15 tracey #got_show_repo_description no
115 add40c4f 2020-01-15 tracey #got_show_repo_cloneurl off
117 0f97c5ad 2020-01-15 tracey .Sh FILES
118 0f97c5ad 2020-01-15 tracey .Bl -tag -width Ds -compact
119 0f97c5ad 2020-01-15 tracey .It Pa /var/www/etc/gotweb.conf
120 0f97c5ad 2020-01-15 tracey gotweb configuration file.
122 0f97c5ad 2020-01-15 tracey .Sh SEE ALSO
123 0f97c5ad 2020-01-15 tracey .Xr got 1 ,
124 fd4ad5d4 2020-01-28 stsp .Xr gotweb 8
