Configuration Details

Navigation:  File Change API >

Configuration Details

Previous pageReturn to chapter overviewNext page

Configuration resides in /etc/sysconfig/cloudlinux-fchange. The following is the default configuration (see comments):

 

# sqlite database file path. If commented out a default value is used

#database_path=/var/lve/cloudlinux-fchange.db

 

# If uncommented paths starting with 'include' one are processed only

# Pay attention this parameter is a regular string, not a regex

# To include more than one item just specify several lines to include:

# include=/one

# include=/two

 

# If uncommented exclude paths which contain 'exclude'

# Pay attention this parameter is a regular string, not a regex

# To exclude more than one item just specify several lines to exclude:

# exclude=var

# exclude=tmp

 

# Daemon polling interval in seconds

polling_interval=5

 

# Time to keep entries in days. Does not clean if commented out or zero

time_to_keep=1

 

# User read-only mode minimal UID

# If file change collector stopped, all users with UID >= user_ro_mode_min_uid

# are restricted to write to their home directory. This prevents to miss

# a file change event.

# Value of -1 (default) allows to disable the feature

user_ro_mode_min_uid=-1

 

# Minimal UID of events to be processed.

# Events of users with UID less then specified are not handled.

# By default 500 (non-system users for redhat-based systems)

#minimal_event_uid=500

 

# SQLite shared lock prevents setting more restrictive locks. That is a

# process cannot write to a database table when a concurrent process reads

# from the table. As saving data to database is considered far more important

# than getting them (data could be reread a second later after all), database

# writer could try to terminate concurrent reading processes. Just set 

# terminate rivals to 'yes' to turn this ability on.

# terminate_rivals=no

 

# Events to be handled. Currently the following types of events are processed:

# 1. file creation

# 2. file deletion

# 3. directory creation

# 4. directory deletion

# 5. file content/metadata modification

# 6. file/directory attributes/ownership modification

# 7. hardlink creation

# 8. symlink creation

# 9. file/directory moving/renaming

# By default all events are processed. Keep in mind that events for a filepath

# are cached, i.e if a file was deleted and then a file with the same absolute

# name is created, only the deletion event is triggerred. Changing file

# modification timestamp with command 'touch' will trigger modification event

# as if a file content is modified.

# Currently supported options are:

# file_created, file_modified, file_deleted, dir_created, dir_deleted,

# owner_changed, attrib_changed, moved, hardlink_created, symlink_created, all

# Options that don't have 'file' or 'dir' prefix, applied to both files and

# directories. To set more than one options, separate them with commas,

# e.g. event_types=file_created,file_deleted,file_modified. Unknown options are

# ignored.

#

# event_types=all

 

Please keep in mind, that current implementation implies that one process is writing to a database and another is reading from it. As reading sets shared lock to a database table, the writing process cannot write to the table until the lock is released. That’s why passing a timestamp to cloudlinux-backup-helper matters: this way the number of records to be returned is substantially decreased, lowering the processing time and filtering out old records. Likewise, pay attention to narrowing the scope of events being recorded. Chances are that changing attributes, ownership, directory creation/deletion, symlink events are not relevant and there’s no need to keep them.