nik/davical
1
0
Fork 0
mirror of https://gitlab.com/davical-project/davical.git synced 2026-08-29 18:26:05 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Mass tidy up of whitespace in sample config.

Browse Source
This commit is contained in:
Andrew Ruthven 2022-12-19 23:07:27 +13:00 committed by Andrew Ruthven
parent c9ac75173b
commit a054d16390
1 changed files with 132 additions and 100 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

232
config/example-config.php
View File

@ -73,7 +73,7 @@ $c->pg_connect[] = "dbname=davical user=davical_app";
* a user has lost his password and clicks on the "Help! I've forgotten my
* password" on the login page.
*/
$c->admin_email ='calendar-admin@example.com';
$c->admin_email = 'calendar-admin@example.com';
/**
* Set this to 'true' in order to restrict the /setup.php page (which contains
@ -91,7 +91,7 @@ $c->admin_email ='calendar-admin@example.com';
* will be redirected to 'caldav.php', unless the restrictions are fulfilled.
*/
// $c->restrict_admin_domain = 'admin.davical.example.com';
// $c->restrict_admin_port = '8443';
// $c->restrict_admin_port = '8443';
/**
* The "enable_row_linking" option controls whether javascript is used
@ -108,6 +108,7 @@ $c->admin_email ='calendar-admin@example.com';
* These should be an array of style sheets with a path specified relative
* to the root directory. Used for overriding display styles in the admin
* interface.
*
* e.g. : $c->local_styles = array('/css/my.css');
*/
// $c->local_styles = array();
@ -119,7 +120,9 @@ $c->admin_email ='calendar-admin@example.com';
* false, users need the READ privilege to display another principal and their
* collections, and they need to be in the same group with another principal to
* find them in a drop-down list for granting privileges.
*
* Admins will still be able to see all accounts.
*
* Default: true
*/
// $c->list_everyone = false;
@ -132,16 +135,18 @@ $c->admin_email ='calendar-admin@example.com';
* and allowing it to be changed locally is not helpful. In this case the UI
* is disabled and an HREF displayed to take the user to the appropriate place for
* facilitating that.
*
* As well as the Administration UI, this will also affect the Forgotten Password
* UI since it would create a temporary local password. The login HTML rendered by
* libawl-php is over-ridden and replaced by the same HREF as above.
* Users with Administrator privileges will still see the default password change UI.
*
* Default: unset
*/
// $c->password_change_override = array(
// 'href' => 'https://my.password/changer',
// 'label' => 'My Password Changer'
// );
// 'href' => 'https://my.password/changer',
// 'label' => 'My Password Changer'
// );
/***************************************************************************
* *
@ -166,7 +171,7 @@ $c->admin_email ='calendar-admin@example.com';
* is almost as useful. This should be the minimum for any support request on
* the mailing list or issue tracker.
*/
// $c->dbg["request"] = 1; // The request headers & content
// $c->dbg["request"] = 1; // The request headers & content
// $c->dbg['response'] = 1; // The response headers & content
/**
@ -207,7 +212,7 @@ $c->admin_email ='calendar-admin@example.com';
* home_calendar_name: 'calendar'
* home_addressbook_name: 'addresses'
*/
// $c->home_calendar_name = 'calendar';
// $c->home_calendar_name = 'calendar';
// $c->home_addressbook_name = 'addresses';
/**
@ -225,14 +230,26 @@ $c->admin_email ='calendar-admin@example.com';
/**
* If the above options are not suitable for your new users, use this to create
* a more complex default collection management.
*
* Note: if you use this configuration option both $c->home_calendar_name and
* $c->home_addressbook_name are ignored!
*
* See https://wiki.davical.org/index.php/Configuration/settings/default_collections
*/
//$c->default_collections=array(
// array('type'=>'addressbook', 'name'=>'addresses', 'displayname'=>'%fn addressbook', 'privileges'=>null),
// array('type'=>'calendar', 'name'=>'calendar', 'displayname'=>'%fn calendar', 'privileges'=>null)
//);
// $c->default_collections = array(
// array(
// 'type' => 'addressbook',
// 'name' => 'addresses',
// 'displayname' => '%fn addressbook',
// 'privileges' => null
// ),
// array(
// 'type' => 'calendar',
// 'name' => 'calendar',
// 'displayname' => '%fn calendar',
// 'privileges' => null
// )
// );
/**
* An array of groups / permissions which should be automatically added
@ -266,11 +283,12 @@ $c->admin_email ='calendar-admin@example.com';
*
* Default: none
*/
// $c->template_usr = array( 'active' => true,
// 'locale' => 'it_IT',
// 'date_format_type' => 'E',
// 'email_ok' => date('Y-m-d')
// );
// $c->template_usr = array(
// 'active' => true,
// 'locale' => 'it_IT',
// 'date_format_type' => 'E',
// 'email_ok' => date('Y-m-d')
// );
/**
* If "hide_TODO" is true, then VTODO requested from someone other than the
@ -287,6 +305,8 @@ $c->admin_email ='calendar-admin@example.com';
* calendar will not be included in the response. The default is false because
* the preferred behaviour is to enable/disable the alarms in your CalDAV
* client software.
*
* Default: false
*/
// $c->hide_alarm = true;
@ -298,6 +318,7 @@ $c->admin_email ='calendar-admin@example.com';
/**
* Hide bound collections from certain clients
*
* If you want to use iOS (which does not support delegation) in combination
* with other software which does supports degation, you can use this option
* to tailor a working solution: bind all collections you want to see on iOS
@ -352,6 +373,7 @@ $c->admin_email ='calendar-admin@example.com';
* is returned. Set the value to true to support the property only if your
* client requires it, however note that PROPFIND performance may be
* adversely affected if you do so.
*
* Introduced in DAViCal version 1.1.4 in support of Issue #31 Database
* Performance Improvements.
*
@ -361,6 +383,7 @@ $c->admin_email ='calendar-admin@example.com';
/**
* The default locale will be "en_NZ";
*
* If you are in a non-English locale, you can set the default_locale
* configuration to one of the supported locales.
*
@ -419,6 +442,7 @@ $c->admin_email ='calendar-admin@example.com';
/**
* Disable calendar-proxy-{read,write} on PROPFIND
*
* This can be useful if clients are known to not use this information,
* as it is very expensive to compute (especially on servers with lots of
* users who share their collections) and most clients will never use it,
@ -618,58 +642,60 @@ $c->admin_email ='calendar-admin@example.com';
* For Active Directory go down to the next example.
*/
//$c->authenticate_hook['call'] = 'LDAP_check';
//$c->authenticate_hook['config'] = array(
// 'host' => 'www.tennaxia.net', //host name of your LDAP Server
// 'port' => '389', //port
// $c->authenticate_hook['call'] = 'LDAP_check';
// $c->authenticate_hook['config'] = array(
// 'host' => 'www.tennaxia.net', //host name of your LDAP Server
// 'port' => '389', //port
/* For the initial bind to be anonymous leave bindDN and passDN
commented out */
// DN to bind to this server enabling to perform request
// 'bindDN'=> 'cn=manager,cn=internal,dc=tennaxia,dc=net',
// Password of the previous bindDN to bind to this server enabling to perform request
// 'passDN'=> 'xxxxxxxx',
// DN and password if rquired to bind to this server for initial queries
// 'bindDN' => 'cn=manager,cn=internal,dc=tennaxia,dc=net',
// 'passDN' => 'xxxxxxxx',
// 'protocolVersion' => '3', //Version of LDAP protocol to use
// 'optReferrals' => 0, //whether to automatically follow referrals returned by the LDAP server
// 'networkTimeout' => 10, //timeout in seconds
// 'baseDNUsers'=> 'dc=tennaxia,dc=net', //where to look at valid user
// 'filterUsers' => 'objectClass=kolabInetOrgPerson', //filter which must validate a user according to RFC4515, i.e. surrounded by brackets
// 'baseDNGroups' => 'ou=divisions,dc=tennaxia,dc=net', //where to look for groups
// 'filterGroups' => 'objectClass=groupOfUniqueNames', //filter with same rules as filterUsers
// 'protocolVersion' => '3', // Version of LDAP protocol to use
// 'optReferrals' => 0, // whether to automatically follow referrals returned by the LDAP server
// 'networkTimeout' => 10, // timeout in seconds
// 'baseDNUsers' => 'dc=tennaxia,dc=net', // where to look at valid user
// 'filterUsers' => 'objectClass=kolabInetOrgPerson', // filter which must validate a user according to RFC4515, i.e. surrounded by brackets
// 'baseDNGroups' => 'ou=divisions,dc=tennaxia,dc=net', // where to look for groups
// 'filterGroups' => 'objectClass=groupOfUniqueNames', // filter with same rules as filterUsers
/** /!\ "username" should be set and "modified" must be set **/
// 'mapping_field' => array("username" => "uid",
// "modified" => "modifyTimestamp",
// "fullname" => "cn" ,
// "email" =>"mail"
// ), //used to create the user based on his ldap properties
// 'group_mapping_field' => array("username" => "cn",
// "modified" => "modifyTimestamp",
// "fullname" => "cn" ,
// "members" =>"memberUid"
// ), //used to create the group based on the ldap properties
// 'group_member_dnfix' => true, // if your "members" field contains the full DN and needs to be truncated to just the uid
// 'mapping_field' => array("username" => "uid",
// "modified" => "modifyTimestamp",
// "fullname" => "cn" ,
// "email" => "mail"
// ), // used to create the user based on their ldap properties
// 'group_mapping_field' => array("username" => "cn",
// "modified" => "modifyTimestamp",
// "fullname" => "cn" ,
// "members" => "memberUid"
// ), // used to create the group based on the ldap properties
// 'group_member_dnfix' => true, // if your "members" field contains the full DN and needs to be truncated to just the uid
/** used to set default value for all users, will be overcharged by ldap if defined also in mapping_field **/
// 'default_value' => array("date_format_type" => "E","locale" => "fr_FR"),
// 'default_value' => array("date_format_type" => "E","locale" => "fr_FR"),
/** foreach key set start and length in the string provided by ldap
example for openLDAP timestamp : 20070503162215Z **/
// 'format_updated'=> array('Y' => array(0,4),'m' => array(4,2),'d'=> array(6,2),'H' => array(8,2),'M'=>array(10,2),'S' => array(12,2)),
// 'startTLS' => 'yes', // Require that TLS is used for LDAP?
// 'format_updated' => array('Y' => array(0,4), 'm' => array(4,2), 'd' => array(6,2), 'H' => array(8,2), 'M' => array(10,2), 'S' => array(12,2)),
// 'startTLS' => 'yes', // Require that TLS is used for LDAP?
// If ldap_start_tls is not working, it is probably
// because php wants to validate the server's
// certificate. Try adding "TLS_REQCERT never" to the
// ldap configuration file that php uses (e.g. /etc/ldap.conf
// or /etc/ldap/ldap.conf). Of course, this lessens security!
// 'scope' => 'subtree', // Search scope to use, defaults to subtree.
// // Allowed values: base, onelevel, subtree.
// 'scope' => 'subtree', // Search scope to use, defaults to subtree.
// // Allowed values: base, onelevel, subtree.
//
// );
//
// /* If there is some user/group you do not want to sync from LDAP, put their username in these lists */
// $c->do_not_sync_from_ldap = array( 'admin' => true );
// $c->do_not_sync_group_from_ldap = array( 'teamclient1' => true );
// /* If there is some user/group you do not want to sync from LDAP, put their username in these lists */
// $c->do_not_sync_from_ldap = array( 'admin' => true );
// $c->do_not_sync_group_from_ldap = array( 'teamclient1' => true );
//
//include('drivers_ldap.php');
// include('drivers_ldap.php');
/*
* Use the following LDAP example if you are using Active Directory
@ -677,28 +703,29 @@ $c->admin_email ='calendar-admin@example.com';
* You will need to change host, passDN and DOMAIN in bindDN
* and baseDNUsers.
*/
//$c->authenticate_hook['call'] = 'LDAP_check';
//$c->authenticate_hook['config'] = array(
// 'host' => 'ldap://ldap.example.net',
// 'bindDN' => 'auth@DOMAIN',
// 'passDN' => 'secret',
// 'baseDNUsers' => 'dc=DOMAIN,dc=local',
// 'protocolVersion' => 3,
// 'optReferrals' => 0,
// 'networkTimeout' => 10,
// 'filterUsers' => '(&(objectcategory=person)(objectclass=user)(givenname=*))',
// 'mapping_field' => array("username" => "uid",
// "fullname" => "cn" ,
// "email" => "mail"),
// 'default_value' => array("date_format_type" => "E","locale" => "en_NZ"),
// 'format_updated' => array('Y' => array(0,4),'m' => array(4,2),'d'=> array(6,2),'H' => array(8,2),'M'=>array(10,2),'S' => array(12,2))
// );
// $c->authenticate_hook['call'] = 'LDAP_check';
// $c->authenticate_hook['config'] = array(
// 'host' => 'ldap://ldap.example.net',
// 'bindDN' => 'auth@DOMAIN',
// 'passDN' => 'secret',
// 'baseDNUsers' => 'dc=DOMAIN,dc=local',
// 'protocolVersion' => 3,
// 'optReferrals' => 0,
// 'networkTimeout' => 10,
// 'filterUsers' => '(&(objectcategory=person)(objectclass=user)(givenname=*))',
// 'mapping_field' => array("username" => "uid",
// "fullname" => "cn" ,
// "email" => "mail"
// ),
// 'default_value' => array("date_format_type" => "E","locale" => "en_NZ"),
// 'format_updated' => array('Y' => array(0,4), 'm' => array(4,2), 'd' => array(6,2), 'H' => array(8,2), 'M' => array(10,2), 'S' => array(12,2))
// );
//
// /* If there is some user/group you do not want to sync from LDAP, put their username in these lists */
// $c->do_not_sync_from_ldap = array( 'admin' => true );
// $c->do_not_sync_group_from_ldap = array( 'teamclient1' => true );
// /* If there is some user/group you do not want to sync from LDAP, put their username in these lists */
// $c->do_not_sync_from_ldap = array( 'admin' => true );
// $c->do_not_sync_group_from_ldap = array( 'teamclient1' => true );
//
//include('drivers_ldap.php');
// include('drivers_ldap.php');
/********************************/
@ -708,29 +735,33 @@ $c->admin_email ='calendar-admin@example.com';
/**
* Authentication against PAM using the Squid helper script.
*/
//$c->authenticate_hook = array(
// 'call' => 'SQUID_PAM_check',
// 'config' => array( 'script' => '/usr/bin/pam_auth', 'email_base' => 'example.com' )
// );
//include('drivers_squid_pam.php');
// $c->authenticate_hook = array(
// 'call' => 'SQUID_PAM_check',
// 'config' => array( 'script' => '/usr/bin/pam_auth', 'email_base' => 'example.com' )
// );
// include('drivers_squid_pam.php');
/**
* Authentication against PAM/system password database using pwauth.
*/
//$c->authenticate_hook = array('call' => 'PWAUTH_PAM_check',
// 'config' => array('path' => '/usr/sbin/pwauth',
// 'email_base' => 'example.com'));
//include('drivers_pwauth_pam.php');
// $c->authenticate_hook = array(
// 'call' => 'PWAUTH_PAM_check',
// 'config' => array('path' => '/usr/sbin/pwauth',
// 'email_base' => 'example.com')
// );
// include('drivers_pwauth_pam.php');
/**
* Authentication against IMAP using the imap_open function.
*/
//$c->authenticate_hook['call'] = 'IMAP_PAM_check';
//$c->authenticate_hook['config'] = array(
// 'imap_url' => '{localhost:993/imap/ssl/novalidate-cert}',
// 'email_base' => 'example.com'
//);
//include('drivers_imap_pam.php');
// $c->authenticate_hook = array(
// 'call' => 'IMAP_PAM_check',
// 'config' => array(
// 'imap_url' => '{localhost:993/imap/ssl/novalidate-cert}',
// 'email_base' => 'example.com'
// )
// );
// include('drivers_imap_pam.php');
/********************************/
/****** Webserver does Auth *****/
@ -750,20 +781,20 @@ $c->admin_email ='calendar-admin@example.com';
* be ignored and authentication will happen through the authentication method
* that the webserver is configured with.
*/
//$c->authenticate_hook['server_auth_type'] = 'Basic';
// $c->authenticate_hook['server_auth_type'] = 'Basic';
/**
* Uncomment this to use Webserver Auth for CalDAV access in addition to the
* Admin web pages.
*/
//include_once('AuthPlugins.php');
// include_once('AuthPlugins.php');
/**
* If your Webserver Auth method provides a logout URL (traditional Basic Auth
* does not), you can enter it here so the Logout link in the Admin web pages
* can point to it.
*/
//$c->authenticate_hook['logout'] = '/logout';
// $c->authenticate_hook['logout'] = '/logout';
/***************************************************************************
@ -782,11 +813,12 @@ $c->admin_email ='calendar-admin@example.com';
* Only tested with ejabberd 2.0.x
*/
// $c->notifications_server = array( 'host' => $_SERVER['SERVER_NAME'], // jabber server hostname
// 'jid' => 'user@example.com', // user(JID) to login/ publish as
// 'password' => '', // password for above account
// // 'debug_jid' => 'otheruser@example.com' // send a copy of all publishes to this jid
// );
// $c->notifications_server = array(
// 'host' => $_SERVER['SERVER_NAME'], // jabber server hostname
// 'jid' => 'user@example.com', // user(JID) to login/ publish as
// 'password' => '', // password for above account
// // 'debug_jid' => 'otheruser@example.com' // send a copy of all publishes to this jid
// );
// include ( 'pubsub.php' );
@ -805,11 +837,11 @@ $c->admin_email ='calendar-admin@example.com';
* Note that there is currently no way of enabling metrics via memcache
* without memcache being enabled for all of DAViCal.
*/
// $c->metrics_style = 'counters'; // Just the simple counter-based metrics
// $c->metrics_style = 'memcache'; // Only the metrics using memcache
// $c->metrics_style = 'both'; // Both styles of metrics
// $c->metrics_collectors = array('127.0.0.1'); // Restrict access to only this IP address
// $c->metrics_require_user = 'metricsuser'; // Restrict access to only connections authenticating as this user
// $c->metrics_style = 'counters'; // Just the simple counter-based metrics
// $c->metrics_style = 'memcache'; // Only the metrics using memcache
// $c->metrics_style = 'both'; // Both styles of metrics
// $c->metrics_collectors = array('127.0.0.1'); // Restrict access to only this IP address
// $c->metrics_require_user = 'metricsuser'; // Restrict access to only connections authenticating as this user
/***************************************************************************
* *
@ -822,5 +854,5 @@ $c->admin_email ='calendar-admin@example.com';
* logging then see:
* http://wiki.davical.org/index.php/Configuration/hooks/log_caldav_action
*/
//include('log_caldav_action.php');
// include('log_caldav_action.php');