-
Notifications
You must be signed in to change notification settings - Fork 1
04 Administration
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.
Execute the below to show help information about using this utility.
php syncdb.php help
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
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.
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
If you want to delete a user, execute the below and follow the prompts.
php syncdb.php
To purge logically deleted records execute the below.
php syncdb.php housekeeping
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.
Execute the below to show help information about using this utility.
php cache.php help
If you want to clear cache, execute the below and follow the prompts.
php cache.php clear
WARNING: Clearing cache is NOT RECOMMENDED during normal functioning of the application. Clear cache only when you are seeing outdated data in clients or want to reclaim some space during housekeeping.
WARNING: 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
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.