Make sure all configuration settings described at https://wiki.davical.org/index.php/Configuration/settings are documented in the example config files (cf. #76)

This commit is contained in:
Florian Schlichting 2017-01-08 22:18:07 +01:00
parent 09d1f67b39
commit 3b35350e8b
2 changed files with 99 additions and 5 deletions

View File

@ -71,6 +71,16 @@ $c->admin_email ='calendar-admin@example.com';
*/
// $c->restrict_setup_to_admin = true;
/**
* Restrict access to the administrative pages to only be available on a
* particular domain name and port. The default is that any DAViCal instance
* will have the administrative pages active. When any these settings is enabled,
* requests for administrative URLs such as index.php, admin.php, setup.php etc
* will be redirected to 'caldav.php', unless the restrictions are fulfilled.
*/
// $c->restrict_admin_domain = 'admin.davical.example.com';
// $c->restrict_admin_port = '8443';
/**
* The "enable_row_linking" option controls whether javascript is used
* to make the entire row clickable in browse lists in the administration
@ -109,11 +119,24 @@ $c->admin_email ='calendar-admin@example.com';
// $c->collections_always_exist = false;
/**
* The name of a user's "home" calendar. This will be created for each
* new user.
* Default: 'calendar'
* The name of a user's "home" calendar and addressbook. These will be created
* for each new user.
* Default: 'calendar' / 'addresses'
*/
// $c->home_calendar_name = 'calendar';
// $c->home_addressbook_name = 'addresses';
/**
* 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)
//);
/**
* An array of groups / permissions which should be automatically added
@ -160,6 +183,20 @@ $c->admin_email ='calendar-admin@example.com';
*/
// $c->hide_TODO = false;
/**
* If true, then VALARM from someone other than the admin or owner of a
* 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.
*/
// $c->hide_alarm = true;
/**
* If you want to hide older events (in order to save resources, speed up
* clients, etc.) define the desired time interval in number of days.
*/
// $c->hide_older_than = 90;
/**
* External subscription (BIND) minimum refresh interval
* Required if you want to enable remote binding ( webcal subscriptions )
@ -167,6 +204,22 @@ $c->admin_email ='calendar-admin@example.com';
*/
// $c->external_refresh = 60;
/**
* If you want to force DAViCal to use HTTP Digest Authentication for CalDAV
* access. Note that this requires all user passwords to be stored in plain text
* in the database. It is probably better to configure the webserver to do
* Digest auth against a separate user database (see below for Webserver Auth).
*/
// $c->http_auth_mode = "Digest";
/**
* Provide freebusy information to any (unauthenticated) user via the
* freebusy.php URL. Only events marked as PRIVATE will be excluded from the
* report.
* Default: false (authentication required)
*/
// $c->public_freebusy_url = true;
/**
* The "support_obsolete_free_busy_property" value controls whether,
* during a PROPFIND, the obsolete Scheduling property "calendar-free-busy-set"
@ -206,6 +259,15 @@ $c->admin_email ='calendar-admin@example.com';
*/
// $c->domain_name = 'example.com';
/**
* If this option is set to true, then "@$c->domain_name" is appended to the
* user login name if it does not contain the @ character. If email addresses
* are used as user names in Davical, this fixes a problem with MacOS X 10.6
* Addressbook that cannot login to CardDav account.
* Default: false
*/
// $c->login_append_domain_if_missing = true;
/**
* Many people want this, but it may be a security issue for you, so it is
* disabled by default. If you enable it, then confidential / private events
@ -231,6 +293,14 @@ $c->admin_email ='calendar-admin@example.com';
* *
***************************************************************************/
/**
* If you want to turn off scheduling functions you can set this to 'false' and
* DAViCal will not advertise the ability to schedule, leaving it to calendar
* clients to send out and receive scheduling requests.
* Default: true
*/
// $c->enable_auto_schedule = false;
/**
* If true, then remote scheduling will be enabled. There is a possibility
* of receiving spam events in calendars if enabled, you will at least know
@ -384,6 +454,8 @@ $c->admin_email ='calendar-admin@example.com';
// '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
@ -434,6 +506,7 @@ $c->admin_email ='calendar-admin@example.com';
// 'baseDNUsers' => 'dc=DOMAIN,dc=local',
// 'protocolVersion' => 3,
// 'optReferrals' => 0,
// 'networkTimeout' => 10,
// 'filterUsers' => '(&(objectcategory=person)(objectclass=user)(givenname=*))',
// 'mapping_field' => array("username" => "uid",
// "fullname" => "cn" ,

View File

@ -28,12 +28,25 @@
// $c->maximum_lock_timeout = 8640000;
/**
* default = true;
* If set, DAViCal will store each unique time zone used in any calendar to speed
* future timezone interpretation.
* Default = true;
*/
// $c->save_time_zone_defs = true;
/**
* If there is some timezone which shows up with a name that is not understood
* by DAViCal, you can add a translation for it into this list
*/
// $c->timezone_translations = array( 'Greenwich Mean Time : Dublin, Edinburgh, Lisbon, London' => 'Europe/London' );
/**
* It is possible that you have installed DAViCal in a non-standard manner, and
* DAViCal can't find it's locale files, or you want it to use some different
* ones that you're writing to submit to the developers (yes please!).
* Default: ../locale
*/
// $c->locale_path = '/path/to/davical/locale/files';
/**
* Internal variable used to contain arrays of stylesheets or javascripts
@ -44,6 +57,15 @@
// $c->scripts = array();
// $c->stylesheets = array();
/**
* PostgreSQL supports multiple namespaces (schemas) within a single database,
* allowing you to have (e.g.) two tables with the same name. This setting
* allows you to control the search path so that you can have the DAViCal
* tables in a different schema.
* Note that there is no support in DAViCal for putting the tables into a
* non-default schema in the first place.
*/
// $c->db_schema = 'schema1,schema2';
/**
* Internal variable to display page's title
@ -53,7 +75,6 @@
// if you are writing your own pages within the admin interface.
// $c->page_title = 'DAViCal CalDAV Server';
/**
* Internal array variable to hold error messages to be displayed on top of page
* in the web interface