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

group: sharing/doc updated

Browse Source
This commit is contained in:
Peter Bieringer
2026-07-18 15:20:35 +02:00
parent f0a7e927b4
commit 5e4dd2451a
2 changed files with 14 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
DOCUMENTATION.md
View File

@@ -2341,6 +2341,8 @@ Default: `false`
* If `False` it can be explicitly granted by *share* permissions: `P` * If `False` it can be explicitly granted by *share* permissions: `P`
* If `True` it can be explicitly forbidden by *share* permissions: `p` * If `True` it can be explicitly forbidden by *share* permissions: `p`
share-by-group/realm: always forbidden (_>= 3.8.0_)
##### enforce_properties_overlay ##### enforce_properties_overlay
_(>= 3.7.0)_ _(>= 3.7.0)_
@@ -2352,6 +2354,8 @@ Default: `true`
* If `False` it can be explicitly enforced by *share* permissions: `E` * If `False` it can be explicitly enforced by *share* permissions: `E`
* If `True` it can be explicitly forbidden by *share* permissions: `e` * If `True` it can be explicitly forbidden by *share* permissions: `e`
share-by-group/realm: always forbidden (_>= 3.8.0_)
##### default_permissions_create_token ##### default_permissions_create_token
_(>= 3.7.0)_ _(>= 3.7.0)_

11
SHARING.md
View File

@@ -8,6 +8,10 @@ With _3.7.0_ major extension was implemented
* added management API * added management API
* WebUI extension using the management API * WebUI extension using the management API
With _3.8.0_ sharing-by-* membership was implemented
* sharing-by-group
* sharing-by-realm
## Sharing Implementation ## Sharing Implementation
Implementation of sharing collections is done by using a database to lookup the URI and in case entry exists by mapping to target URI and replacing provided data on request and adjust if required data in response. Implementation of sharing collections is done by using a database to lookup the URI and in case entry exists by mapping to target URI and replacing provided data on request and adjust if required data in response.
@@ -32,17 +36,22 @@ Types of supported sharing configuration:
* `map`: map-based share (requires user authentication) * `map`: map-based share (requires user authentication)
* `PathOrToken`: token or "virtual" collection, has to be unique (PRIMARY KEY) * `PathOrToken`: token or "virtual" collection, has to be unique (PRIMARY KEY)
* `PathMapped`: target collection * `PathMapped`: target collection
* share-by-group/realm: has to start with placeholder `/{user}` (_>= 3.8.0_)
* `Conversion`: conversion method * `Conversion`: conversion method
* `Owner`: owner of the share * `Owner`: owner of the share
* `User`: user of the share * `User`: user (or group, _>= 3.8.0_) of the share
* share-by-group/realm: has to start with `:` or `@` (_>= 3.8.0_)
* `Permissions`: effective permission of the share * `Permissions`: effective permission of the share
* `EnabledByOwner`: control by owner * `EnabledByOwner`: control by owner
* `EnabledByUser`: control by user * `EnabledByUser`: control by user
* share-by-group/realm: always enabled (_>= 3.8.0_)
* `HiddenByOwner`: control by owner * `HiddenByOwner`: control by owner
* `HiddenByUser`: control by user * `HiddenByUser`: control by user
* share-by-group/realm: always disabled (_>= 3.8.0_)
* `TimestampCreated`: unixtime of creation * `TimestampCreated`: unixtime of creation
* `TimestampUpdated`: unixtime of last update * `TimestampUpdated`: unixtime of last update
* `Properties`: overlay properties (limited set whitelisted) * `Properties`: overlay properties (limited set whitelisted)
* share-by-group/realm: not supported (_>= 3.8.0_)
* `Actions`: specific configuration * `Actions`: specific configuration
`Enabled*`: _owner_ AND _user_ have to enable a share to become usable `Enabled*`: _owner_ AND _user_ have to enable a share to become usable