From 1e72c783529603ba8300d8647d62f1edca61cd15 Mon Sep 17 00:00:00 2001 From: Roman Perekhod Date: Tue, 19 Nov 2024 13:49:27 +0100 Subject: [PATCH] release-2.26.6 --- CHANGELOG.md | 94 +++++++++++++++- RELEASE_DATE | 2 +- VERSION | 2 +- .../fix-allow-token-clock-skew.md | 0 .../fix-flaky-posixfs-tests.md | 0 .../fix-gateway-panic.md | 0 .../fix-missing-file-touched-event.md | 0 .../fix-ocm-external-idp.md | 0 .../improve-posixfs-logging.md | 2 +- .../log-uploads.md | 0 .../no-delete-lock.md | 0 .../pass-initialized-loggers.md | 2 +- .../prevent-panic.md | 0 changelog/NOTE.md | 89 +++++++++++---- .../en/docs/changelog/2.26.6/_index.md | 101 +++++++++++++++++ .../grpc/services/ocminvitemanager/_index.md | 2 +- .../grpc/services/ocmshareprovider/_index.md | 2 +- .../grpc/services/permissions/_index.md | 4 +- .../grpc/services/storageprovider/_index.md | 106 +++++++++--------- .../http/services/dataprovider/_index.md | 8 +- .../packages/storage/fs/local/_index.md | 8 +- .../packages/storage/fs/localhome/_index.md | 6 +- 22 files changed, 334 insertions(+), 94 deletions(-) rename changelog/{unreleased => 2.26.6_2024-11-19}/fix-allow-token-clock-skew.md (100%) rename changelog/{unreleased => 2.26.6_2024-11-19}/fix-flaky-posixfs-tests.md (100%) rename changelog/{unreleased => 2.26.6_2024-11-19}/fix-gateway-panic.md (100%) rename changelog/{unreleased => 2.26.6_2024-11-19}/fix-missing-file-touched-event.md (100%) rename changelog/{unreleased => 2.26.6_2024-11-19}/fix-ocm-external-idp.md (100%) rename changelog/{unreleased => 2.26.6_2024-11-19}/improve-posixfs-logging.md (66%) rename changelog/{unreleased => 2.26.6_2024-11-19}/log-uploads.md (100%) rename changelog/{unreleased => 2.26.6_2024-11-19}/no-delete-lock.md (100%) rename changelog/{unreleased => 2.26.6_2024-11-19}/pass-initialized-loggers.md (75%) rename changelog/{unreleased => 2.26.6_2024-11-19}/prevent-panic.md (100%) create mode 100644 docs/content/en/docs/changelog/2.26.6/_index.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 59beed5331..fa5eae2522 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,96 @@ +Changelog for reva 2.26.6 (2024-11-19) +======================================= + +The following sections list the changes in reva 2.26.6 relevant to +reva users. The changes are ordered by importance. + +Summary +------- + +* Fix #4955: Allow small clock skew in reva token validation +* Fix #4929: Fix flaky posixfs integration tests +* Fix #4953: Avoid gateway panics +* Fix #4959: Fix missing file touched event +* Fix #4933: Fix federated sharing when using an external identity provider +* Fix #4935: Enable datatx log +* Fix #4936: Do not delete mlock files +* Fix #4954: Prevent a panic when logging an error +* Fix #4956: Improve posixfs error handling and logging +* Fix #4951: Pass the initialized logger down the stack + +Details +------- + +* Bugfix #4955: Allow small clock skew in reva token validation + + Allow for a small clock skew (3 seconds by default) when validating reva tokens as the different + services might be running on different machines. + + https://github.com/cs3org/reva/issues/4952 + https://github.com/cs3org/reva/pull/4955 + +* Bugfix #4929: Fix flaky posixfs integration tests + + We fixed a problem with the posixfs integration tests where the in-memory id cache sometimes + hadn't caught up with the cleanup between test runs leading to flaky failures. + + https://github.com/cs3org/reva/pull/4929 + +* Bugfix #4953: Avoid gateway panics + + The gateway would panic if there is a missing user in the context. Now it errors instead. + + https://github.com/cs3org/reva/issues/4953 + +* Bugfix #4959: Fix missing file touched event + + We have fixed an issue where the `file touched` event was not being triggered when an office + document was created. + + https://github.com/owncloud/ocis/issues/8950 + https://github.com/cs3org/reva/pull/4959 + +* Bugfix #4933: Fix federated sharing when using an external identity provider + + We fixes and issue that caused federated sharing to fail when the identity provider url did not + match the federation provider url. + + https://github.com/cs3org/reva/pull/4933 + +* Bugfix #4935: Enable datatx log + + We now pass a properly initialized logger to the datatx implementations, allowing the tus + handler to log with the same level as the rest of reva. + + https://github.com/cs3org/reva/pull/4935 + +* Bugfix #4936: Do not delete mlock files + + To prevent stale NFS file handles we no longer delete empty mlock files after updating the + metadata. + + https://github.com/cs3org/reva/pull/4936 + https://github.com/cs3org/reva/pull/4924 + +* Bugfix #4954: Prevent a panic when logging an error + + We fixed a panic when constructing a path failed to get the parent for a node. + + https://github.com/cs3org/reva/pull/4954 + +* Bugfix #4956: Improve posixfs error handling and logging + + We improved error handling and logging in the posixfs storage driver. + + https://github.com/cs3org/reva/pull/4956 + +* Bugfix #4951: Pass the initialized logger down the stack + + We now make the initialized logger available to grpc services and storage drivers, which + allows for easier and more uniform logging. + + https://github.com/cs3org/reva/pull/4951 + Changelog for reva 2.26.5 (2024-11-12) ======================================= @@ -11478,4 +11571,3 @@ Details from Drone into Github pages. https://github.com/cs3org/reva/pull/334 - diff --git a/RELEASE_DATE b/RELEASE_DATE index 3dc87011ed..ae87a9fe77 100644 --- a/RELEASE_DATE +++ b/RELEASE_DATE @@ -1 +1 @@ -2024-11-12 \ No newline at end of file +2024-11-19 \ No newline at end of file diff --git a/VERSION b/VERSION index decc681495..06994f8fbe 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -2.26.5 \ No newline at end of file +2.26.6 \ No newline at end of file diff --git a/changelog/unreleased/fix-allow-token-clock-skew.md b/changelog/2.26.6_2024-11-19/fix-allow-token-clock-skew.md similarity index 100% rename from changelog/unreleased/fix-allow-token-clock-skew.md rename to changelog/2.26.6_2024-11-19/fix-allow-token-clock-skew.md diff --git a/changelog/unreleased/fix-flaky-posixfs-tests.md b/changelog/2.26.6_2024-11-19/fix-flaky-posixfs-tests.md similarity index 100% rename from changelog/unreleased/fix-flaky-posixfs-tests.md rename to changelog/2.26.6_2024-11-19/fix-flaky-posixfs-tests.md diff --git a/changelog/unreleased/fix-gateway-panic.md b/changelog/2.26.6_2024-11-19/fix-gateway-panic.md similarity index 100% rename from changelog/unreleased/fix-gateway-panic.md rename to changelog/2.26.6_2024-11-19/fix-gateway-panic.md diff --git a/changelog/unreleased/fix-missing-file-touched-event.md b/changelog/2.26.6_2024-11-19/fix-missing-file-touched-event.md similarity index 100% rename from changelog/unreleased/fix-missing-file-touched-event.md rename to changelog/2.26.6_2024-11-19/fix-missing-file-touched-event.md diff --git a/changelog/unreleased/fix-ocm-external-idp.md b/changelog/2.26.6_2024-11-19/fix-ocm-external-idp.md similarity index 100% rename from changelog/unreleased/fix-ocm-external-idp.md rename to changelog/2.26.6_2024-11-19/fix-ocm-external-idp.md diff --git a/changelog/unreleased/improve-posixfs-logging.md b/changelog/2.26.6_2024-11-19/improve-posixfs-logging.md similarity index 66% rename from changelog/unreleased/improve-posixfs-logging.md rename to changelog/2.26.6_2024-11-19/improve-posixfs-logging.md index 3e4ac64004..152383c441 100644 --- a/changelog/unreleased/improve-posixfs-logging.md +++ b/changelog/2.26.6_2024-11-19/improve-posixfs-logging.md @@ -1,4 +1,4 @@ -Enhancement: Improve posixfs error handling and logging +Bugfix: Improve posixfs error handling and logging We improved error handling and logging in the posixfs storage driver. diff --git a/changelog/unreleased/log-uploads.md b/changelog/2.26.6_2024-11-19/log-uploads.md similarity index 100% rename from changelog/unreleased/log-uploads.md rename to changelog/2.26.6_2024-11-19/log-uploads.md diff --git a/changelog/unreleased/no-delete-lock.md b/changelog/2.26.6_2024-11-19/no-delete-lock.md similarity index 100% rename from changelog/unreleased/no-delete-lock.md rename to changelog/2.26.6_2024-11-19/no-delete-lock.md diff --git a/changelog/unreleased/pass-initialized-loggers.md b/changelog/2.26.6_2024-11-19/pass-initialized-loggers.md similarity index 75% rename from changelog/unreleased/pass-initialized-loggers.md rename to changelog/2.26.6_2024-11-19/pass-initialized-loggers.md index b8dc8ec936..5172fd26a4 100644 --- a/changelog/unreleased/pass-initialized-loggers.md +++ b/changelog/2.26.6_2024-11-19/pass-initialized-loggers.md @@ -1,4 +1,4 @@ -Enhancement: Pass the initialized logger down the stack +Bugfix: Pass the initialized logger down the stack We now make the initialized logger available to grpc services and storage drivers, which allows for easier and more uniform logging. diff --git a/changelog/unreleased/prevent-panic.md b/changelog/2.26.6_2024-11-19/prevent-panic.md similarity index 100% rename from changelog/unreleased/prevent-panic.md rename to changelog/2.26.6_2024-11-19/prevent-panic.md diff --git a/changelog/NOTE.md b/changelog/NOTE.md index bc57047bfe..f158652834 100644 --- a/changelog/NOTE.md +++ b/changelog/NOTE.md @@ -1,45 +1,92 @@ -Changelog for reva 2.26.5 (2024-11-12) +Changelog for reva 2.26.6 (2024-11-19) ======================================= -The following sections list the changes in reva 2.26.5 relevant to +The following sections list the changes in reva 2.26.6 relevant to reva users. The changes are ordered by importance. Summary ------- -* Fix #4926: Make etag always match content on downloads -* Fix #4920: Return correct status codes for simple uploads -* Fix #4924: Fix sync propagation -* Fix #4916: Improve posixfs stability and performance +* Fix #4955: Allow small clock skew in reva token validation +* Fix #4929: Fix flaky posixfs integration tests +* Fix #4953: Avoid gateway panics +* Fix #4959: Fix missing file touched event +* Fix #4933: Fix federated sharing when using an external identity provider +* Fix #4935: Enable datatx log +* Fix #4936: Do not delete mlock files +* Fix #4954: Prevent a panic when logging an error +* Fix #4956: Improve posixfs error handling and logging +* Fix #4951: Pass the initialized logger down the stack Details ------- -* Bugfix #4926: Make etag always match content on downloads +* Bugfix #4955: Allow small clock skew in reva token validation - We added an openReaderfunc to the Download interface to give drivers a way to guarantee that the - reader matches the etag returned in a previous GetMD call. + Allow for a small clock skew (3 seconds by default) when validating reva tokens as the different + services might be running on different machines. - https://github.com/cs3org/reva/pull/4926 - https://github.com/cs3org/reva/pull/4923 + https://github.com/cs3org/reva/issues/4952 + https://github.com/cs3org/reva/pull/4955 -* Bugfix #4920: Return correct status codes for simple uploads +* Bugfix #4929: Fix flaky posixfs integration tests - Decomposedfs now returns the correct precondition failed status code when the etag does not - match. This allows the jsoncs3 share managers optimistic locking to handle concurrent writes - correctly + We fixed a problem with the posixfs integration tests where the in-memory id cache sometimes + hadn't caught up with the cleanup between test runs leading to flaky failures. - https://github.com/cs3org/reva/pull/4920 + https://github.com/cs3org/reva/pull/4929 -* Bugfix #4924: Fix sync propagation +* Bugfix #4953: Avoid gateway panics - Fixes the defers in the sync propagation. + The gateway would panic if there is a missing user in the context. Now it errors instead. + https://github.com/cs3org/reva/issues/4953 + +* Bugfix #4959: Fix missing file touched event + + We have fixed an issue where the `file touched` event was not being triggered when an office + document was created. + + https://github.com/owncloud/ocis/issues/8950 + https://github.com/cs3org/reva/pull/4959 + +* Bugfix #4933: Fix federated sharing when using an external identity provider + + We fixes and issue that caused federated sharing to fail when the identity provider url did not + match the federation provider url. + + https://github.com/cs3org/reva/pull/4933 + +* Bugfix #4935: Enable datatx log + + We now pass a properly initialized logger to the datatx implementations, allowing the tus + handler to log with the same level as the rest of reva. + + https://github.com/cs3org/reva/pull/4935 + +* Bugfix #4936: Do not delete mlock files + + To prevent stale NFS file handles we no longer delete empty mlock files after updating the + metadata. + + https://github.com/cs3org/reva/pull/4936 https://github.com/cs3org/reva/pull/4924 -* Bugfix #4916: Improve posixfs stability and performance +* Bugfix #4954: Prevent a panic when logging an error + + We fixed a panic when constructing a path failed to get the parent for a node. + + https://github.com/cs3org/reva/pull/4954 + +* Bugfix #4956: Improve posixfs error handling and logging + + We improved error handling and logging in the posixfs storage driver. + + https://github.com/cs3org/reva/pull/4956 - The posixfs storage driver saw a number of bugfixes and optimizations. +* Bugfix #4951: Pass the initialized logger down the stack - https://github.com/cs3org/reva/pull/4916 + We now make the initialized logger available to grpc services and storage drivers, which + allows for easier and more uniform logging. + https://github.com/cs3org/reva/pull/4951 diff --git a/docs/content/en/docs/changelog/2.26.6/_index.md b/docs/content/en/docs/changelog/2.26.6/_index.md new file mode 100644 index 0000000000..b6833ddd2a --- /dev/null +++ b/docs/content/en/docs/changelog/2.26.6/_index.md @@ -0,0 +1,101 @@ + +--- +title: "v2.26.6" +linkTitle: "v2.26.6" +weight: 40 +description: > + Changelog for Reva v2.26.6 (2024-11-19) +--- + +Changelog for reva 2.26.6 (2024-11-19) +======================================= + +The following sections list the changes in reva 2.26.6 relevant to +reva users. The changes are ordered by importance. + +Summary +------- + +* Fix #4955: Allow small clock skew in reva token validation +* Fix #4929: Fix flaky posixfs integration tests +* Fix #4953: Avoid gateway panics +* Fix #4959: Fix missing file touched event +* Fix #4933: Fix federated sharing when using an external identity provider +* Fix #4935: Enable datatx log +* Fix #4936: Do not delete mlock files +* Fix #4954: Prevent a panic when logging an error +* Fix #4956: Improve posixfs error handling and logging +* Fix #4951: Pass the initialized logger down the stack + +Details +------- + +* Bugfix #4955: Allow small clock skew in reva token validation + + Allow for a small clock skew (3 seconds by default) when validating reva tokens as the different + services might be running on different machines. + + https://github.com/cs3org/reva/issues/4952 + https://github.com/cs3org/reva/pull/4955 + +* Bugfix #4929: Fix flaky posixfs integration tests + + We fixed a problem with the posixfs integration tests where the in-memory id cache sometimes + hadn't caught up with the cleanup between test runs leading to flaky failures. + + https://github.com/cs3org/reva/pull/4929 + +* Bugfix #4953: Avoid gateway panics + + The gateway would panic if there is a missing user in the context. Now it errors instead. + + https://github.com/cs3org/reva/issues/4953 + +* Bugfix #4959: Fix missing file touched event + + We have fixed an issue where the `file touched` event was not being triggered when an office + document was created. + + https://github.com/owncloud/ocis/issues/8950 + https://github.com/cs3org/reva/pull/4959 + +* Bugfix #4933: Fix federated sharing when using an external identity provider + + We fixes and issue that caused federated sharing to fail when the identity provider url did not + match the federation provider url. + + https://github.com/cs3org/reva/pull/4933 + +* Bugfix #4935: Enable datatx log + + We now pass a properly initialized logger to the datatx implementations, allowing the tus + handler to log with the same level as the rest of reva. + + https://github.com/cs3org/reva/pull/4935 + +* Bugfix #4936: Do not delete mlock files + + To prevent stale NFS file handles we no longer delete empty mlock files after updating the + metadata. + + https://github.com/cs3org/reva/pull/4936 + https://github.com/cs3org/reva/pull/4924 + +* Bugfix #4954: Prevent a panic when logging an error + + We fixed a panic when constructing a path failed to get the parent for a node. + + https://github.com/cs3org/reva/pull/4954 + +* Bugfix #4956: Improve posixfs error handling and logging + + We improved error handling and logging in the posixfs storage driver. + + https://github.com/cs3org/reva/pull/4956 + +* Bugfix #4951: Pass the initialized logger down the stack + + We now make the initialized logger available to grpc services and storage drivers, which + allows for easier and more uniform logging. + + https://github.com/cs3org/reva/pull/4951 diff --git a/docs/content/en/docs/config/grpc/services/ocminvitemanager/_index.md b/docs/content/en/docs/config/grpc/services/ocminvitemanager/_index.md index cefcfcd466..015f7f5563 100644 --- a/docs/content/en/docs/config/grpc/services/ocminvitemanager/_index.md +++ b/docs/content/en/docs/config/grpc/services/ocminvitemanager/_index.md @@ -9,7 +9,7 @@ description: > # _struct: config_ {{% dir name="provider_domain" type="string" default="The same domain registered in the provider authorizer" %}} - [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/ocminvitemanager/ocminvitemanager.go#L57) + [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/ocminvitemanager/ocminvitemanager.go#L58) {{< highlight toml >}} [grpc.services.ocminvitemanager] provider_domain = "The same domain registered in the provider authorizer" diff --git a/docs/content/en/docs/config/grpc/services/ocmshareprovider/_index.md b/docs/content/en/docs/config/grpc/services/ocmshareprovider/_index.md index 4ab7e77048..0a7f5763d4 100644 --- a/docs/content/en/docs/config/grpc/services/ocmshareprovider/_index.md +++ b/docs/content/en/docs/config/grpc/services/ocmshareprovider/_index.md @@ -9,7 +9,7 @@ description: > # _struct: config_ {{% dir name="provider_domain" type="string" default="The same domain registered in the provider authorizer" %}} - [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/ocmshareprovider/ocmshareprovider.go#L65) + [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/ocmshareprovider/ocmshareprovider.go#L66) {{< highlight toml >}} [grpc.services.ocmshareprovider] provider_domain = "The same domain registered in the provider authorizer" diff --git a/docs/content/en/docs/config/grpc/services/permissions/_index.md b/docs/content/en/docs/config/grpc/services/permissions/_index.md index af355d5064..37f7054d62 100644 --- a/docs/content/en/docs/config/grpc/services/permissions/_index.md +++ b/docs/content/en/docs/config/grpc/services/permissions/_index.md @@ -9,7 +9,7 @@ description: > # _struct: config_ {{% dir name="driver" type="string" default="localhome" %}} -The permission driver to be used. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/permissions/permissions.go#L40) +The permission driver to be used. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/permissions/permissions.go#L41) {{< highlight toml >}} [grpc.services.permissions] driver = "localhome" @@ -17,7 +17,7 @@ driver = "localhome" {{% /dir %}} {{% dir name="drivers" type="map[string]map[string]interface{}" default="permission" %}} - [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/permissions/permissions.go#L41) + [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/permissions/permissions.go#L42) {{< highlight toml >}} [grpc.services.permissions.drivers.permission] diff --git a/docs/content/en/docs/config/grpc/services/storageprovider/_index.md b/docs/content/en/docs/config/grpc/services/storageprovider/_index.md index b7ba942ea3..1a6eb0ea7f 100644 --- a/docs/content/en/docs/config/grpc/services/storageprovider/_index.md +++ b/docs/content/en/docs/config/grpc/services/storageprovider/_index.md @@ -6,130 +6,130 @@ description: > Configuration for the storageprovider service --- -# _struct: config_ +# _struct: eventconfig_ -{{% dir name="driver" type="string" default="localhome" %}} -The storage driver to be used. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L64) +{{% dir name="nats_address" type="string" default="address of the nats server" %}} + [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L77) {{< highlight toml >}} [grpc.services.storageprovider] -driver = "localhome" +nats_address = "address of the nats server" {{< /highlight >}} {{% /dir %}} -{{% dir name="drivers" type="map[string]map[string]interface{}" default="localhome" %}} - [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L65) +{{% dir name="nats_clusterid" type="string" default="clusterid of the nats server" %}} + [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L78) {{< highlight toml >}} -[grpc.services.storageprovider.drivers.localhome] -root = "/var/tmp/reva/" -share_folder = "/MyShares" -user_layout = "{{.Username}}" - +[grpc.services.storageprovider] +nats_clusterid = "clusterid of the nats server" {{< /highlight >}} {{% /dir %}} -{{% dir name="data_server_url" type="string" default="http://localhost/data" %}} -The URL for the data server. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L66) +{{% dir name="tls_insecure" type="bool" default=Whether to verify the server TLS certificates. %}} + [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L79) {{< highlight toml >}} [grpc.services.storageprovider] -data_server_url = "http://localhost/data" +tls_insecure = Whether to verify the server TLS certificates. {{< /highlight >}} {{% /dir %}} -{{% dir name="expose_data_server" type="bool" default=false %}} -Whether to expose data server. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L67) +{{% dir name="tls_root_ca_cert" type="string" default="The root CA certificate used to validate the server's TLS certificate." %}} + [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L80) {{< highlight toml >}} [grpc.services.storageprovider] -expose_data_server = false +tls_root_ca_cert = "The root CA certificate used to validate the server's TLS certificate." {{< /highlight >}} {{% /dir %}} -{{% dir name="available_checksums" type="map[string]uint32" default=nil %}} -List of available checksums. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L68) +{{% dir name="nats_enable_tls" type="bool" default=events tls switch %}} + [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L81) {{< highlight toml >}} [grpc.services.storageprovider] -available_checksums = nil +nats_enable_tls = events tls switch {{< /highlight >}} {{% /dir %}} -{{% dir name="custom_mimetypes_json" type="string" default="nil" %}} -An optional mapping file with the list of supported custom file extensions and corresponding mime types. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L69) +{{% dir name="nats_username" type="string" default="event stream username" %}} + [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L82) {{< highlight toml >}} [grpc.services.storageprovider] -custom_mimetypes_json = "nil" +nats_username = "event stream username" {{< /highlight >}} {{% /dir %}} -{{% dir name="upload_expiration" type="int64" default=0 %}} -Duration for how long uploads will be valid. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L71) +{{% dir name="nats_password" type="string" default="event stream password" %}} + [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L83) {{< highlight toml >}} [grpc.services.storageprovider] -upload_expiration = 0 +nats_password = "event stream password" {{< /highlight >}} {{% /dir %}} -{{% dir name="events" type="eventconfig" default=0 %}} -Event stream configuration [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L72) +# _struct: config_ + +{{% dir name="driver" type="string" default="localhome" %}} +The storage driver to be used. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L65) {{< highlight toml >}} [grpc.services.storageprovider] -events = 0 +driver = "localhome" {{< /highlight >}} {{% /dir %}} -# _struct: eventconfig_ - -{{% dir name="nats_address" type="string" default="address of the nats server" %}} - [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L76) +{{% dir name="drivers" type="map[string]map[string]interface{}" default="localhome" %}} + [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L66) {{< highlight toml >}} -[grpc.services.storageprovider] -nats_address = "address of the nats server" +[grpc.services.storageprovider.drivers.localhome] +root = "/var/tmp/reva/" +share_folder = "/MyShares" +user_layout = "{{.Username}}" + {{< /highlight >}} {{% /dir %}} -{{% dir name="nats_clusterid" type="string" default="clusterid of the nats server" %}} - [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L77) +{{% dir name="data_server_url" type="string" default="http://localhost/data" %}} +The URL for the data server. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L67) {{< highlight toml >}} [grpc.services.storageprovider] -nats_clusterid = "clusterid of the nats server" +data_server_url = "http://localhost/data" {{< /highlight >}} {{% /dir %}} -{{% dir name="tls_insecure" type="bool" default=Whether to verify the server TLS certificates. %}} - [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L78) +{{% dir name="expose_data_server" type="bool" default=false %}} +Whether to expose data server. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L68) {{< highlight toml >}} [grpc.services.storageprovider] -tls_insecure = Whether to verify the server TLS certificates. +expose_data_server = false {{< /highlight >}} {{% /dir %}} -{{% dir name="tls_root_ca_cert" type="string" default="The root CA certificate used to validate the server's TLS certificate." %}} - [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L79) +{{% dir name="available_checksums" type="map[string]uint32" default=nil %}} +List of available checksums. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L69) {{< highlight toml >}} [grpc.services.storageprovider] -tls_root_ca_cert = "The root CA certificate used to validate the server's TLS certificate." +available_checksums = nil {{< /highlight >}} {{% /dir %}} -{{% dir name="nats_enable_tls" type="bool" default=events tls switch %}} - [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L80) +{{% dir name="custom_mimetypes_json" type="string" default="nil" %}} +An optional mapping file with the list of supported custom file extensions and corresponding mime types. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L70) {{< highlight toml >}} [grpc.services.storageprovider] -nats_enable_tls = events tls switch +custom_mimetypes_json = "nil" {{< /highlight >}} {{% /dir %}} -{{% dir name="nats_username" type="string" default="event stream username" %}} - [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L81) +{{% dir name="upload_expiration" type="int64" default=0 %}} +Duration for how long uploads will be valid. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L72) {{< highlight toml >}} [grpc.services.storageprovider] -nats_username = "event stream username" +upload_expiration = 0 {{< /highlight >}} {{% /dir %}} -{{% dir name="nats_password" type="string" default="event stream password" %}} - [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L82) +{{% dir name="events" type="eventconfig" default=0 %}} +Event stream configuration [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L73) {{< highlight toml >}} [grpc.services.storageprovider] -nats_password = "event stream password" +events = 0 {{< /highlight >}} {{% /dir %}} diff --git a/docs/content/en/docs/config/http/services/dataprovider/_index.md b/docs/content/en/docs/config/http/services/dataprovider/_index.md index fd11a1f99b..b2e6d04279 100644 --- a/docs/content/en/docs/config/http/services/dataprovider/_index.md +++ b/docs/content/en/docs/config/http/services/dataprovider/_index.md @@ -9,7 +9,7 @@ description: > # _struct: config_ {{% dir name="prefix" type="string" default="data" %}} -The prefix to be used for this HTTP service [[Ref]](https://github.com/cs3org/reva/tree/master/internal/http/services/dataprovider/dataprovider.go#L42) +The prefix to be used for this HTTP service [[Ref]](https://github.com/cs3org/reva/tree/master/internal/http/services/dataprovider/dataprovider.go#L43) {{< highlight toml >}} [http.services.dataprovider] prefix = "data" @@ -17,7 +17,7 @@ prefix = "data" {{% /dir %}} {{% dir name="driver" type="string" default="localhome" %}} -The storage driver to be used. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/http/services/dataprovider/dataprovider.go#L43) +The storage driver to be used. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/http/services/dataprovider/dataprovider.go#L44) {{< highlight toml >}} [http.services.dataprovider] driver = "localhome" @@ -25,7 +25,7 @@ driver = "localhome" {{% /dir %}} {{% dir name="drivers" type="map[string]map[string]interface{}" default="localhome" %}} -The configuration for the storage driver [[Ref]](https://github.com/cs3org/reva/tree/master/internal/http/services/dataprovider/dataprovider.go#L44) +The configuration for the storage driver [[Ref]](https://github.com/cs3org/reva/tree/master/internal/http/services/dataprovider/dataprovider.go#L45) {{< highlight toml >}} [http.services.dataprovider.drivers.localhome] root = "/var/tmp/reva/" @@ -36,7 +36,7 @@ user_layout = "{{.Username}}" {{% /dir %}} {{% dir name="data_txs" type="map[string]map[string]interface{}" default="simple" %}} -The configuration for the data tx protocols [[Ref]](https://github.com/cs3org/reva/tree/master/internal/http/services/dataprovider/dataprovider.go#L45) +The configuration for the data tx protocols [[Ref]](https://github.com/cs3org/reva/tree/master/internal/http/services/dataprovider/dataprovider.go#L46) {{< highlight toml >}} [http.services.dataprovider.data_txs.simple] diff --git a/docs/content/en/docs/config/packages/storage/fs/local/_index.md b/docs/content/en/docs/config/packages/storage/fs/local/_index.md index 98892fe766..f7467ae3a0 100644 --- a/docs/content/en/docs/config/packages/storage/fs/local/_index.md +++ b/docs/content/en/docs/config/packages/storage/fs/local/_index.md @@ -9,7 +9,7 @@ description: > # _struct: config_ {{% dir name="root" type="string" default="/var/tmp/reva/" %}} -Path of root directory for user storage. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/storage/fs/local/local.go#L35) +Path of root directory for user storage. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/storage/fs/local/local.go#L36) {{< highlight toml >}} [storage.fs.local] root = "/var/tmp/reva/" @@ -17,7 +17,7 @@ root = "/var/tmp/reva/" {{% /dir %}} {{% dir name="share_folder" type="string" default="/MyShares" %}} -Path for storing share references. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/storage/fs/local/local.go#L36) +Path for storing share references. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/storage/fs/local/local.go#L37) {{< highlight toml >}} [storage.fs.local] share_folder = "/MyShares" @@ -25,7 +25,7 @@ share_folder = "/MyShares" {{% /dir %}} {{% dir name="user_layout" type="string" default="{{.Username}}" %}} -Template used for building the user's root path. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/storage/fs/local/local.go#L37) +Template used for building the user's root path. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/storage/fs/local/local.go#L38) {{< highlight toml >}} [storage.fs.local] user_layout = "{{.Username}}" @@ -33,7 +33,7 @@ user_layout = "{{.Username}}" {{% /dir %}} {{% dir name="disable_home" type="bool" default=false %}} -Enable/disable special /home handling. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/storage/fs/local/local.go#L38) +Enable/disable special /home handling. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/storage/fs/local/local.go#L39) {{< highlight toml >}} [storage.fs.local] disable_home = false diff --git a/docs/content/en/docs/config/packages/storage/fs/localhome/_index.md b/docs/content/en/docs/config/packages/storage/fs/localhome/_index.md index 90918d26b0..0288e9e6ae 100644 --- a/docs/content/en/docs/config/packages/storage/fs/localhome/_index.md +++ b/docs/content/en/docs/config/packages/storage/fs/localhome/_index.md @@ -9,7 +9,7 @@ description: > # _struct: config_ {{% dir name="root" type="string" default="/var/tmp/reva/" %}} -Path of root directory for user storage. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/storage/fs/localhome/localhome.go#L35) +Path of root directory for user storage. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/storage/fs/localhome/localhome.go#L36) {{< highlight toml >}} [storage.fs.localhome] root = "/var/tmp/reva/" @@ -17,7 +17,7 @@ root = "/var/tmp/reva/" {{% /dir %}} {{% dir name="share_folder" type="string" default="/MyShares" %}} -Path for storing share references. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/storage/fs/localhome/localhome.go#L36) +Path for storing share references. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/storage/fs/localhome/localhome.go#L37) {{< highlight toml >}} [storage.fs.localhome] share_folder = "/MyShares" @@ -25,7 +25,7 @@ share_folder = "/MyShares" {{% /dir %}} {{% dir name="user_layout" type="string" default="{{.Username}}" %}} -Template for user home directories [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/storage/fs/localhome/localhome.go#L37) +Template for user home directories [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/storage/fs/localhome/localhome.go#L38) {{< highlight toml >}} [storage.fs.localhome] user_layout = "{{.Username}}"