1 package Girocco
::Config
;
13 # Name of the service (typically a single word or a domain name)
15 our $name = "repo.or.cz";
17 # Nickname of the service (undef for initial part of $name upto first '.')
19 our $nickname = "rorcz";
21 # Title of the service (as shown in gitweb)
22 # (may contain spaces)
23 our $title = "Public Git Hosting";
25 # Path to the Git binary to use (you MUST set this, even if to /usr/bin/git!)
26 our $git_bin = '/home/repo/bin/git';
28 # Path to the git-daemon binary to use (undef to use default)
29 # If $gitpullurl is undef this will never be used (assuming no git inetd
30 # service has been set up in that case).
31 # The default if this is undef is `$git_bin --exec-path`/git-daemon
32 our $git_daemon_bin = undef;
34 # Path to the git-http-backend binary to use (undef to use default)
35 # If both $httppullurl and $httpspushurl are undef this will never be used
36 # The default if this is undef is `$git_bin --exec-path`/git-http-backend
37 our $git_http_backend_bin = undef;
39 # Name (if in $PATH) or full path to netcat executable that accepts a -U option
40 # to connect to a unix socket. This may simply be 'nc' on many systems.
41 # See the ../src/dragonfly/README file for a DragonFly BSD nc with -U support.
42 # For a Linux-like system try installing the 'netcat-openbsd' package.
43 our $nc_openbsd_bin = 'nc.openbsd';
45 # Path to POSIX sh executable to use. Set to undef to use /bin/sh
46 our $posix_sh_bin = undef;
48 # Path to Perl executable to use. Set to undef to use Perl found in $PATH
49 our $perl_bin = undef;
51 # Path to gzip executable to use. Set to undef to use gzip found in $PATH
52 our $gzip_bin = undef;
54 # Path to the sendmail instance to use. It should understand the -f <from>, -i and -t
55 # options as well as accepting a list of recipient addresses in order to be used here.
56 # You MUST set this, even if to '/usr/sbin/sendmail'!
57 # Setting this to 'sendmail.pl' is special and will automatically be expanded to
58 # a full path to the ../bin/sendmail.pl executable in this Girocco installation.
59 # sendmail.pl is a sendmail-compatible script that delivers the message directly
60 # using SMTP to a mail relay host. This is the recommended configuration as it
61 # minimizes the information exposed to recipients (no sender account names or uids),
62 # can talk to an SMTP server on another host (eliminating the need for a working
63 # sendmail and/or SMTP server on this host) and avoids any unwanted address rewriting.
64 # By default it expects the mail relay to be listening on localhost port 25.
65 # See the sendmail.pl section below for more information on configuring sendmail.pl.
66 our $sendmail_bin = 'sendmail.pl';
68 # E-mail of the site admin
69 our $admin = 'admin@repo.or.cz';
72 # This is the SMTP 'MAIL FROM:' value
73 # It will be passed to $sendmail_bin with the -f option
74 # Some sites may not allow non-privileged users to pass the -f option to
75 # $sendmail_bin. In that case set this to undef and no -f option will be
76 # passed which means the 'MAIL FROM:' value will be the user the mail is
77 # sent as (either $cgi_user or $mirror_user depending on the activity).
78 # To avoid having bounce emails go to $admin, this may be set to something
79 # else such as 'admin-noreply@example.org' and then the 'admin-noreply' address
80 # may be redirected to /dev/null. Setting this to '' or '<>' is not
81 # recommended because that will likely cause the emails to be marked as SPAM
82 # by the receiver's SPAM filter. If $sendmail_bin is set to 'sendmail.pl' this
83 # value must be acceptable to the receiving SMTP server as a 'MAIL FROM:' value.
84 # If this is set to undef and 'sendmail.pl' is used, the 'MAIL FROM:' value will
85 # be the user the mail is sent as (either $cgi_user or $mirror_user).
86 our $sender = 'admin-noreply@repo.or.cz';
88 # Copy $admin on failure/recovery messages?
91 # Girocco branch to use for html.cgi view source links (undef for HEAD)
92 our $giroccobranch = 'rorcz';
95 # If the PATH needs to be customized to find required executables on
96 # the system, it can be done here.
97 # For example something like this:
98 #$ENV{PATH} = substr(`/usr/bin/getconf PATH`,0,-1).":/usr/local/bin";
102 ## ----------------------
103 ## Git user agent strings
104 ## ----------------------
107 # Git clients (i.e. fetch/clone) always send a user agent string when fetching
108 # over HTTP. Since version 1.7.12.1 an 'agent=' capability string is included
109 # as well which affects git:, smart HTTP and ssh: protocols.
111 # These settings allow the default user agent string to be changed independently
112 # for fetch/clone operations (only matters if $mirror is true) and server
113 # operations (some other Git client fetching from us). Note that it is not
114 # possible to suppress the capability entirely although it can be set to an
115 # empty string. If these values are not set, the default user agent string
116 # will be used. Typically (unless Git was built with non-standard options) the
117 # default is "git/" plus the version. So for example "git/1.8.5.6" or
118 # "git/2.1.4" might be seen.
120 # One might want to change the default user agent strings in order to prevent
121 # an attacker from learning the exact Git version being used to avoid being
122 # able to quickly target any version-specific vulnerabilities. Note that
123 # no matter what's set here, an attacker can easily determine whether a server
124 # is running JGit, libgit2 or Git and for Git whether it's version 1.7.12.1 or
125 # later. A reasonable value to hide the exact Git version number while
126 # remaining compatible with servers that require a "Git/" user agent string
127 # would be something like "git/2" or even just "git/".
129 # The GIT_USER_AGENT value to use when acting as a client (i.e. clone/fetch)
130 # This value is only used if $mirror is true and at least one mirror is set up.
131 # Setting this to the empty string will suppress the HTTP User-Agent header,
132 # but will still include an "agent=" capability in the packet protocol. The
133 # empty string is not recommended because some servers match on "git/".
134 # Leave undef to use the default Git user agent string
135 # IMPORTANT: some server sites will refuse to serve up Git repositories unless
136 # the client user agent string contains "Git/" (matched case insensitively)!
137 our $git_client_ua = undef;
139 # The GIT_USER_AGENT value to use when acting as a server (i.e. some Git client
140 # is fetching/cloning from us).
141 # Leave undef to use the default Git user agent string
142 our $git_server_ua = undef;
151 # Enable mirroring mode if true (see "Foreign VCS mirrors" section below)
154 # Enable push mode if true
157 # If both $mirror and $push are enabled, setting this to 'mirror' pre-selects
158 # mirror mode on the initial regproj display, otherwise 'push' mode will be
159 # pre-selected. When forking the initial mode will be 'push' if $push enabled.
160 our $initial_regproj_mode = 'mirror';
162 # Enable user management if true; this means the interface for registering
163 # user accounts and uploading SSH keys. This implies full chroot.
164 our $manage_users = 1;
166 # Minimum key length (in bits) for uploaded SSH RSA/DSA keys.
167 # If this is not set (i.e. undef) keys as small as 512 bits will be allowed.
168 # Nowadays keys less than 2048 bits in length should probably not be allowed.
169 # Note, however, that versions of OpenSSH starting with 4.3p1 will only generate
170 # DSA keys of exactly 1024 bits in length even though that length is no longer
171 # recommended. (OpenSSL can be used to generate DSA keys with lengths > 1024.)
172 # OpenSSH does not have any problem generating RSA keys longer than 1024 bits.
173 # This setting is only checked when new keys are added so setting it/increasing it
174 # will not affect existing keys. For maximum compatibility a value of 1024 may
175 # be used however 2048 is recommended. Setting it to anything other than 1024,
176 # 2048 or 3072 may have the side effect of making it very difficult to generate
177 # DSA keys that satisfy the restriction (but RSA keys should not be a problem).
178 # Note that no matter what setting is specified here keys smaller than 512 bits
179 # will never be allowed via the reguser.cgi/edituser.cgi interface.
180 # RECOMMENDED VALUE: 2048 (ok) or 3072 (better)
181 our $min_key_length = 2048;
183 # Disable DSA public keys?
185 # If this is set to 1, adding DSA keys at reguser.cgi/edituser.cgi time will be
186 # prohibited. If $pushurl is undef then this is implicitly set to 1 since DSA
187 # keys are not usable with https push.
189 # OpenSSH will only generate 1024 bit DSA keys starting with version 4.3p1.
190 # Even if OpenSSL is used to generate a longer DSA key (which can then be used
191 # with OpenSSH), the SSH protocol itself still forces use of SHA-1 in the DSA
192 # signature blob which tends to defeat the purpose of going to a longer key in
193 # the first place. So it may be better from a security standpoint to simply
194 # disable DSA keys especially if $min_key_length and $rsakeylength have been set
195 # to something higher such as 3072 or 4096.
197 # This setting is only checked when new keys are added so changing it will not
198 # affect existing keys. There is no way to disable DSA keys in the sshd_config
199 # file of older versions of the OpenSSH server, but newer versions of OpenSSH
200 # WILL DISABLE DSA KEYS BY DEFAULT!
202 # IMPORTANT: If you do enable DSA keys ($disable_dsa is set to 0) and you are
203 # using a more recent version of the OpenSSH server software in the
204 # chroot jail, you MUST manually ADD the following line
205 # (the "+" IS REQUIRED) to the $chroot/j/etc/ssh/sshd_config file
206 # otherwise dsa keys WILL NOT BE ACCEPTED!
208 # PubkeyAcceptedKeyTypes +ssh-dss
210 # If this is set to 1, no ssh_host_dsa_key will be generated or used with the
211 # sshd running in the jail (but if the sshd_config has already been generated
212 # in the jail, it must be removed and 'sudo make install' run again or otherwise
213 # the sshd_config needs to be edited by hand for the change to take effect).
215 # RECOMMENDED VALUE: 1
216 our $disable_dsa = 1;
218 # Enable the special 'mob' user if set to 'mob'
221 # Let users set admin passwords; if false, all password inputs are assumed empty.
222 # This will make new projects use empty passwords and all operations on them
223 # unrestricted, but you will be able to do no operations on previously created
224 # projects you have set a password on.
225 our $project_passwords = 1;
227 # How to determine project owner; 'email' adds a form item asking for their
228 # email contact, 'source' takes realname of owner of source repository if it
229 # is a local path (and empty string otherwise). 'source' is suitable in case
230 # the site operates only as mirror of purely local-filesystem repositories.
231 our $project_owners = 'email';
233 # Which project fields to make editable, out of 'shortdesc', 'homepage', 'README',
234 # 'cleanmirror', 'notifymail', 'reverseorder', 'summaryonly', 'notifytag' and 'notifyjson'
235 # 'notifycia' was used by the now defunct CIA service and while allowing it to
236 # be edited does work and the value is saved, the value is totally ignored by Girocco
237 our @project_fields = qw(cleanmirror homepage shortdesc README notifymail reverseorder summaryonly notifytag notifyjson);
239 # Minimal number of seconds to pass between two updates of a project.
240 our $min_mirror_interval = 3600; # 1 hour
242 # Minimal number of seconds to pass between two garbage collections of a project.
243 our $min_gc_interval = 604800; # 1 week
245 # Minimal number of seconds to pass after first failure before sending failure email.
246 # A mirror update failed message will not be sent until mirror updates have been
247 # failing for at least this long. Set to 0 to send a failure message right away
248 # (provided the $min_mirror_failure_message_count condition has been met).
249 our $min_mirror_failure_message_interval = 345600; # 4 days
251 # Minimal number of consecutive failures required before sending failure email.
252 # A mirror update failed message will not be sent until mirror updates have failed
253 # for this many consecutive updates. Set to 0 to send a failure message right away
254 # (provided the $min_mirror_failure_message_interval condition has been met).
255 our $min_mirror_failure_message_count = 10;
257 # Maximum window memory size when repacking. If this is set, it will be used
258 # instead of the automatically computed value if it's less than that value.
259 # May use a 'k', 'm', or 'g' suffix otherwise value is in bytes.
260 our $max_gc_window_memory_size = undef;
262 # Maximum big file threshold size when repacking. If this is set, it will be
263 # used instead of the automatically computed value if it's less than that value.
264 # May use a 'k', 'm', or 'g' suffix otherwise value is in bytes.
265 our $max_gc_big_file_threshold_size = undef;
267 # Whether or not to run the ../bin/update-pwd-db script whenever the etc/passwd
268 # database is changed. This is typically needed (i.e. set to a true value) for
269 # FreeBSD style systems when using an sshd chroot jail for push access. So if
270 # $pushurl is undef or the system Girocco is running on is not like FreeBSD
271 # (e.g. a master.passwd file that must be transformed into pwd.db and spwd.db), then
272 # this setting should normally be left false (i.e. 0). See comments in the
273 # provided ../bin/update-pwd-db script about when and how it's invoked.
274 our $update_pwd_db = 0;
276 # Port the sshd running in the jail should listen on
277 # Be sure to update $pushurl to match
278 # Not used if $pushurl is undef
279 our $sshd_jail_port = 22;
281 # If this is true then host names used in mirror source URLs will be checked
282 # and any that are not DNS names (i.e. IPv4 or IPv6) or match one of the DNS
283 # host names in any of the URL settings below will be rejected.
284 our $restrict_mirror_hosts = 1;
286 # If $restrict_mirror_hosts is enabled this is the minimum number of labels
287 # required in a valid dns name. Normally 2 is the correct value, but if
288 # Girocco is being used internally where a common default or search domain
289 # is set for everyone then this should be changed to 1 to allow a dns name
290 # with a single label in it. No matter what is set here at least 1 label
291 # is always required when $restrict_mirror_hosts is enabled.
292 our $min_dns_labels = 2;
294 # If $xmllint_readme is true then the contents of the README.html section
295 # will be passed through xmllint and any errors must be corrected before
296 # it can be saved. If this is set to true then xmllint must be in the $PATH.
297 # RECOMMENDED VALUE: 1
298 our $xmllint_readme = 1;
300 # If defined, pass this value to format-readme as its `-m` option
301 # When format-readme is formatting an automatic readme, it will skip
302 # anything larger than this. The default is 32768 if unset.
303 # See `bin/format-readme -h` for details.
304 our $max_readme_size = 350000;
306 # Maximum size of any single email sent by mail.sh in K (1024-byte) units
307 # If message is larger it will be truncated with a "...e-mail trimmed" line
308 # RECOMMENDED VALUE: 256 - 5120 (.25M - 5M)
309 our $mailsh_sizelimit = 512;
313 ## -------------------
314 ## Foreign VCS mirrors
315 ## -------------------
318 # Note that if any of these settings are changed from true to false, then
319 # any pre-existing mirrors using the now-disabled foreign VCS will stop
320 # updating, new mirrors using the now-disabled foreign VCS will be disallowed
321 # and attempts to update ANY project settings for a pre-existing project that
322 # uses a now-disabled foreign VCS source URL will also be disallowed.
324 # If $mirror is true and $mirror_svn is true then mirrors from svn source
325 # repositories will be allowed (and be converted to Git). These URLs have
326 # the form svn://... or svn+http://... or svn+https://...
327 # Since this functionality makes use of the "git svn" command and is maintained
328 # with Git, it tends to be kept up-to-date and highly usable.
329 # Note that for this to work the "svn" command line command must be available
330 # in PATH and the "git svn" commands must work (which generally requires both
331 # Perl and the subversion perl bindings be installed).
332 # RECOMMENDED VALUE: 1 (if the necessary prerequisites are installed)
335 # Prior to Git v1.5.1, git-svn always used a log window size of 1000.
336 # Starting with Git v1.5.1, git-svn defaults to using a log window size of 100
337 # and provides a --log-window-size= option to change it. Starting with Git
338 # v2.2.0, git-svn disconnects and reconnects to the server every log window size
339 # interval to attempt to reduce memory use by git-svn. If $svn_log_window_size
340 # is undefined, Girocco will use a log window size of 250 (instead of the
341 # the default 100). If $svn_log_window_size is set, Girocco will use that
342 # value instead. Beware that setting it too low (i.e. < 50) will almost
343 # certainly cause performance issues if not failures. Unless there are concerns
344 # about git-svn memory use on a server with extremely limited memory, the
345 # value of 250 that Girocco uses by default should be fine. Obviously if
346 # $mirror or $mirror_svn is false this setting is irrelevant.
347 our $svn_log_window_size = undef;
349 # If $mirror is true and $mirror_darcs is true then mirrors from darcs source
350 # repositories will be allowed (and be converted to Git). These URLs have
351 # the form darcs+http://... darcs+https://... (and deprecated darcs://...)
352 # Note that for this to work the "darcs" command line command must be available
353 # in PATH and so must python (required to run the darcs-fast-export script).
354 # This support depends on items updated separately from Git and which may easily
355 # become out-of-date or incompatible (e.g. new python version).
356 # NOTE: If this is set to 0, the girocco-darcs-fast-export.git
357 # submodule need not be initialized or checked out.
358 # RECOMMENDED VALUE: 0 (unless you have a need to mirror darcs repos)
359 our $mirror_darcs = 0;
361 # If $mirror is true and $mirror_bzr is true then mirrors from bzr source
362 # repositories will be allowed (and be converted to Git). These URLs have
364 # Note that for this to work the "bzr" command line command must be available
365 # in PATH (it's a python script so python is required as well).
366 # This support depends on items updated separately from Git and which may easily
367 # become out-of-date or incompatible (e.g. new python version).
368 # RECOMMENDED VALUE: 0 (unless you have a need to mirror bzr repos)
371 # If $mirror is true and $mirror_hg is true then mirrors from hg source
372 # repositories will be allowed (and be converted to Git). These URLs have
373 # the form hg+http://... or hg+https://...
374 # Note that for this to work the "hg" command line command must be available
375 # in PATH and so must python (required to run the hg-fast-export.py script).
376 # Note that if the PYTHON environment variable is set that will be used instead
377 # of just plain "python" to run the hg-fast-export.py script (which needs to
378 # be able to import from mercurial). Currently the hg-fast-export.py script
379 # used for this feature is likely incompatible with python 3 or later.
380 # Repositories created via this facility may need to be "reset" if the upstream
381 # hg repository moves the tip revision backwards and creates "unnamed heads".
382 # This support depends on items updated separately from Git and which may easily
383 # become out-of-date or incompatible (e.g. new python version).
384 # NOTE: If this is set to 0, the girocco-hg-fast-export.git
385 # submodule need not be initialized or checked out.
386 # RECOMMENDED VALUE: 0 (unless you have a need to mirror hg repos)
396 # Path where the main chunk of Girocco files will be installed
397 # This will get COMPLETELY OVERWRITTEN by each make install!!!
398 # MUST be an absolute path
399 our $basedir = '/home/repo/repomgr';
401 # Path where the automatically generated non-user certificates will be stored
402 # (The per-user certificates are always stored in $chroot/etc/sshcerts/)
403 # This is preserved by each make install and MUST NOT be under $basedir!
404 # Not used unless $httpspushurl is defined
405 # MUST be an absolute path
406 our $certsdir = '/home/repo/certs';
408 # The repository collection
409 # "$reporoot/_recyclebin" will also be created for use by toolbox/trash-project.pl
410 # MUST be an absolute path
411 our $reporoot = "/srv/git";
413 # The repository collection's location within the chroot jail
414 # Normally $reporoot will be bind mounted onto $chroot/$jailreporoot
415 # Should NOT start with '/'
416 our $jailreporoot = "srv/git";
418 # The chroot for ssh pushing; location for project database and other run-time
419 # data even in non-chroot setups
420 # MUST be an absolute path
421 our $chroot = "/home/repo/j";
423 # An installation that will never run a chrooted sshd should set this
424 # to a true value (e.g. 1) to guarantee that jailsetup for a chrooted
425 # sshd never takes place no matter what user runs `make install`.
426 # Note that the "jailsetup.sh" script will still run to do the database
427 # setup that's stored in $chroot regardless of this setting, it will just
428 # always run in "dbonly" mode when this setting is true.
429 our $disable_jailsetup = 0;
431 # The gitweb files web directory (corresponds to $gitwebfiles)
432 # Note that it is safe to place this under $basedir since it's set up after
433 # $basedir is completely replaced during install time. Be WARNED, however,
434 # that normally the install process only adds/replaces things in $webroot,
435 # but if $webroot is under $basedir then it will be completely removed and
436 # rebuilt each time "make install" is run. This will make gitweb/git-browser
437 # web services very briefly unavailable while this is happening.
438 # MUST be an absolute path
439 our $webroot = "/home/repo/www";
441 # The CGI-enabled web directory (corresponds to $gitweburl and $webadmurl)
442 # This will not be web-accessible except that if any aliases point to
443 # a *.cgi file in here it will be allowed to run as a cgi-script.
444 # Note that it is safe to place this under $basedir since it's set up after
445 # $basedir is completely replaced during install time. Be WARNED, however,
446 # that normally the install process only adds/replaces things in $cgiroot,
447 # but if $cgiroot is under $basedir then it will be completely removed and
448 # rebuilt each time "make install" is run. This will make gitweb/git-browser
449 # web services very briefly unavailable while this is happening.
450 # MUST be an absolute path
451 our $cgiroot = "/home/repo/cgibin";
453 # A web-accessible symlink to $reporoot (corresponds to $httppullurl, can be undef)
454 # If using the sample apache.conf (with paths suitably updated) this is not required
455 # to serve either smart or non-smart HTTP repositories to the Git client
456 # MUST be an absolute path if not undef
457 our $webreporoot = "/home/repo/www/r";
459 # The location to store the project list cache, gitweb project list and gitweb
460 # cache file. Normally this should not be changed. Note that it must be in
461 # a directory that is writable by $mirror_user and $cgi_user (just in case the
462 # cache file is missing). The directory should have its group set to $owning_group.
463 # Again, this setting should not normally need to be changed.
464 # MUST be an absolute path
465 our $projlist_cache_dir = "$chroot/etc";
469 ## ----------------------------------------------------
470 ## Certificates (only used if $httpspushurl is defined)
471 ## ----------------------------------------------------
474 # path to root certificate (undef to use automatic root cert)
475 # this certificate is made available for easy download and should be whatever
476 # the root certificate is for the https certificate being used by the web server
477 our $rootcert = undef;
479 # The certificate to sign user push client authentication certificates with (undef for auto)
480 # The automatically generated certificate should always be fine
481 our $clientcert = undef;
483 # The private key for $clientcert (undef for auto)
484 # The automatically generated key should always be fine
485 our $clientkey = undef;
487 # The client certificate chain suffix (a pemseq file to append to user client certs) (undef for auto)
488 # The automatically generated chain should always be fine
489 # This suffix will also be appended to the $mobusercert before making it available for download
490 our $clientcertsuffix = undef;
492 # The mob user certificate signed by $clientcert (undef for auto)
493 # The automatically generated certificate should always be fine
494 # Not used unless $mob is set to 'mob'
495 # The $clientcertsuffix will be appended before making $mobusercert available for download
496 our $mobusercert = undef;
498 # The private key for $mobusercert (undef for auto)
499 # The automatically generated key should always be fine
500 # Not used unless $mob is set to 'mob'
501 our $mobuserkey = undef;
503 # Server alt names to embed in the auto-generated girocco_www_crt.pem certificate.
504 # The common name (CN) in the server certificate is the host name from $httpspushurl.
505 # By default no server alt names are embedded (not even the host from $httpspushurl).
506 # If the web server configuration is not using this auto-generated server certificate
507 # then the values set here will have no impact and this setting can be ignored.
508 # To embed server alternative names, list each (separated by spaces). The names
509 # may be DNS names, IPv4 addresses or IPv6 addresses (NO surrounding '[' ']' please).
510 # If ANY DNS names are included here be sure to also include the host name from
511 # the $httpspushurl or else standards-conforming clients will fail with a host name
512 # mismatch error when they attempt to verify the connection.
513 #our $wwwcertaltnames = 'example.com www.example.com git.example.com 127.0.0.1 ::1';
514 our $wwwcertaltnames = undef;
516 # The key length for automatically generated RSA private keys (in bits).
517 # These keys are then used to create the automatically generated certificates.
518 # If undef or set to a value less than 2048, then 2048 will be used.
519 # Set to 3072 to generate more secure keys/certificates. Set to 4096 (or higher) for
520 # even greater security. Be warned that setting to a non-multiple of 8 and/or greater
521 # than 4096 could negatively impact compatibility with some clients.
522 # The values 2048, 3072 and 4096 are expected to be compatible with all clients.
523 # Note that OpenSSL has no problem with > 4096 or non-multiple of 8 lengths.
524 # See also the $min_key_length setting above to restrict user key sizes.
525 # This value is also used when generating the ssh_host_rsa_key for the chroot jail sshd.
526 # RECOMMENDED VALUE: 3072
527 our $rsakeylength = undef;
536 # URL of the gitweb.cgi script (must be in pathinfo mode). If the sample
537 # apache.conf configuration is used, the trailing "/w" is optional.
538 our $gitweburl = "https://repo.or.cz";
540 # URL of the extra gitweb files (CSS, .js files, images, ...)
541 our $gitwebfiles = "https://repo.or.cz";
543 # URL of the Girocco CGI web admin interface (Girocco cgi/ subdirectory)
544 # e.g. reguser.cgi, edituser.cgi, regproj.cgi, editproj.cgi etc.
545 our $webadmurl = "https://repo.or.cz";
547 # URL of the Girocco CGI bundles information generator (Girocco cgi/bundles.cgi)
548 # If the sample apache.conf configuration is used, the trailing "/b" is optional.
549 # This is different from $httpbundleurl. This URL lists all available bundles
550 # for a project and returns that as an HTML page.
551 our $bundlesurl = "https://repo.or.cz";
553 # URL of the Girocco CGI html templater (Girocco cgi/html.cgi)
554 # If mod_rewrite is enabled and the sample apache.conf configuration is used,
555 # the trailing "/h" is optional when the template file name ends in ".html"
556 # (which all the provided ones do).
557 our $htmlurl = "https://repo.or.cz";
559 # HTTP URL of the repository collection (undef if N/A)
560 # If the sample apache.conf configuration is used, the trailing "/r" is optional.
561 our $httppullurl = "https://repo.or.cz";
563 # HTTP URL of the repository collection when fetching a bundle (undef if N/A)
564 # Normally this will be the same as $httppullurl, but note that the bundle
565 # fetching logic is located in git-http-backend-verify so whatever URL is
566 # given here MUST end up running the git-http-backend-verify script!
567 # For example, if we're fetching the 'clone.bundle' for the 'girocco.git'
568 # repository, the final URL will be "$httpbundleurl/girocco.git/clone.bundle"
569 # If the sample apache.conf configuration is used, the trailing "/r" is optional.
570 # This is different from $bundlesurl. This URL fetches a single Git-format
571 # .bundle file that is only usable with the 'git bundle' command.
572 our $httpbundleurl = "https://repo.or.cz";
574 # HTTPS push URL of the repository collection (undef if N/A)
575 # If this is defined, the openssl command must be available
576 # The sample apache.conf configuration requires mod_ssl, mod_authn_anon and
577 # mod_rewrite be enabled to support https push operations.
578 # Normally this should be set to $httppullurl with http: replaced with https:
579 # If the sample apache.conf configuration is used, the trailing "/r" is optional.
580 our $httpspushurl = "https://repo.or.cz";
582 # Git URL of the repository collection (undef if N/A)
583 # (You need to set up git-daemon on your system, and Girocco will not
584 # do this particular thing for you.)
585 our $gitpullurl = "git://repo.or.cz";
587 # Pushy SSH URL of the repository collection (undef if N/A)
588 # Note that the "/$jailreporoot" portion is optional and will be automatically
589 # added if appropriate when omitted by the client so this URL can typically
590 # be made the same as $gitpullurl with git: replaced with ssh:
591 our $pushurl = "ssh://repo.or.cz";
593 # URL of gitweb of this Girocco instance (set to undef if you're not nice
595 our $giroccourl = "$Girocco::Config::gitweburl/girocco.git";
599 ## -------------------
600 ## Web server controls
601 ## -------------------
604 # If true then non-smart HTTP access will be disabled
605 # There's normally no reason to leave non-smart HTTP access enabled
606 # since downloadable bundles are provided. However, in case the
607 # non-smart HTTP access is needed for some reason, this can be set to undef or 0.
608 # This affects access via http: AND https: and processing of apache.conf.in.
609 # Note that this setting does not affect gitweb, ssh: or git: URL access in any way.
610 # RECOMMENDED VALUE: 1
611 our $SmartHTTPOnly = 1;
613 # If true, the https <VirtualHost ...> section in apache.conf.in will be
614 # automatically enabled when it's converted to apache.conf by the conversion
615 # script. Do NOT enable this unless the required Apache modules are present
616 # and loaded (mod_ssl, mod_rewrite, mod_authn_anon) AND $httpspushurl is
617 # defined above otherwise the server will fail to start (with various errors)
618 # when the resulting apache.conf is used.
621 # If true, the information about configuring a Git client to trust
622 # a Girocco-generated TLS root will be suppressed presuming that some other
623 # means (such as LetsEncrypt.org) has been used to generate a TLS web
624 # certificate signed by a pre-trusted root. This does NOT affect the
625 # information on how to configure https push certificates as those are still
626 # required in order to push over https regardless of what web server certificate
628 # RECOMMENDED VALUE: 0 (for girocco-generated root & server certificates)
629 # RECOMMENDED VALUE: 1 (for LetsEncrypt etc. generated server certificates)
630 our $pretrustedroot = 1;
634 ## ------------------------
635 ## Some templating settings
636 ## ------------------------
639 # Legal warning (on reguser and regproj pages)
640 our $legalese = <<EOT;
641 <p>By submitting this form, you are confirming that you will mirror or push
642 only free software and redistributing it will not violate any law
644 <sup class="sup"><span><a href="/about.html">(more details)</a></span></sup>
648 # Pre-configured mirror sources (set to undef for none)
649 # Arrayref of name - record pairs, the record has these attributes:
650 # label: The label of this source
651 # url: The template URL; %1, %2, ... will be substituted for inputs
652 # desc: Optional VERY short description
653 # link: Optional URL to make the desc point at
654 # inputs: Arrayref of hashref input records:
655 # label: Label of input record
656 # suffix: Optional suffix
657 # If the inputs arrayref is undef, single URL input is shown,
658 # pre-filled with url (probably empty string).
659 our $mirror_sources = [
663 desc
=> 'Any HTTP/Git/rsync pull URL - bring it on!',
668 url
=> 'https://github.com/%1/%2.git',
669 desc
=> 'GitHub Social Code Hosting',
670 link => 'https://github.com/',
671 inputs
=> [ { label
=> 'User:' }, { label
=> 'Project:', suffix
=> '.git' } ]
675 url
=> 'https://gitlab.com/%1/%2.git',
676 desc
=> 'Engulfed the Green and Orange Boxes',
677 link => 'https://gitlab.com/',
678 inputs
=> [ { label
=> 'Project:' }, { label
=> 'Repository:', suffix
=> '.git' } ]
682 # You can customize the gitweb interface widely by editing
683 # gitweb/gitweb_config.perl
687 ## -------------------
688 ## Permission settings
689 ## -------------------
692 # Girocco needs some way to manipulate write permissions to various parts of
693 # all repositories; this concerns three entities:
694 # - www-data: the web interface needs to be able to rewrite few files within
696 # - repo: a user designated for cronjobs; handles mirroring and repacking;
697 # this one is optional if not $mirror
698 # - others: the designated users that are supposed to be able to push; they
699 # may have account either within chroot, or outside of it
701 # There are several ways how to use Girocco based on a combination of the
702 # following settings.
704 # (Non-chroot) UNIX user the CGI scripts run on; note that if some non-related
705 # untrusted CGI scripts run on this account too, that can be a big security
706 # problem and you'll probably need to set up suexec (poor you).
707 # This must always be set.
708 our $cgi_user = 'www-data';
710 # (Non-chroot) UNIX user performing mirroring jobs; this is the user who
711 # should run all the daemons and cronjobs and
712 # the user who should be running make install (if not root).
713 # This must always be set.
714 our $mirror_user = 'repo';
716 # (Non-chroot) UNIX group owning the repositories by default; it owns whole
717 # mirror repositories and at least web-writable metadata of push repositories.
718 # If you undefine this, all the data will become WORLD-WRITABLE.
719 # Both $cgi_user and $mirror_user should be members of this group!
720 our $owning_group = 'repo';
722 # Whether to use chroot jail for pushing; this must be always the same
724 # TODO: Gitosis support for $manage_users and not $chrooted?
725 our $chrooted = $manage_users;
727 # How to control permissions of push-writable data in push repositories:
728 # * 'Group' for the traditional model: The $chroot/etc/group project database
729 # file is used as the UNIX group(5) file; the directories have gid appropriate
730 # for the particular repository and are group-writable. This works only if
731 # $chrooted so that users are put in the proper groups on login when using
732 # SSH push. Smart HTTPS push does not require a chroot to work -- simply
733 # run "make install" as the non-root $mirror_user user, but leave
734 # $manage_users and $chrooted enabled.
735 # * 'ACL' for a model based on POSIX ACL: The directories are coupled with ACLs
736 # listing the users with push permissions. This works for both chroot and
737 # non-chroot setups, however it requires ACL support within the filesystem.
738 # This option is BASICALLY UNTESTED, too. And UNIMPLEMENTED. :-)
739 # * 'Hooks' for a relaxed model: The directories are world-writable and push
740 # permission control is purely hook-driven. This is INSECURE and works only
741 # when you trust all your users; on the other hand, the attack vectors are
742 # mostly just DoS or fully-traceable tinkering.
743 our $permission_control = 'Group';
745 # Path to alternate screen multiuser acl file (see screen/README, undef for none)
746 our $screen_acl_file = undef;
748 # Reserved project name and user name suffixes.
750 # Note that with personal mob branches enabled, a user name can end up being a
751 # file name after having a 'mob.' prefix added or a directory name after having
752 # a 'mob_' prefix added. If there is ANY possibility that a file with a
753 # .suffix name may need to be served by the web server, lc(suffix) SHOULD be in
754 # this hash! Pre-existing project names or user names with a suffix in this
755 # table can continue to be used, but no new projects or users can be created
756 # that have a suffix (case-insensitive) listed here.
757 our %reserved_suffixes = (
758 # Entries must be lowercase WITHOUT a leading '.'
800 ## -------------------
801 ## Size limit settings
802 ## -------------------
805 # If this is set to a non-zero value, whenever a receive-pack, mirror fetch
806 # or clone runs, git will be run with a UL_SETFSIZE value set to this value.
808 # The limit is not active while performing garbage collection or other
811 # If git attempts to create a file larger than this limit, it will receive a
812 # SIGXFSZ signal which will cause git to terminate.
814 # Note that if the actual value of UL_GETFSIZE at runtime is already less than
815 # the value set here, then that value will be silently used instead.
817 # The value represents the maximum file size allowed in units of 512-byte blocks
818 # and must be <= 2147483647 (which represents a size of 1 TiB less 512 bytes).
820 our $max_file_size512 = 8388608; # 4 GiB
822 # If this is set to a non-zero value, after an otherwise successful clone,
823 # if the repository contains more than this many objects, the clone will
824 # be considered to fail.
826 # This setting only takes effect after an otherwise successful clone which
827 # means that if $max_file_size512 is non-zero that the resulting clone did
828 # not exceed the file size limit if it fails this check.
830 our $max_clone_objects = 9999999;
834 ## -------------------------
835 ## sendmail.pl configuration
836 ## -------------------------
839 # Full information on available sendmail.pl settings can be found by running
840 # ../bin/sendmail.pl -v -h
842 # These settings will only be used if $sendmail_bin is set to 'sendmail.pl'
844 # sendmail.pl host name
845 #$ENV{'SENDMAIL_PL_HOST'} = 'localhost'; # localhost is the default
847 # sendmail.pl port name
848 #$ENV{'SENDMAIL_PL_PORT'} = '25'; # port 25 is the default
850 # sendmail.pl nc executable
851 #$ENV{'SENDMAIL_PL_NCBIN'} = "$chroot/bin/nc.openbsd"; # default is nc found in $PATH
853 # sendmail.pl nc options
854 # multiple options may be included, e.g. '-4 -X connect -x 192.168.100.10:8080'
855 #$ENV{'SENDMAIL_PL_NCOPT'} = '-4'; # force IPv4, default is to allow IPv4 & IPv6
859 ## -------------------------
860 ## Obscure Tuneable Features
861 ## -------------------------
864 # Throttle classes configured here override the defaults for them that
865 # are located in taskd/taskd.pl. See comments in that file for more info.
866 our @throttle_classes = ();
868 # Any tag names listed here will be allowed even if they would otherwise not be.
869 # Note that @allowed_tags takes precedence over @blocked_tags.
870 our @allowed_tags = (qw( ));
872 # Any tag names listed here will be disallowed in addition to the standard
873 # list of nonsense words etc. that are blocked as tags.
874 our @blocked_tags = (qw( ));
877 # If this setting is true, then tags that differ only in case will always use
878 # the same-cased version. If this setting is enabled and the tag is present in
879 # @allowed_tags (or the embedded white list in Util.pm) then the case of the
880 # tag will match the white list entry otherwise it will be all lowercased.
881 # If this setting is disabled (false) tags are used with their case left as-is.
882 # RECOMMENDED VALUE: 1 (true)
885 # If there are no more than this many objects, then all deltas will be
886 # recomputed when gc takes place. Note that this does not affect any
887 # fast-import created packs as they ALWAYS have their deltas recomputed.
888 # Also when combining small packs, if the total object count in the packs
889 # to be combined is no more than this then the new, combined pack will have
890 # its deltas recomputed during the combine operation.
891 # Leave undef to use the default (which should generally be fine).
892 # Lowering this from the default can increase disk use.
893 # Values less than 1000 * number of CPU cores will be silently ignored.
894 # The "girocco.redelta" config item can be used to modify this behavior on
895 # a per-repository basis. See the description of it in gc.sh.
896 our $new_delta_threshold = undef;
898 # This setting is irrelevant unless foreign vcs mirrors that use git fast-import
899 # are enabled (e.g. $mirror_darcs, $mirror_bzr or $mirror_hg -- $mirror_svn does
900 # NOT use git fast-import and is not affected by this setting).
901 # The packs generated by git fast-import are very poor quality. For this reason
902 # they ALWAYS have their deltas recomputed at some point. Normally this is
903 # delayed until the next full (or mini) gc takes place. For this reason a full
904 # gc is always scheduled immediately after a fresh mirror clone completes.
905 # However, in the case of normal mirror updates, several git fast-import created
906 # packs may exist as a result of changes fetched during the normal mirror update
907 # process. These packs will persist (with their git fast-import poor quality)
908 # until the next full (or mini) gc triggers. The bad deltas in these update
909 # packs could be sent down to clients who fetch updates before the next gc
910 # triggers. To reduce (i.e. practically eliminate) the likelihood of this
911 # occurring, this setting can be changed to a false (0 or undef) value in which
912 # case after each mirror update of a git fast-import mirror, any newly created
913 # git fast-import packs (as a result of the mirror update running) will have
914 # their deltas recomputed shortly thereafter instead of waiting for the next gc.
915 # Recomputing deltas immediately (almost immediately) will result in an extra
916 # redeltification step (with associated CPU cost) that would otherwise not
917 # occur and, in some cases (mainly large repositories), could ultimately result
918 # in slightly less efficient deltas being retained.
919 # RECOMMENDED VALUE: 1
920 our $delay_gfi_redelta = 1;
922 # If this is set to a true value, then core.packedGitWindowSize will be set
923 # to 1 MiB (the same as if Git was compiled with NO_MMAP set). If this is NOT
924 # set, core.packedGitWindowSize will be set to 32 MiB (even on 64-bit) to avoid
925 # memory blowout. If your Git was built with NO_MMAP set and will not work
926 # without NO_MMAP set, you MUST set this to a true value!
927 our $git_no_mmap = undef;
929 # If set to a true value, the "X-Girocco: $gitweburl" header included in all
930 # Girocco-generated emails will be suppressed.
931 our $suppress_x_girocco = undef;
933 # Number of days to keep reflogs around
934 # May be set to a value between 1 and 30 (inclusive)
935 # The default of one day should normally suffice unless there's a need to
936 # support a "Where's the undo? WHERE IS THE UNDO?!!!" option ;)
937 our $reflogs_lifetime = 7;
939 # The pack.window size to use with git upload-pack
940 # When Git is creating a pack to send down to a client, if it needs to send
941 # down objects that are deltas against objects it is not sending and that it
942 # does not know the client already has, it must undelta and recompute deltas
943 # for those objects. This is the remote's "Compressing objects" phase the
944 # client sees during a fetch or clone. If this value is unset, the normal
945 # Git default of 10 will be used for the window size during these operations.
946 # This value may be set to a number between 2 and 50 inclusive to change the
947 # window size during upload pack operations. A window size of 2 provides the
948 # fastest response at the expense of less efficient deltas for the objects
949 # being recompressed (meaning more data to send to the client). A window
950 # size of 5 typically reduces the compression time by almost half and is
951 # usually nearly as fast as a window size of 2 while providing better deltas.
952 # A window size of 50 will increase the time spent in the "Compressing objects"
953 # phase by as much as 5 times but will produce deltas similar to those that
954 # Girocco generates when it performs garbage collection.
955 # RECOMMENDED VALUE: undef or 5
956 our $upload_pack_window = 5;
958 # If this is true then remote fetching of refs/stash and refs/tgstash will
959 # be allowed. Git does not allow single-level ref names to be pushed so the
960 # only way they could get in there is if a linked working tree (or, gasp, a
961 # non-bare Girocco repository) created them or they arrived via a non-clean
962 # mirror fetch. The client almost certainly does not want to see them.
963 # Unless this config item is true they will also be left out of the bundle too.
964 # Since both stash and tgstash are used with their ref logs and there's no way
965 # for a remote to fetch ref logs, the "log --walk-reflogs" feature could not be
966 # used with them by a remote that fetched them anyway.
968 # NOTE: The reason this doesn't just control all single-level refs is that the
969 # "hideRefs" configuration mechanism isn't flexible enough to hide all
970 # single-level refs without knowing their names. In addition, it hides the
971 # entire refs hierarchy so refs/stash/foo will also be hidden along with
972 # refs/stash, but Git doesn't actually support ref names that introduce a
973 # directory/file confict (aka D/F conflict) and "refs/stash" represents an
974 # official Git ref name therefore any refs/stash/... names really aren't
975 # allowed in the first place so it's no problem if they're incidentally hidden
976 # along with refs/stash itself.
978 # NOTE: Git 1.8.2 or later is required to actually hide the refs from fetchers
979 # over the "git:" protocol and Git 2.3.5 or later is required to properly hide
980 # them over the smart "http:" protocol (Girocco will not attempt to "hide" them
981 # on a smart HTTP fetch if Git is < 2.3.5 to avoid Git bugs.) They will never
982 # be hidden via the non-smart HTTP fetch or any other non-smart protocols that
983 # also make use of the $gitdir/info/refs file as they are not excluded from it.
984 # Nor will they be hidden when accessed via any non-Girocco mechanism.
985 # They will, however, always be excluded from the primary (aka .bitmap) pack
986 # and bundle no matter what version of Git is used unless this is set to a
987 # true value. It's only the server's Git version that matters when hiding refs.
989 # RECOMMENDED VALUE: undef or 0
990 our $fetch_stash_refs = undef;
992 # When set to a true value, Girocco will attempt to pick up ref changes made
993 # outside of Girocco itself and process them using the usual Girocco
994 # notification mechanism. Git lacks any "post-ref-change" hook capability that
995 # could facilitate this. This feature is primarily intended to detect running
996 # of "git fetch" in linked working trees of a Girocco repository. In many
997 # cases after running a command Git runs "git gc --auto". With the correct
998 # encouragement we can always induce Git to run our pre-auto-gc hook at that
999 # time. "git fetch" invokes "git gc --auto" after the fetch. Girocco needs
1000 # to do additional maintenance to make this work properly so do not enable this
1001 # unless it's really needed. Additionally, there are a number of commands
1002 # (such as "git commit") that do not invoke "git gc --auto". Even with this
1003 # enabled, additional hooks for post-rewrite and post-checkout
1004 # would really be needed to catch more things and even then there are some
1005 # Git commands that would never be caught ("git filter-branch",
1006 # "git update-ref", "git reset", etc.) so this is hardly a complete solution.
1007 # But it WILL catch "git fetch" changes although the hashes it uses for the
1008 # "old" ref values may not be all that recent, the new ref values will be.
1009 # When this is false, the hack is completely disabled.
1010 # When this is true, the hack is enabled by default for all repositories,
1011 # but can be controlled on an individual repository basis by setting the
1012 # girocco.autogchack value explicitly to true (enable) or false (disable).
1013 # If this is set to the special value "mirror" then it will behave as true
1014 # for mirrors and false for non-mirrors thereby completely eliminating any
1015 # overhead for push projects but detecting external "git fetch"s for mirrors.
1016 # If this is enabled for a project, any third party script/tool can trigger
1017 # the Girocco ref notification mechanism simply by making a ref change and
1018 # then running "git gc --auto --quiet" on the project. In a capitulation to
1019 # use of linked working trees, Girocco installs a post-commit hook that will
1020 # trigger these notifications as well when this is enabled.
1021 our $autogchack = 0;
1023 # When set to a true value the initial setting for core.hooksPath will point
1024 # to the repository's own hooks directory instead of $reporoot/_global/hooks.
1025 # Due to the unfortunate implementation of core.hooksPath, Girocco must always
1026 # ensure the value gets set in each repository's config file. Normally it
1027 # just sets it to $reporoot/_global/hooks and that's that. However, the
1028 # update-all-config script will also tolerate it pointing at the repository's
1029 # own hooks directory -- Girocco maintains symbolic links in there to the
1030 # global hooks to make sure they get run when using older versions of Git;
1031 # therefore that setting is basically equivalent. The difference is that
1032 # repository-specific hooks can be added when hooksPath is pointing at the
1033 # repository's hooks directory but not when it's pointing at _global/hooks.
1034 # A repository's setting can be changed manually (and it will stick), but
1035 # sometimes it may be desirable to always just default to pointing at the
1036 # repository's own hooks directory from the start. Perhaps linked working
1037 # trees will be in use and software that needs to set repository-specific hooks
1038 # will be in use. If $autogchack has been set to true this may very likely be
1040 our $localhooks = 0;
1042 # If this is set to a true value changes to single-level refs (e.g. refs/stash)
1043 # will be passed through to the notification machinery.
1044 # Usually this is NOT wanted, especially when linked working trees are being
1045 # used with the repository.
1046 # However, in the unlikely event that changes to such ref names should NOT be
1047 # ignored, this value may be set to any true value.
1048 # RECOMMENDED VALUE: 0
1049 our $notify_single_level = 0;
1051 # If this is set to a non-empty value it will become the default value for
1052 # all repositories' girocco.notifyHook value.
1053 # Whenever taskd.pl receives a batch of ref changes for processing, it first
1054 # sends them off to any configured "girocco.notifyHook" (same semantics as
1055 # a post-receive hook except it also gets four command-line arguments like
1056 # so: cat ref-changes | notifyhook $projname $user $linecount $contextlinecount
1057 # There is no default notify hook, but each repository may set its own by
1058 # setting the `girocco.notifyHook` config value which will be eval'd by the
1059 # shell (like $GIT_EDITOR is) with the current directory set to the
1060 # repository's git-dir and the changes on standard input.
1061 # Note that normal notification processing does not take place until after
1062 # this command (if it's not null) gets run (regardless of its result code).
1063 our $default_notifyhook = undef;
1065 # UNIX group owning the repositories' htmlcache subdirectory
1066 # If not defined defaults to $owning_group
1067 # If gitweb access is provided but only on a read-only basis, then setting
1068 # this to a group to which Both $cgi_user and $mirror_user belong will still
1069 # allow summary page caching.
1070 # $mirror_user should always belong to this group
1071 our $htmlcache_owning_group = undef;
1073 # UNIX group owning the repositories' ctags subdirectory
1074 # If not defined defaults to $owning_group
1075 # If gitweb access is provided but only on a read-only basis, then setting
1076 # this to a group to which Both $cgi_user and $mirror_user belong will still
1077 # allow tags to be added to the repository in gitweb (provided that feature
1078 # is enabled in gitweb/gitweb_config.perl).
1079 # $mirror_user should always belong to this group
1080 our $ctags_owning_group = undef;
1082 # When using pack bitmaps and computing data to send to clients over a fetch,
1083 # having pack.writeBitmapHashCache set to true produces better deltas (thereby
1084 # potentially reducing the amount of data that needs to be sent). However,
1085 # JGit does not understand this extra data, so if JGit needs to use the bitmaps
1086 # generated when Girocco runs Git, this setting needs to be set to a true value
1087 # so that the hash cache is excluded when Git generates the bitmaps thereby
1088 # making them compatible with JGit.
1089 # Note that changes to this setting will not take effect until the next time
1090 # gc is scheduled to run on a project and then only if gc actually takes place.
1091 # Use the $basedir/toolbox/make-all-gc-eligible.sh script to force all projects
1092 # to actually do a gc the next time they are scheduled for one.
1093 # RECOMMENDED VALUE: undef or 0
1094 our $jgit_compatible_bitmaps = 0;
1096 # Set the default value of receive.maxInputSize
1097 # This is only effective for receives (aka an incoming push) and causes the
1098 # push to abort if the incoming pack (which is generally thin and does not
1099 # have any index) exceeds this many bytes in size (a 'k', 'm' or 'g' suffix
1100 # may be used on the value). If undef or set to 0 there is no limit. This
1101 # limit is only effective when Girocco is running Git v2.11.0 or later.
1102 our $max_receive_size = undef;
1104 # Suppress git: and ssh: log messages
1105 # Access via http: and/or https: provides logging of the project being
1106 # cloned/fetched/pushed to. There is normally no such logging for access
1107 # via ssh: and/or git: protocols. However, Girocco intercepts those
1108 # accesses to perform sanity and permision checks and also logs the request
1109 # to the system log at that time. By setting this value to any true
1110 # value, that logging of git: and ssh: git activity will be suppressed.
1111 # RECOMMENDED VALUE: 0
1112 our $suppress_git_ssh_logging = 0;
1114 # Select the sshd to be installed into the chroot
1115 # If set this MUST be an absolute path
1116 # Ignored unless a chroot is actually being created
1117 # Leaving this undef will find sshd in "standard" system locations and
1118 # is the recommended value. Only set this if you need to override the
1119 # "standard" sshd for some reason.
1120 # RECOMMENDED VALUE: undef
1121 our $sshd_bin = undef;
1125 ## ------------------------
1126 ## Sanity checks & defaults
1127 ## ------------------------
1129 # Changing anything in this section can result in unexpected breakage
1131 # Couple of sanity checks and default settings (do not change these)
1132 use Digest
::MD5
qw(md5);
1133 use MIME
::Base64
qw(encode_base64);
1134 $name =~ s/\s+/_/gs;
1135 $nickname = lc((split(/[.]/, $name))[0]) unless $nickname;
1136 $nickname =~ s/\s+/_/gs;
1137 our $tmpsuffix = substr(encode_base64
(md5
($name.':'.$nickname)),0,6);
1138 $tmpsuffix =~ tr
,+/,=_
,;
1139 ($mirror_user) or die "Girocco::Config: \$mirror_user must be set even if to current user";
1140 ($basedir) or die "Girocco::Config: \$basedir must be set";
1141 ($sendmail_bin) or die "Girocco::Config: \$sendmail_bin must be set";
1142 $sendmail_bin = "$basedir/bin/sendmail.pl" if $sendmail_bin eq "sendmail.pl";
1143 $screen_acl_file = "$basedir/screen/giroccoacl" unless $screen_acl_file;
1144 $jailreporoot =~ s
,^/+,,;
1145 ($reporoot) or die "Girocco::Config \$reporoot must be set";
1146 ($jailreporoot) or die "Girocco::Config \$jailreporoot must be set";
1147 $disable_jailsetup = $disable_jailsetup ?
1 : '';
1148 $notify_single_level = $notify_single_level ?
1 : '';
1149 $fetch_stash_refs = $fetch_stash_refs ?
1 : '';
1150 (not $mob or $mob eq 'mob') or die "Girocco::Config \$mob must be undef (or '') or 'mob'";
1151 (not $min_key_length or $min_key_length =~ /^[1-9][0-9]*$/)
1152 or die "Girocco::Config \$min_key_length must be undef or numeric";
1153 (! defined $max_readme_size || $max_readme_size =~ /^[0-9]+$/)
1154 or die "Girocco::Config \$max_readme_size must be a whole number";
1155 (defined $mailsh_sizelimit and $mailsh_sizelimit =~ /^[1-9][0-9]*$/)
1156 or die "Girocco::Config \$mailsh_sizelimit must be a positive number";
1157 $admincc = $admincc ?
1 : 0;
1158 $rootcert = "$certsdir/girocco_root_crt.pem" if $httpspushurl && !$rootcert;
1159 $clientcert = "$certsdir/girocco_client_crt.pem" if $httpspushurl && !$clientcert;
1160 $clientkey = "$certsdir/girocco_client_key.pem" if $httpspushurl && !$clientkey;
1161 $clientcertsuffix = "$certsdir/girocco_client_suffix.pem" if $httpspushurl && !$clientcertsuffix;
1162 $mobusercert = "$certsdir/girocco_mob_user_crt.pem" if $httpspushurl && $mob && !$mobusercert;
1163 $mobuserkey = "$certsdir/girocco_mob_user_key.pem" if $httpspushurl && $mob && !$mobuserkey;
1164 our $mobpushurl = $pushurl;
1165 $mobpushurl =~ s
,^ssh
://,ssh
://mob@
,i
if $mobpushurl;
1166 $disable_dsa = 1 unless $pushurl;
1167 $disable_dsa = $disable_dsa ?
1 : '';
1168 our $httpdnsname = ($gitweburl =~ m
,https?
://([A
-Za
-z0
-9.-]+),i
) ?
lc($1) : undef if $gitweburl;
1169 our $httpsdnsname = ($httpspushurl =~ m
,https
://([A
-Za
-z0
-9.-]+),i
) ?
lc($1) : undef if $httpspushurl;
1170 $SmartHTTPOnly = $SmartHTTPOnly ?
1 : '';
1171 $TLSHost = $TLSHost ?
1 : '';
1172 $pretrustedroot = $pretrustedroot ?
1 : '';
1173 $suppress_git_ssh_logging = $suppress_git_ssh_logging ?
1 : '';
1174 ($mirror or $push) or die "Girocco::Config: neither \$mirror nor \$push is set?!";
1175 (not $push or ($pushurl or $httpspushurl or $gitpullurl or $httppullurl)) or die "Girocco::Config: no pull URL is set";
1176 (not $push or ($pushurl or $httpspushurl)) or die "Girocco::Config: \$push set but \$pushurl and \$httpspushurl are undef";
1177 (not $mirror or $mirror_user) or die "Girocco::Config: \$mirror set but \$mirror_user is undef";
1178 ($manage_users == $chrooted) or die "Girocco::Config: \$manage_users and \$chrooted must be set to the same value";
1179 (not $chrooted or $permission_control ne 'ACL') or die "Girocco::Config: resolving uids for ACL not supported when using chroot";
1180 (grep { $permission_control eq $_ } qw(Group Hooks)) or die "Girocco::Config: \$permission_control must be set to Group or Hooks";
1181 ($chrooted or not $mob) or die "Girocco::Config: mob user supported only in the chrooted mode";
1182 (not $httpspushurl or $httpsdnsname) or die "Girocco::Config invalid \$httpspushurl does not start with https://domainname";
1183 (not $svn_log_window_size or $svn_log_window_size =~ /^[1-9][0-9]*$/)
1184 or die "Girocco::Config \$svn_log_window_size must be undef or numeric";
1185 (defined($max_file_size512) && !$max_file_size512) and $max_file_size512 = undef;
1186 (not defined($max_file_size512) or $max_file_size512 =~ /^[1-9][0-9]*$/ && $max_file_size512 <= 2147483647)
1187 or die "Girocco::Config \$max_file_size512 must be undef or a positive integer <= 2147483647";
1188 (defined($max_clone_objects) && !$max_clone_objects) and $max_clone_objects = undef;
1189 (not defined($max_clone_objects) or $max_clone_objects =~ /^[1-9][0-9]*$/)
1190 or die "Girocco::Config \$max_clone_objects must be undef or a positive integer";
1191 (not $posix_sh_bin or $posix_sh_bin !~ /\s/) or die "Girocco::Config: \$posix_sh_bin must not contain any whitespace";
1192 (not $perl_bin or $perl_bin !~ /\s/) or die "Girocco::Config: \$perl_bin must not contain any whitespace";
1193 !$delay_gfi_redelta and $delay_gfi_redelta = undef;
1194 !$git_no_mmap and $git_no_mmap = undef;
1195 !$suppress_x_girocco and $suppress_x_girocco = undef;
1196 !$jgit_compatible_bitmaps and $jgit_compatible_bitmaps = undef;
1197 !$autogchack and $autogchack = undef;
1198 (not $reflogs_lifetime or $reflogs_lifetime !~ /^[1-9][0-9]*$/) and $reflogs_lifetime = 1;
1199 $reflogs_lifetime = 0 + $reflogs_lifetime;
1200 $reflogs_lifetime >= 0 or $reflogs_lifetime = 1;
1201 $reflogs_lifetime <= 30 or $reflogs_lifetime = 30;
1202 (not defined $upload_pack_window or $upload_pack_window =~ /^[1-9][0-9]*$/)
1203 or die "Girocco::Config \$upload_pack_window must be undef or numeric";
1204 (not defined $upload_pack_window or $upload_pack_window >= 2 && $upload_pack_window <= 50)
1205 or die "Girocco::Config \$upload_pack_window must be in range 2..50";
1206 (not defined $max_receive_size or $max_receive_size =~ /^\d+[kKmMgG]?$/)
1207 or die "Girocco::Config \$max_receive_size setting is invalid";
1208 defined($ENV{'SENDMAIL_PL_HOST'}) and our $sendmail_pl_host = $ENV{'SENDMAIL_PL_HOST'};
1209 defined($ENV{'SENDMAIL_PL_PORT'}) and our $sendmail_pl_port = $ENV{'SENDMAIL_PL_PORT'};
1210 defined($ENV{'SENDMAIL_PL_NCBIN'}) and our $sendmail_pl_ncbin = $ENV{'SENDMAIL_PL_NCBIN'};
1211 defined($ENV{'SENDMAIL_PL_NCOPT'}) and our $sendmail_pl_ncopt = $ENV{'SENDMAIL_PL_NCOPT'};
1212 defined($ENV{'PYTHON'}) and our $python = $ENV{'PYTHON'};
1213 my $op; BEGIN {$op = $ENV{'PATH'}}
1214 defined($op) && defined($ENV{'PATH'}) && $op ne $ENV{'PATH'} and our $path=$ENV{'PATH'};
1216 # jailreporoot MUST NOT be absolute
1217 defined($jailreporoot) && substr($jailreporoot, 0, 1) ne "/" or
1218 die "\$jailreporoot MUST NOT be an absolute path\n";
1220 # webreporoot can be undef
1221 !defined($webreporoot) || substr($webreporoot, 0, 1) eq "/" or
1222 die "\$webreporoot MUST be an absolute path if not undef\n";
1224 # All these MUST be absolute paths
1227 defined(${$_}) && substr(${$_}, 0, 1) eq "/" or
1228 die "\$$_ MUST be an absolute path\n"
1229 foreach qw(basedir certsdir reporoot chroot webroot cgiroot projlist_cache_dir);
1232 # Make sure Git has a consistent and reproducible environment
1234 $ENV{'XDG_CONFIG_HOME'} = $chroot.'/var/empty';
1235 $ENV{'HOME'} = $chroot.'/etc/girocco';
1236 $ENV{'TMPDIR'} = '/tmp';
1237 $ENV{'GIT_CONFIG_NOSYSTEM'} = 1;
1238 $ENV{'GIT_ATTR_NOSYSTEM'} = 1;
1239 $ENV{'GIT_NO_REPLACE_OBJECTS'} = 1;
1240 $ENV{'GIT_TERMINAL_PROMPT'} = 0;
1241 $ENV{'GIT_ASKPASS'} = $basedir.'/bin/git-askpass-password';
1242 delete $ENV{'GIT_USER_AGENT'};
1243 $ENV{'GIT_USER_AGENT'} = $git_client_ua if defined($git_client_ua);
1244 delete $ENV{'GIT_HTTP_USER_AGENT'};
1245 delete $ENV{'GIT_CONFIG_PARAMETERS'};
1246 delete $ENV{'GIT_ALTERNATE_OBJECT_DIRECTORIES'};
1247 delete $ENV{'GIT_CONFIG'};
1248 delete $ENV{'GIT_DIR'};
1249 delete $ENV{'GIT_GRAFT_FILE'};
1250 delete $ENV{'GIT_INDEX_FILE'};
1251 delete $ENV{'GIT_OBJECT_DIRECTORY'};
1252 delete $ENV{'GIT_NAMESPACE'};
1254 # Guarantee a sane umask for Girocco
1256 umask(umask() & ~0770);