04 Administration

Managing sync database

The command line utility (syncdb.php) to manage the sync database is present in the directory src/App. If using SQLite as your sync database product execute this utility as a user who has write permissions on the database file.

WARNING: DO NOT manipulate any data in the sync database directly. Always use the above utility to make changes.

Show help

Execute the below to show help information about using this utility.

php syncdb.php help

Initialization

The sync database must be initialized before using this application. Make sure your address books are configured correctly in the conf file before you execute the below to initialize the sync database.

php syncdb.php init

Managing address books

To manage users and address books, execute the below and follow the prompts.

php syncdb.php - Interactive management of entities.
php syncdb.php manage - Same as above.
php syncdb.php manage addressbook - Interactive management of address books.

This application will not process any address book which is not present in the conf file and in the sync database simultaneously.

Also the following parameters of an address book in the conf file must match the values in the sync database. If you change these values in the conf file, use the utility above to delete the address book and add it back to the sync database.

user_specific
writable

Managing users

If you want to delete a user, execute the below and follow the prompts.

php syncdb.php - Interactive management of entities.
php syncdb.php manage - Same as above.
php syncdb.php manage user - Interactive management of users.

Housekeeping

To purge logically deleted records execute the below.

php syncdb.php housekeeping

Managing cache

The command line utility (cache.php) to manage cache is present in the directory src/App. If using 'local_fs' as your cache backend execute this utility as a user who has write permissions to cachedir.

Show help

Execute the below to show help information about using this utility.

php cache.php help

Clearing cache

WARNING: Clearing cache will delete/invalidate all items in the cache including the ones set by other applications. Also it is NOT RECOMMENDED during normal functioning of the application as it can have a significant impact on application performance. Clear cache only when you are seeing outdated data in clients.

If you want to clear cache, execute the below and follow the prompts.

php cache.php clear

Housekeeping

NOTE: Currently required only when using 'local_fs' cache backend.

If you want to evict stale cache items, execute the below. This useful to permanently delete cache of deleted users and contacts. You can schedule this to run periodically.

php cache.php housekeeping

Tuning

Adjusting max size of processed contact

If you get HTTP status code 413 when trying to add/update a contact check max_size address book configuration key in conf/conf.php.example file and update it in the conf file appropriately.

Application upgrade

WARNING

1. DO NOT attempt any of the below mentioned activities before creating a reliable backup of application data. Check backup section for more details.
2. DO NOT attempt any of the below mentioned activities while the application is online as it may result in data corruption and/or data inconsistency.

The below mentioned steps define the process to upgrade the application to a higher release.

1. Create a backup of the application data. Check backup section for more details.
2. Replace the existing application directory using a higher release of the application. See download section for more details.
   Example: rm -Rf ldap-carddav && composer create-project isubsoft/ldap-carddav --prefer-dist
3. Follow steps provided in the UPGRADE_DATABASE file (if present) in the higher release to upgrade the database.
4. Restore datadir backup inside application directory (if applicable according to your datadir location in the conf file).
5. Restore conf directory backup inside application directory.
6. Make sure file/directory permissions are as per -- Application file/directory permissions section of the INSTALL file.