Avii/Radicale
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

sharing: doc update

Browse Source
This commit is contained in:
Peter Bieringer
2026-02-28 22:18:04 +01:00
parent d81c0f33e0
commit 20135d9218
2 changed files with 25 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
DOCUMENTATION.md
View File

@@ -2110,8 +2110,8 @@ Permit create of token-based sharing
Default: `false` Default: `false`
* If `False` it can be explicitly granted by permissions: `T` * If `False` it can be explicitly granted by *rights* permissions: `T`
* If `True` it can be explicitly forbidden by permissions: `t` * If `True` it can be explicitly forbidden by *rights* permissions: `t`
##### permit_create_map ##### permit_create_map
@@ -2121,8 +2121,8 @@ Permit create of map-based sharing
Default: `false` Default: `false`
* If `False` it can be explicitly granted by permissions: `M` * If `False` it can be explicitly granted by *rights* permissions: `M`
* If `True` it can be explicitly forbidden by permissions: `m` * If `True` it can be explicitly forbidden by *rights* permissions: `m`
##### permit_properties_overlay ##### permit_properties_overlay

26
SHARING.md
View File

@@ -58,6 +58,11 @@ File-based configuration store is using encoded `PathOrToken` as filename for ea
Map-based sharing can be accessed as usual after authentication and authorization. Map-based sharing can be accessed as usual after authentication and authorization.
#### Permission Control
* `permit_create_map`
* supported *rights* permissions: `Mm`
#### Workflow #### Workflow
* create map as owner * create map as owner
@@ -78,13 +83,17 @@ Token-based sharing can be accessed after retrieving the token via
Token-URI: `/.token/<Token>` Token-URI: `/.token/<Token>`
#### Permission Control
* `permit_create_token`
* supported *rights* permissions: `Tt`
#### Workflow #### Workflow
* create token as owner * create token as owner
* enable token as owner (can be combined with "create") * enable token as owner (can be combined with "create")
* handover URI with token to client * handover URI with token to client
## Sharing Configuration Management API ## Sharing Configuration Management API
### Sharing Configuration Management API version 1 ### Sharing Configuration Management API version 1
@@ -294,7 +303,14 @@ Owner or user can define per share a set of properties to overlay on PROPFIND re
Whitelisted ones are defined in `OVERLAY_PROPERTIES_WHITELIST` in `radicale/sharing/__init__.py`: Whitelisted ones are defined in `OVERLAY_PROPERTIES_WHITELIST` in `radicale/sharing/__init__.py`:
* `C:calendar-description` (_>= 3.7.0_) * `C:calendar-description` (_>= 3.7.0_)
* `ICAL:calendar-color` (_>= 3.7.0_) * `ICAL:calendar-color` (_>= 3.7.0_)
* `CR:addressbook-description` (_>= 3.7.0_) * `CR:addressbook-description` (_>= 3.7.0_)
* `INF:addressbook-color` (_>= 3.7.0_) * `INF:addressbook-color` (_>= 3.7.0_)
### Properties Overlay Control Options
* `permit_properties_overlay`
* supported *share* permissions: `Pp`
* `enforce_properties_overlay`
* supported *share* permissions: `Ee`