imip-agent

Annotated docs/wiki/FileStore

1334:f490ac87ee22
2017-10-17 Paul Boddie Fixed debugging output. client-editing-simplification
paul@1089 1
= File Store =
paul@1089 2
paul@1089 3
The file data store is the default mechanism for storing calendar objects and
paul@1089 4
free/busy details, making use of various directories as described in the
paul@1089 5
[[../FilesystemUsage|filesystem usage guide]].
paul@1089 6
paul@1089 7
Benefits of the file store include transparency and ease of administration:
paul@1089 8
all data is stored in text files, direct modification of certain files can be
paul@1089 9
performed to change the system's behaviour, archiving is possible using
paul@1089 10
traditional filesystem tools. However, the simple representation may make
paul@1089 11
certain operations costly, such as the modification of tabular data, and
paul@1089 12
querying of data may not always be particularly convenient.
paul@1089 13
paul@1089 14
Thus, the [[../DatabaseStore|database store]] exists as an alternative, offering
paul@1089 15
different characteristics to those of the file store.
paul@1093 16
paul@1093 17
== Configuration Settings ==
paul@1093 18
paul@1214 19
The [[../Configuration|configuration]] files (`config.sh` and `config.txt`) need to be
paul@1093 20
updated when choosing a file store.
paul@1093 21
paul@1093 22
{{{#!table
paul@1093 23
'''File''' || '''Setting''' || '''Value''' || '''Description'''
paul@1093 24
==
paul@1093 25
`config.sh`
paul@1093 26
||<rowspan="2"> `STORE_TYPE`
paul@1093 27
||<rowspan="2"> `file`
paul@1093 28
||<rowspan="2"> Selects the default file storage type
paul@1093 29
==
paul@1214 30
`config.txt`
paul@1093 31
==
paul@1214 32
<rowspan="2"> `config.txt`
paul@1093 33
|| `STORE_DIR`
paul@1093 34
|| `/var/lib/imip-agent/store`
paul@1093 35
|| Indicates the filesystem location of the data store
paul@1093 36
==
paul@1093 37
`JOURNAL_DIR`
paul@1093 38
|| `/var/lib/imip-agent/journal`
paul@1093 39
|| Indicates the filesystem location of the journal
paul@1093 40
}}}