oss/Radicale
oss/Radicale
1
0
Fork 0
mirror of https://github.com/Kozea/Radicale.git synced 2025-06-26 16:45:52 +00:00
Code Wiki Activity

update

Peter Bieringer 2025-03-16 06:49:33 +01:00
parent c2bd85174b
commit 06e8cc4e21
1 changed files with 37 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

46
Collection-Storage.md

@ -93,10 +93,40 @@ jq . .Radicale.props
1:1 reflecting items in a pre-compiled format
Since 3.3.2 the item cache can be located outside by option `[storage] use_cache_subfolder_for_item = True`
Since 3.3.2 the item cache can be located outside by option `[storage] use_cache_subfolder_for_item = True` in combination with defined `filesystem_cache_folder`.
Since 3.3.2 the item cache format can be toggled between SHA-256 or using mtime+size of original item by option `[storage] use_mtime_and_size_for_item_cache = True` (recommend to use only on systems where mtime has "ns" granularity)
#### Directory: .Radicale.cache/history
historic pre-compiled items
Since 3.3.2 the history can be located outside by option `[storage] use_cache_subfolder_for_history = True` in combination with defined `filesystem_cache_folder`.
#### Directory: .Radicale.cache/sync-token
file containing synchronization tokens related to each client serve only changes on request
Since 3.3.2 the sync-token can be located outside by option `[storage] use_cache_subfolder_for_synctoken = True` in combination with defined `filesystem_cache_folder`.
## Cache Folder
Since 3.3.2 there is the option to store the cache outside the `filesystem_folder` e.g. `[storage] filesystem_cache_folder = /var/cache/radicale/collections/collection-cache`
This can be used storing item cache local on the system while the items, sync-token and history are stored in shared filesystem like NFS or GlusterFS.
| Item Storage | Item Cache | History | Sync-Token |
|-|-|-|-|
| Local | possible | possible | possible |
| Remote, single instance | optional<sup>(1)</sup> | optional<sup>(1)</sup> | optional<sup>(1)</sup> |
| Semi-Local, shared, active-passive cluster | possible<sup>(1)</sup> | avoid<sup>(2)</sup> | avoid<sup>(2)</sup> |
<sup>(1)</sup> can decrease response time
<sup>(2)</sup> will break consistency
Example:
```
[d] /var
└─[d] /lib
@ -116,18 +146,16 @@ Since 3.3.2 the item cache format can be toggled between SHA-256 or using mtime+
└─[d] /sync-token (automatic generated)
```
### Activation of Cache Folder
#### Directory: .Radicale.cache/item
Content may be moved, otherwise it's automatic re-generated on next request by client (one-time response delay depending on amount of items)
#### Directory: .Radicale.cache/history
historic pre-compiled items
Content may be moved (in case of interest), otherwise historic data is lost
#### Directory: .Radicale.cache/sync-token
file containing synchronization tokens related to each client serve only changes on request
## Example for a simple storage layout
Since 3.3.2 there are even more options to store the whole cache outside the `filesystem_folder`
This can be used storing item cache local on the system, e.g. `/var/cache/radicale/collections/collection-cache` while the items, sync-token and history are stored in shared filesystem like NFS or GlusterFS.
Content may be moved, otherwise lost and client will on next connection pull more data than usual if sync-token is used on client side