Enable Content-scan in template client config
[buildfarm-client.git] / build-farm.conf.template
index 1afd0fb2d05d0d6c61652742f97fd90d920daf91..eb856176dc96c4982e33651fd59523ae7880b6b5 100644 (file)
@@ -17,6 +17,9 @@ use warnings;
 
 my $branch = $::branch;
 
+# This could be changed to use the standard layout but in a different place
+my $basedir = "$ENV{HOME}";
+
 # This template assumes that the user running the buildfarm process is "farm"
 my $farm_user_name = getpwuid($<) // die "$0: can't get user name from uid $<: $!\n";
 
@@ -41,25 +44,29 @@ our %conf =(
     tar_log_cmd => undef,
     # If running multiple animals, an explicit common directory for
     # the lockfile so that runs do not conflict. Otherwise, leave unset.
-    global_lock_dir => $ENV{HOME},
+    global_lock_dir => $basedir,
     # this directory must exist before anything will work
-    build_root => "$ENV{HOME}/buildfarm",
+    build_root => "$basedir/buildfarm",
     # set true to do vpath builds
     use_vpath => undef,
 
     keep_error_builds => 0,
     # Linux style, use "*.core" for BSD
-    core_file_glob => "core*",
+    core_file_glob => 'core*',
+
+    # Note about HTTPS: HTTPS support is experimental. For a
+    # limited time you may try to use HTTP, in case HTTPS doesn't
+    # work for you.
 
     # build process will connect to this URL to upload results
-    target => 'http://buildfarm.exim.org/cgi-bin/eximstatus.pl',
+    target => 'https://buildfarm.exim.org/cgi-bin/eximstatus.pl',
     # update_personality uses this when you want to update your
     # machine's info (OS, version, compiler, version)
-    upgrade_target => 'http://buildfarm.exim.org/cgi-bin/upgrade.pl',
+    upgrade_target => 'https://buildfarm.exim.org/cgi-bin/upgrade.pl',
 
     # Your host alias and password in the BuildFarm
-    animal => "alias_assigned_by_build_team",
-    secret => "secret_assigned_by_build_team",
+    animal => 'alias_assigned_by_build_team',
+    secret => 'secret_assigned_by_build_team',
 
     # allow automatic updates of the buildfarm client code.
     # Leave it *unset* to get the default behaviour, set it
@@ -100,8 +107,10 @@ our %conf =(
     trigger_include => undef,
 
     # settings for mail notices - default to notifying nobody
+    # (putting the operator of the animal is a good idea)
     # these lists contain addresses to be notified
     # must be complete email addresses, as the email is sent from the server
+    # put single-quote (') around the address string
     mail_events =>{
         all => [], # unconditional
         fail => [], # if this build fails
@@ -115,7 +124,7 @@ our %conf =(
     build_env =>{
         # use a dedicated cache for the build farm. this should give us
         # very high hit rates and slightly faster cache searching.
-        CCACHE_DIR => "$ENV{HOME}/buildfarm/ccache/$branch",
+        CCACHE_DIR => "$basedir/buildfarm/ccache/$branch",
 
         ### set this if you need a proxy setting for the
         # outbound web transaction that reports the results
@@ -130,20 +139,30 @@ our %conf =(
     # previous definitions of variables.  Example:
     # LDFLAGS => '-Wall' will create LDFLAGS = '-Wall'
     makefile_set =>{
-        # comment out if not using ccache
-        CC => 'ccache gcc',
+        # uncomment to use ccache
+        #CC => 'ccache gcc',
         # Required for some tests to pass
         AUTH_PLAINTEXT => 'yes',
         SUPPORT_MAILDIR => 'yes',
         # Other examples. Could use makefile_regex instead.
+        #
+       WITH_CONTENT_SCAN => 'yes',
         #SUPPORT_TLS => 'yes',
-        #USE_OPENSSL_PC => 'openssl',
+        #  Enable the proper libs here or see in makefile_regex
+        #  for use of pkg-config
+        #USE_GNUTLS => 'yes'
         #TLS_LIBS => '-lssl -lcrypto',
-        #EXPERIMENTAL_SPF => 'yes',
+        #
         #LOOKUP_LDAP => 'yes',
         #LOOKUP_INCLUDE => '-I/usr/include/mysql -I/usr/include/postgresql'
         #LOOKUP_LIBS => '-lmysqlclient -lpq -lldap -llber',
         #LDAP_LIB_TYPE => 'OPENLDAP2',
+        #LOOKUP_MYSQL => 'yes',
+        #LOOKUP_PGSQL => 'yes',
+        #SUPPORT_PROXY => 'yes',
+        #SUPPORT_SOCKS => 'yes',
+        #EXPERIMENTAL_SPF => 'yes',
+        #EXPERIMENTAL_DANE => 'yes',
     },
     # Settings to add to Local/Makefile. These will add to variables that
     # are already defined earlier in the Makefile.  Example:
@@ -163,16 +182,13 @@ our %conf =(
     makefile_regex =>[
         # If have perl devel libraries installed, can build embedded perl
         #q(s/^# EXIM_PERL=/EXIM_PERL=/),
-        # If have mysql devel libraries installed
-        #q(s/^# LOOKUP_MYSQL=/LOOKUP_MYSQL=/),
-        # If have postgres devel librarires installed
-        #q(s/^# LOOKUP_PGSQL=/LOOKUP_PGSQL=/),
-        # Severl experimental features to consider
-        #q(s/^# EXPERIMENTAL_CERTNAMES.*/EXPERIMENTAL_CERTNAMES=yes/),
-        #q(s/^# EXPERIMENTAL_DNSSEC.*/EXPERIMENTAL_DNSSEC=yes/),
-        # Proxy causes some extra debug output messing with tests
-        #q(s/^# EXPERIMENTAL_PROXY.*/EXPERIMENTAL_PROXY=yes/),
-        #q(s/^# EXPERIMENTAL_TPDA.*/EXPERIMENTAL_TPDA=yes/),
+        # Use SSL libraries
+        #q(s/^# (USE_GNUTLS(?:_PC)?=.*)/$1/),
+        #q(s/^# (USE_OPENSSL_PC=.*)/$1/),
+        # Several experimental features to consider
+        # May be outdated, please check a current EDITME for
+        # for options.
+        #q(s/^# (EXPERIMENTAL_CERTNAMES.*)/$1/),
     ],
 
     # The user compiled as the master exim username.
@@ -180,11 +196,13 @@ our %conf =(
     # the group of the exim user as a secondary group. Example:
     # user=>farm, group=>farm, secondary_groups=>exim
     # user=>exim, group=>exim
-    master_exim_user => "exim",
+    master_exim_user => 'exim',
 
     # Range of tests to run if enable make_test in optional steps.
-    #range_num_tests => '1 999',
-    range_num_tests => '1 5999',
+    # Start with just a couple while getting the aminal set up,
+    # then enable the full set
+    range_num_tests => '1 2',
+    #range_num_tests => '1 5999',
     # Hardcode some valid version for use during make test
     exim_test_version => '4.84',