From 78316dd124da0e9d68cf3739604d3ed712955014 Mon Sep 17 00:00:00 2001 From: kobergj Date: Thu, 7 Sep 2023 13:28:06 +0000 Subject: [PATCH] Merge pull request #7217 from kobergj/ClientlogService Clientlog Service --- .../_includes/adoc/antivirus_configvars.adoc | 2 +- .../adoc/app-provider_configvars.adoc | 2 +- .../adoc/app-registry_configvars.adoc | 2 +- services/_includes/adoc/audit_configvars.adoc | 2 +- .../_includes/adoc/auth-basic_configvars.adoc | 2 +- .../adoc/auth-bearer_configvars.adoc | 2 +- .../adoc/auth-machine_configvars.adoc | 2 +- .../adoc/auth-service_configvars.adoc | 2 +- .../_includes/adoc/clientlog_configvars.adoc | 234 ++++++++++++++++++ .../_includes/adoc/clientlog_deprecation.adoc | 2 + .../adoc/eventhistory_configvars.adoc | 2 +- .../_includes/adoc/frontend_configvars.adoc | 2 +- .../_includes/adoc/gateway_configvars.adoc | 2 +- .../_includes/adoc/global_configvars.adoc | 164 ++++++++++-- services/_includes/adoc/graph_configvars.adoc | 2 +- .../_includes/adoc/groups_configvars.adoc | 2 +- services/_includes/adoc/idm_configvars.adoc | 2 +- services/_includes/adoc/idp_configvars.adoc | 2 +- .../adoc/invitations_configvars.adoc | 2 +- services/_includes/adoc/nats_configvars.adoc | 2 +- .../adoc/notifications_configvars.adoc | 2 +- services/_includes/adoc/ocdav_configvars.adoc | 2 +- services/_includes/adoc/ocs_configvars.adoc | 2 +- .../_includes/adoc/policies_configvars.adoc | 2 +- .../adoc/postprocessing_configvars.adoc | 2 +- services/_includes/adoc/proxy_configvars.adoc | 2 +- .../_includes/adoc/search_configvars.adoc | 2 +- .../_includes/adoc/settings_configvars.adoc | 2 +- .../_includes/adoc/sharing_configvars.adoc | 2 +- services/_includes/adoc/sse_configvars.adoc | 2 +- .../adoc/storage-publiclink_configvars.adoc | 2 +- .../adoc/storage-shares_configvars.adoc | 2 +- .../adoc/storage-system_configvars.adoc | 2 +- .../adoc/storage-users_configvars.adoc | 2 +- services/_includes/adoc/store_configvars.adoc | 2 +- .../_includes/adoc/thumbnails_configvars.adoc | 2 +- .../_includes/adoc/userlog_configvars.adoc | 12 +- services/_includes/adoc/users_configvars.adoc | 2 +- services/_includes/adoc/web_configvars.adoc | 2 +- .../_includes/adoc/webdav_configvars.adoc | 2 +- .../_includes/adoc/webfinger_configvars.adoc | 2 +- .../_includes/clientlog-config-example.yaml | 31 +++ services/_includes/clientlog_configvars.md | 25 ++ .../_includes/userlog-config-example.yaml | 1 - services/_includes/userlog_configvars.md | 1 - services/antivirus/_index.md | 2 +- services/audit/_index.md | 2 +- services/auth-basic/_index.md | 2 +- services/auth-bearer/_index.md | 2 +- services/auth-machine/_index.md | 2 +- services/eventhistory/_index.md | 2 +- services/frontend/_index.md | 2 +- services/gateway/_index.md | 2 +- .../general-info/new-service-checklist.md | 2 + services/general-info/port-ranges.md | 6 +- services/graph/_index.md | 2 +- services/idm/_index.md | 2 +- services/idp/_index.md | 2 +- services/invitations/_index.md | 2 +- services/nats/_index.md | 2 +- services/notifications/_index.md | 2 +- services/ocdav/_index.md | 2 +- services/ocs/_index.md | 2 +- services/policies/_index.md | 2 +- services/postprocessing/_index.md | 2 +- services/proxy/_index.md | 2 +- services/search/_index.md | 2 +- services/settings/_index.md | 2 +- services/sse/_index.md | 10 +- services/storage-system/_index.md | 2 +- services/storage-users/_index.md | 2 +- services/thumbnails/_index.md | 2 +- services/userlog/_index.md | 10 +- services/web/_index.md | 2 +- services/webdav/_index.md | 2 +- services/webfinger/_index.md | 2 +- 76 files changed, 530 insertions(+), 96 deletions(-) create mode 100644 services/_includes/adoc/clientlog_configvars.adoc create mode 100644 services/_includes/adoc/clientlog_deprecation.adoc create mode 100644 services/_includes/clientlog-config-example.yaml create mode 100644 services/_includes/clientlog_configvars.md diff --git a/services/_includes/adoc/antivirus_configvars.adoc b/services/_includes/adoc/antivirus_configvars.adoc index 48bd10ae995..eb6001dd39b 100644 --- a/services/_includes/adoc/antivirus_configvars.adoc +++ b/services/_includes/adoc/antivirus_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the antivirus service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/app-provider_configvars.adoc b/services/_includes/adoc/app-provider_configvars.adoc index a81a11d3f94..aef6a6ef3d8 100644 --- a/services/_includes/adoc/app-provider_configvars.adoc +++ b/services/_includes/adoc/app-provider_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the app-provider service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/app-registry_configvars.adoc b/services/_includes/adoc/app-registry_configvars.adoc index 15b33e77d3e..1365d8c0d08 100644 --- a/services/_includes/adoc/app-registry_configvars.adoc +++ b/services/_includes/adoc/app-registry_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the app-registry service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/audit_configvars.adoc b/services/_includes/adoc/audit_configvars.adoc index c60e5e03eef..1e6574e10ef 100644 --- a/services/_includes/adoc/audit_configvars.adoc +++ b/services/_includes/adoc/audit_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the audit service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/auth-basic_configvars.adoc b/services/_includes/adoc/auth-basic_configvars.adoc index 6d47ed545a1..61ee71a5e9c 100644 --- a/services/_includes/adoc/auth-basic_configvars.adoc +++ b/services/_includes/adoc/auth-basic_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the auth-basic service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/auth-bearer_configvars.adoc b/services/_includes/adoc/auth-bearer_configvars.adoc index 116a9ce3ad2..ba1344ed3c8 100644 --- a/services/_includes/adoc/auth-bearer_configvars.adoc +++ b/services/_includes/adoc/auth-bearer_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the auth-bearer service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/auth-machine_configvars.adoc b/services/_includes/adoc/auth-machine_configvars.adoc index 0fa6828525e..ba3eda5c271 100644 --- a/services/_includes/adoc/auth-machine_configvars.adoc +++ b/services/_includes/adoc/auth-machine_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the auth-machine service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/auth-service_configvars.adoc b/services/_includes/adoc/auth-service_configvars.adoc index 29fb0a5016f..e130d2e0228 100644 --- a/services/_includes/adoc/auth-service_configvars.adoc +++ b/services/_includes/adoc/auth-service_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the auth-service service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/clientlog_configvars.adoc b/services/_includes/adoc/clientlog_configvars.adoc new file mode 100644 index 00000000000..7fc30fc2f49 --- /dev/null +++ b/services/_includes/adoc/clientlog_configvars.adoc @@ -0,0 +1,234 @@ +// set the attribute to true or leave empty, true without any quotes. + +:show-deprecation: false + +ifeval::[{show-deprecation} == true] + +[#deprecation-note-2023-09-07-13-26-46] +[caption=] +.Deprecation notes for the clientlog service +[width="100%",cols="~,~,~,~",options="header"] +|=== +| Deprecation Info +| Deprecation Version +| Removal Version +| Deprecation Replacement +|=== + +endif::[] + +[caption=] +.Environment variables for the clientlog service +[width="100%",cols="~,~,~,~",options="header"] +|=== +| Name +| Type +| Default Value +| Description + +a|`OCIS_TRACING_ENABLED` + +`CLIENTLOG_TRACING_ENABLED` + + +a| [subs=-attributes] +++bool ++ +a| [subs=-attributes] +++false ++ +a| [subs=-attributes] +Activates tracing. + +a|`OCIS_TRACING_TYPE` + +`CLIENTLOG_TRACING_TYPE` + + +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. + +a|`OCIS_TRACING_ENDPOINT` + +`CLIENTLOG_TRACING_ENDPOINT` + + +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +The endpoint of the tracing agent. + +a|`OCIS_TRACING_COLLECTOR` + +`CLIENTLOG_TRACING_COLLECTOR` + + +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +The HTTP endpoint for sending spans directly to a collector, i.e. \http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. + +a|`OCIS_LOG_LEVEL` + +`USERLOG_LOG_LEVEL` + + +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +The log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'. + +a|`OCIS_LOG_PRETTY` + +`USERLOG_LOG_PRETTY` + + +a| [subs=-attributes] +++bool ++ +a| [subs=-attributes] +++false ++ +a| [subs=-attributes] +Activates pretty log output. + +a|`OCIS_LOG_COLOR` + +`USERLOG_LOG_COLOR` + + +a| [subs=-attributes] +++bool ++ +a| [subs=-attributes] +++false ++ +a| [subs=-attributes] +Activates colorized log output. + +a|`OCIS_LOG_FILE` + +`USERLOG_LOG_FILE` + + +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +The path to the log file. Activates logging to this file if set. + +a|`USERLOG_DEBUG_ADDR` + + +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++127.0.0.1:9260 ++ +a| [subs=-attributes] +Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. + +a|`USERLOG_DEBUG_TOKEN` + + +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +Token to secure the metrics endpoint. + +a|`USERLOG_DEBUG_PPROF` + + +a| [subs=-attributes] +++bool ++ +a| [subs=-attributes] +++false ++ +a| [subs=-attributes] +Enables pprof, which can be used for profiling. + +a|`USERLOG_DEBUG_ZPAGES` + + +a| [subs=-attributes] +++bool ++ +a| [subs=-attributes] +++false ++ +a| [subs=-attributes] +Enables zpages, which can be used for collecting and viewing in-memory traces. + +a|`OCIS_JWT_SECRET` + +`CLIENTLOG_JWT_SECRET` + + +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +The secret to mint and validate jwt tokens. + +a|`OCIS_REVA_GATEWAY` + + +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++com.owncloud.api.gateway ++ +a| [subs=-attributes] +CS3 gateway used to look up user metadata + +a|`OCIS_EVENTS_ENDPOINT` + +`CLIENTLOG_EVENTS_ENDPOINT` + + +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++127.0.0.1:9233 ++ +a| [subs=-attributes] +The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. + +a|`OCIS_EVENTS_CLUSTER` + +`CLIENTLOG_EVENTS_CLUSTER` + + +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ocis-cluster ++ +a| [subs=-attributes] +The clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Mandatory when using NATS as event system. + +a|`OCIS_INSECURE` + +`CLIENTLOG_EVENTS_TLS_INSECURE` + + +a| [subs=-attributes] +++bool ++ +a| [subs=-attributes] +++false ++ +a| [subs=-attributes] +Whether to verify the server TLS certificates. + +a|`OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE` + +`CLIENTLOG_EVENTS_TLS_ROOT_CA_CERTIFICATE` + + +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +The root CA certificate used to validate the server's TLS certificate. If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false. + +a|`OCIS_EVENTS_ENABLE_TLS` + +`CLIENTLOG_EVENTS_ENABLE_TLS` + + +a| [subs=-attributes] +++bool ++ +a| [subs=-attributes] +++false ++ +a| [subs=-attributes] +Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services.. + +a|`OCIS_SERVICE_ACCOUNT_ID` + +`CLIENTLOG_SERVICE_ACCOUNT_ID` + + +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +The ID of the service account the service should use. See the 'auth-service' service description for more details. + +a|`OCIS_SERVICE_ACCOUNT_SECRET` + +`CLIENTLOG_SERVICE_ACCOUNT_SECRET` + + +a| [subs=-attributes] +++string ++ +a| [subs=-attributes] +++ ++ +a| [subs=-attributes] +The service account secret. +|=== + diff --git a/services/_includes/adoc/clientlog_deprecation.adoc b/services/_includes/adoc/clientlog_deprecation.adoc new file mode 100644 index 00000000000..4b3cef689ac --- /dev/null +++ b/services/_includes/adoc/clientlog_deprecation.adoc @@ -0,0 +1,2 @@ +:show-deprecation: false + diff --git a/services/_includes/adoc/eventhistory_configvars.adoc b/services/_includes/adoc/eventhistory_configvars.adoc index 78ec03120a7..74107081772 100644 --- a/services/_includes/adoc/eventhistory_configvars.adoc +++ b/services/_includes/adoc/eventhistory_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the eventhistory service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/frontend_configvars.adoc b/services/_includes/adoc/frontend_configvars.adoc index ebb2ddff469..631f70b92b6 100644 --- a/services/_includes/adoc/frontend_configvars.adoc +++ b/services/_includes/adoc/frontend_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the frontend service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/gateway_configvars.adoc b/services/_includes/adoc/gateway_configvars.adoc index 58d012a86a7..85190cdaa2a 100644 --- a/services/_includes/adoc/gateway_configvars.adoc +++ b/services/_includes/adoc/gateway_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the gateway service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/global_configvars.adoc b/services/_includes/adoc/global_configvars.adoc index 893a979e02e..f26a6ff4c6d 100644 --- a/services/_includes/adoc/global_configvars.adoc +++ b/services/_includes/adoc/global_configvars.adoc @@ -48,7 +48,7 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -The default role assignments the demo users should be setup. +Flag to enable or disable the creation of the demo users. a| `LDAP_BIND_PASSWORD` @@ -144,7 +144,7 @@ a| [subs=-attributes] ++0 ++ a| [subs=-attributes] -The maximum quantity of items in the user info cache. Only applies when store type 'ocmem' is configured. Defaults to 512. +The maximum quantity of items in the cache. Only applies when store type 'ocmem' is configured. Defaults to 512. a| `OCIS_CACHE_STORE` @@ -213,10 +213,10 @@ a| [subs=-attributes] ++Duration ++ a| [subs=-attributes] -++24m0s ++ +++10m0s ++ a| [subs=-attributes] -Default time to live for user info in the user info cache. Only applied when access tokens has no expiration. The duration can be set as number followed by a unit identifier like s, m or h. Defaults to '10s' (10 seconds). +Default time to live for entries in the cache. Only applied when access tokens has no expiration. The duration can be set as number followed by a unit identifier like s, m or h. Defaults to '10m' (10 minutes). a| `OCIS_CORS_ALLOW_CREDENTIALS` @@ -261,7 +261,7 @@ a| [subs=-attributes] ++[]string ++ a| [subs=-attributes] -++[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id Ocs-Apirequest] ++ +++[Origin Accept Content-Type Depth Authorization Ocs-Apirequest If-None-Match If-Match Destination Overwrite X-Request-Id X-Requested-With Tus-Resumable Tus-Checksum-Algorithm Upload-Concat Upload-Length Upload-Metadata Upload-Defer-Length Upload-Expires Upload-Checksum Upload-Offset X-HTTP-Method-Override Cache-Control] ++ a| [subs=-attributes] A blank or comma-separated list of allowed CORS headers. See following chapter for more details: *Access-Control-Request-Headers* at \https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. @@ -285,7 +285,7 @@ a| [subs=-attributes] ++[]string ++ a| [subs=-attributes] -++[GET] ++ +++[OPTIONS HEAD GET PUT POST DELETE MKCOL PROPFIND PROPPATCH MOVE COPY REPORT SEARCH] ++ a| [subs=-attributes] A comma-separated list of allowed CORS methods. See following chapter for more details: *Access-Control-Request-Method* at \https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method @@ -379,6 +379,7 @@ a| `OCIS_EVENTS_CLUSTER` a| [subs=attributes+] * xref:{s-path}/antivirus.adoc[antivirus] + * xref:{s-path}/audit.adoc[audit] + +* xref:{s-path}/clientlog.adoc[clientlog] + * xref:{s-path}/eventhistory.adoc[eventhistory] + * xref:{s-path}/frontend.adoc[frontend] + * xref:{s-path}/graph.adoc[graph] + @@ -405,6 +406,7 @@ a| `OCIS_EVENTS_ENABLE_TLS` a| [subs=attributes+] * xref:{s-path}/antivirus.adoc[antivirus] + * xref:{s-path}/audit.adoc[audit] + +* xref:{s-path}/clientlog.adoc[clientlog] + * xref:{s-path}/eventhistory.adoc[eventhistory] + * xref:{s-path}/frontend.adoc[frontend] + * xref:{s-path}/graph.adoc[graph] + @@ -425,13 +427,14 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services. +Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services.. a| `OCIS_EVENTS_ENDPOINT` a| [subs=attributes+] * xref:{s-path}/antivirus.adoc[antivirus] + * xref:{s-path}/audit.adoc[audit] + +* xref:{s-path}/clientlog.adoc[clientlog] + * xref:{s-path}/eventhistory.adoc[eventhistory] + * xref:{s-path}/frontend.adoc[frontend] + * xref:{s-path}/graph.adoc[graph] + @@ -458,6 +461,7 @@ a| `OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE` a| [subs=attributes+] * xref:{s-path}/antivirus.adoc[antivirus] + * xref:{s-path}/audit.adoc[audit] + +* xref:{s-path}/clientlog.adoc[clientlog] + * xref:{s-path}/eventhistory.adoc[eventhistory] + * xref:{s-path}/graph.adoc[graph] + * xref:{s-path}/notifications.adoc[notifications] + @@ -476,7 +480,7 @@ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -The root CA certificate used to validate the server's TLS certificate. If provided SSE_EVENTS_TLS_INSECURE will be seen as false. +The root CA certificate used to validate the server's TLS certificate. If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false. a| `OCIS_GRPC_CLIENT_TLS_CACERT` @@ -623,6 +627,7 @@ a| [subs=attributes+] * xref:{s-path}/antivirus.adoc[antivirus] + * xref:{s-path}/audit.adoc[audit] + * xref:{s-path}/auth-bearer.adoc[auth-bearer] + +* xref:{s-path}/clientlog.adoc[clientlog] + * xref:{s-path}/eventhistory.adoc[eventhistory] + * xref:{s-path}/frontend.adoc[frontend] + * xref:{s-path}/frontend.adoc[frontend] + @@ -662,6 +667,7 @@ a| [subs=attributes+] * xref:{s-path}/auth-bearer.adoc[auth-bearer] + * xref:{s-path}/auth-machine.adoc[auth-machine] + * xref:{s-path}/auth-service.adoc[auth-service] + +* xref:{s-path}/clientlog.adoc[clientlog] + * xref:{s-path}/frontend.adoc[frontend] + * xref:{s-path}/gateway.adoc[gateway] + * xref:{s-path}/graph.adoc[graph] + @@ -720,7 +726,7 @@ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -The client id to authenticate with keycloak. +The client ID to authenticate with keycloak. a| `OCIS_KEYCLOAK_CLIENT_REALM` @@ -1271,6 +1277,7 @@ a| [subs=attributes+] * xref:{s-path}/auth-bearer.adoc[auth-bearer] + * xref:{s-path}/auth-machine.adoc[auth-machine] + * xref:{s-path}/auth-service.adoc[auth-service] + +* xref:{s-path}/clientlog.adoc[clientlog] + * xref:{s-path}/eventhistory.adoc[eventhistory] + * xref:{s-path}/frontend.adoc[frontend] + * xref:{s-path}/gateway.adoc[gateway] + @@ -1322,6 +1329,7 @@ a| [subs=attributes+] * xref:{s-path}/auth-bearer.adoc[auth-bearer] + * xref:{s-path}/auth-machine.adoc[auth-machine] + * xref:{s-path}/auth-service.adoc[auth-service] + +* xref:{s-path}/clientlog.adoc[clientlog] + * xref:{s-path}/eventhistory.adoc[eventhistory] + * xref:{s-path}/frontend.adoc[frontend] + * xref:{s-path}/gateway.adoc[gateway] + @@ -1373,6 +1381,7 @@ a| [subs=attributes+] * xref:{s-path}/auth-bearer.adoc[auth-bearer] + * xref:{s-path}/auth-machine.adoc[auth-machine] + * xref:{s-path}/auth-service.adoc[auth-service] + +* xref:{s-path}/clientlog.adoc[clientlog] + * xref:{s-path}/eventhistory.adoc[eventhistory] + * xref:{s-path}/frontend.adoc[frontend] + * xref:{s-path}/gateway.adoc[gateway] + @@ -1424,6 +1433,7 @@ a| [subs=attributes+] * xref:{s-path}/auth-bearer.adoc[auth-bearer] + * xref:{s-path}/auth-machine.adoc[auth-machine] + * xref:{s-path}/auth-service.adoc[auth-service] + +* xref:{s-path}/clientlog.adoc[clientlog] + * xref:{s-path}/eventhistory.adoc[eventhistory] + * xref:{s-path}/frontend.adoc[frontend] + * xref:{s-path}/gateway.adoc[gateway] + @@ -1473,7 +1483,6 @@ a| [subs=attributes+] * xref:{s-path}/ocdav.adoc[ocdav] + * xref:{s-path}/policies.adoc[policies] + * xref:{s-path}/proxy.adoc[proxy] + -* xref:{s-path}/userlog.adoc[userlog] + a| [subs=-attributes] ++string ++ @@ -1578,6 +1587,7 @@ a| [subs=attributes+] * xref:{s-path}/auth-bearer.adoc[auth-bearer] + * xref:{s-path}/auth-machine.adoc[auth-machine] + * xref:{s-path}/auth-service.adoc[auth-service] + +* xref:{s-path}/clientlog.adoc[clientlog] + * xref:{s-path}/frontend.adoc[frontend] + * xref:{s-path}/gateway.adoc[gateway] + * xref:{s-path}/graph.adoc[graph] + @@ -1611,6 +1621,7 @@ a| `OCIS_SERVICE_ACCOUNT_ID` a| [subs=attributes+] * xref:{s-path}/auth-service.adoc[auth-service] + +* xref:{s-path}/clientlog.adoc[clientlog] + * xref:{s-path}/frontend.adoc[frontend] + * xref:{s-path}/graph.adoc[graph] + * xref:{s-path}/notifications.adoc[notifications] + @@ -1632,6 +1643,7 @@ a| `OCIS_SERVICE_ACCOUNT_SECRET` a| [subs=attributes+] * xref:{s-path}/auth-service.adoc[auth-service] + +* xref:{s-path}/clientlog.adoc[clientlog] + * xref:{s-path}/frontend.adoc[frontend] + * xref:{s-path}/graph.adoc[graph] + * xref:{s-path}/notifications.adoc[notifications] + @@ -1676,7 +1688,7 @@ a| [subs=-attributes] ++0 ++ a| [subs=-attributes] -Set the global max quota value in bytes. A value of 0 equals unlimited. The value is provided via capabilities. +Set a global max quota for spaces in bytes. A value of 0 equals unlimited. If not using the global OCIS_SPACES_MAX_QUOTA, you must define the FRONTEND_MAX_QUOTA in the frontend service. a| `OCIS_SYSTEM_USER_API_KEY` @@ -1714,7 +1726,7 @@ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -ID of the oCIS storage-system system user. Admins need to set the ID for the STORAGE-SYSTEM system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format. +ID of the oCIS STORAGE-SYSTEM system user. Admins need to set the ID for the STORAGE-SYSTEM system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format. a| `OCIS_SYSTEM_USER_IDP` @@ -1745,6 +1757,7 @@ a| [subs=attributes+] * xref:{s-path}/auth-bearer.adoc[auth-bearer] + * xref:{s-path}/auth-machine.adoc[auth-machine] + * xref:{s-path}/auth-service.adoc[auth-service] + +* xref:{s-path}/clientlog.adoc[clientlog] + * xref:{s-path}/eventhistory.adoc[eventhistory] + * xref:{s-path}/frontend.adoc[frontend] + * xref:{s-path}/gateway.adoc[gateway] + @@ -1796,6 +1809,7 @@ a| [subs=attributes+] * xref:{s-path}/auth-bearer.adoc[auth-bearer] + * xref:{s-path}/auth-machine.adoc[auth-machine] + * xref:{s-path}/auth-service.adoc[auth-service] + +* xref:{s-path}/clientlog.adoc[clientlog] + * xref:{s-path}/eventhistory.adoc[eventhistory] + * xref:{s-path}/frontend.adoc[frontend] + * xref:{s-path}/gateway.adoc[gateway] + @@ -1847,6 +1861,7 @@ a| [subs=attributes+] * xref:{s-path}/auth-bearer.adoc[auth-bearer] + * xref:{s-path}/auth-machine.adoc[auth-machine] + * xref:{s-path}/auth-service.adoc[auth-service] + +* xref:{s-path}/clientlog.adoc[clientlog] + * xref:{s-path}/eventhistory.adoc[eventhistory] + * xref:{s-path}/frontend.adoc[frontend] + * xref:{s-path}/gateway.adoc[gateway] + @@ -1898,6 +1913,7 @@ a| [subs=attributes+] * xref:{s-path}/auth-bearer.adoc[auth-bearer] + * xref:{s-path}/auth-machine.adoc[auth-machine] + * xref:{s-path}/auth-service.adoc[auth-service] + +* xref:{s-path}/clientlog.adoc[clientlog] + * xref:{s-path}/eventhistory.adoc[eventhistory] + * xref:{s-path}/frontend.adoc[frontend] + * xref:{s-path}/gateway.adoc[gateway] + @@ -1979,10 +1995,10 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++https://127.0.0.1:9200 ++ +++https://localhost:9200 ++ a| [subs=-attributes] -URL, where oCIS is reachable for users. +The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. a| `STORAGE_USERS_ASYNC_PROPAGATOR_PROPAGATION_DELAY` @@ -2014,6 +2030,126 @@ a| [subs=-attributes] a| [subs=-attributes] Endpoint of the permissions service. The endpoints can differ for 'ocis' and 's3ng'. +a| `USERLOG_DEBUG_ADDR` + +a| [subs=attributes+] +* xref:{s-path}/clientlog.adoc[clientlog] + +* xref:{s-path}/userlog.adoc[userlog] + + +a| [subs=-attributes] +++string ++ + +a| [subs=-attributes] +++127.0.0.1:9260 ++ + +a| [subs=-attributes] +Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. + +a| `USERLOG_DEBUG_PPROF` + +a| [subs=attributes+] +* xref:{s-path}/clientlog.adoc[clientlog] + +* xref:{s-path}/userlog.adoc[userlog] + + +a| [subs=-attributes] +++bool ++ + +a| [subs=-attributes] +++false ++ + +a| [subs=-attributes] +Enables pprof, which can be used for profiling. + +a| `USERLOG_DEBUG_TOKEN` + +a| [subs=attributes+] +* xref:{s-path}/clientlog.adoc[clientlog] + +* xref:{s-path}/userlog.adoc[userlog] + + +a| [subs=-attributes] +++string ++ + +a| [subs=-attributes] +++ ++ + +a| [subs=-attributes] +Token to secure the metrics endpoint. + +a| `USERLOG_DEBUG_ZPAGES` + +a| [subs=attributes+] +* xref:{s-path}/clientlog.adoc[clientlog] + +* xref:{s-path}/userlog.adoc[userlog] + + +a| [subs=-attributes] +++bool ++ + +a| [subs=-attributes] +++false ++ + +a| [subs=-attributes] +Enables zpages, which can be used for collecting and viewing in-memory traces. + +a| `USERLOG_LOG_COLOR` + +a| [subs=attributes+] +* xref:{s-path}/clientlog.adoc[clientlog] + +* xref:{s-path}/userlog.adoc[userlog] + + +a| [subs=-attributes] +++bool ++ + +a| [subs=-attributes] +++false ++ + +a| [subs=-attributes] +Activates colorized log output. + +a| `USERLOG_LOG_FILE` + +a| [subs=attributes+] +* xref:{s-path}/clientlog.adoc[clientlog] + +* xref:{s-path}/userlog.adoc[userlog] + + +a| [subs=-attributes] +++string ++ + +a| [subs=-attributes] +++ ++ + +a| [subs=-attributes] +The path to the log file. Activates logging to this file if set. + +a| `USERLOG_LOG_LEVEL` + +a| [subs=attributes+] +* xref:{s-path}/clientlog.adoc[clientlog] + +* xref:{s-path}/userlog.adoc[userlog] + + +a| [subs=-attributes] +++string ++ + +a| [subs=-attributes] +++ ++ + +a| [subs=-attributes] +The log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'. + +a| `USERLOG_LOG_PRETTY` + +a| [subs=attributes+] +* xref:{s-path}/clientlog.adoc[clientlog] + +* xref:{s-path}/userlog.adoc[userlog] + + +a| [subs=-attributes] +++bool ++ + +a| [subs=-attributes] +++false ++ + +a| [subs=-attributes] +Activates pretty log output. + a| `WEB_UI_CONFIG_FILE` a| [subs=attributes+] diff --git a/services/_includes/adoc/graph_configvars.adoc b/services/_includes/adoc/graph_configvars.adoc index c704ea1a7cb..71e01de0665 100644 --- a/services/_includes/adoc/graph_configvars.adoc +++ b/services/_includes/adoc/graph_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the graph service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/groups_configvars.adoc b/services/_includes/adoc/groups_configvars.adoc index c7423f28689..25b8b983ed0 100644 --- a/services/_includes/adoc/groups_configvars.adoc +++ b/services/_includes/adoc/groups_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the groups service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/idm_configvars.adoc b/services/_includes/adoc/idm_configvars.adoc index 80dc5d0eaed..e64d358592f 100644 --- a/services/_includes/adoc/idm_configvars.adoc +++ b/services/_includes/adoc/idm_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the idm service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/idp_configvars.adoc b/services/_includes/adoc/idp_configvars.adoc index 3382fde5697..3149a138c07 100644 --- a/services/_includes/adoc/idp_configvars.adoc +++ b/services/_includes/adoc/idp_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the idp service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/invitations_configvars.adoc b/services/_includes/adoc/invitations_configvars.adoc index d0e7088e738..fb95d26df9b 100644 --- a/services/_includes/adoc/invitations_configvars.adoc +++ b/services/_includes/adoc/invitations_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the invitations service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/nats_configvars.adoc b/services/_includes/adoc/nats_configvars.adoc index a5948b0566b..d77b19d2306 100644 --- a/services/_includes/adoc/nats_configvars.adoc +++ b/services/_includes/adoc/nats_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the nats service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/notifications_configvars.adoc b/services/_includes/adoc/notifications_configvars.adoc index 0683c821bb7..cb87667fc64 100644 --- a/services/_includes/adoc/notifications_configvars.adoc +++ b/services/_includes/adoc/notifications_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the notifications service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/ocdav_configvars.adoc b/services/_includes/adoc/ocdav_configvars.adoc index f316d963a9c..c42d18ecfe1 100644 --- a/services/_includes/adoc/ocdav_configvars.adoc +++ b/services/_includes/adoc/ocdav_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the ocdav service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/ocs_configvars.adoc b/services/_includes/adoc/ocs_configvars.adoc index 7860b36700e..7281f3bb9e7 100644 --- a/services/_includes/adoc/ocs_configvars.adoc +++ b/services/_includes/adoc/ocs_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the ocs service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/policies_configvars.adoc b/services/_includes/adoc/policies_configvars.adoc index 46b97e14f76..08b2d3b54e4 100644 --- a/services/_includes/adoc/policies_configvars.adoc +++ b/services/_includes/adoc/policies_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the policies service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/postprocessing_configvars.adoc b/services/_includes/adoc/postprocessing_configvars.adoc index 4bed4122200..46546570673 100644 --- a/services/_includes/adoc/postprocessing_configvars.adoc +++ b/services/_includes/adoc/postprocessing_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the postprocessing service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/proxy_configvars.adoc b/services/_includes/adoc/proxy_configvars.adoc index d61a45dc91d..2f175407452 100644 --- a/services/_includes/adoc/proxy_configvars.adoc +++ b/services/_includes/adoc/proxy_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the proxy service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/search_configvars.adoc b/services/_includes/adoc/search_configvars.adoc index 8c1e6d862a1..b9de804b5cc 100644 --- a/services/_includes/adoc/search_configvars.adoc +++ b/services/_includes/adoc/search_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the search service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/settings_configvars.adoc b/services/_includes/adoc/settings_configvars.adoc index 280093812e8..7d125e09f7e 100644 --- a/services/_includes/adoc/settings_configvars.adoc +++ b/services/_includes/adoc/settings_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the settings service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/sharing_configvars.adoc b/services/_includes/adoc/sharing_configvars.adoc index 53fb06b8d53..7f51a62bf99 100644 --- a/services/_includes/adoc/sharing_configvars.adoc +++ b/services/_includes/adoc/sharing_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the sharing service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/sse_configvars.adoc b/services/_includes/adoc/sse_configvars.adoc index b52cc3c6618..a66c676e066 100644 --- a/services/_includes/adoc/sse_configvars.adoc +++ b/services/_includes/adoc/sse_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the sse service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/storage-publiclink_configvars.adoc b/services/_includes/adoc/storage-publiclink_configvars.adoc index fa696ffbdeb..ca06d26df4b 100644 --- a/services/_includes/adoc/storage-publiclink_configvars.adoc +++ b/services/_includes/adoc/storage-publiclink_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the storage-publiclink service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/storage-shares_configvars.adoc b/services/_includes/adoc/storage-shares_configvars.adoc index 42c7704701a..4742e79b432 100644 --- a/services/_includes/adoc/storage-shares_configvars.adoc +++ b/services/_includes/adoc/storage-shares_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the storage-shares service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/storage-system_configvars.adoc b/services/_includes/adoc/storage-system_configvars.adoc index 446e82d01e5..22b2346f998 100644 --- a/services/_includes/adoc/storage-system_configvars.adoc +++ b/services/_includes/adoc/storage-system_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the storage-system service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/storage-users_configvars.adoc b/services/_includes/adoc/storage-users_configvars.adoc index 6c32e0d0d5c..4a08ca0c646 100644 --- a/services/_includes/adoc/storage-users_configvars.adoc +++ b/services/_includes/adoc/storage-users_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the storage-users service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/store_configvars.adoc b/services/_includes/adoc/store_configvars.adoc index ef8aea60608..3ace8bc5475 100644 --- a/services/_includes/adoc/store_configvars.adoc +++ b/services/_includes/adoc/store_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the store service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/thumbnails_configvars.adoc b/services/_includes/adoc/thumbnails_configvars.adoc index 7ee01e1c6ed..4fb743fe890 100644 --- a/services/_includes/adoc/thumbnails_configvars.adoc +++ b/services/_includes/adoc/thumbnails_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the thumbnails service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/userlog_configvars.adoc b/services/_includes/adoc/userlog_configvars.adoc index bba595c5831..4951b4eaf54 100644 --- a/services/_includes/adoc/userlog_configvars.adoc +++ b/services/_includes/adoc/userlog_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the userlog service [width="100%",cols="~,~,~,~",options="header"] @@ -237,16 +237,6 @@ a| [subs=-attributes] a| [subs=-attributes] The secret to mint and validate jwt tokens. -a|`OCIS_MACHINE_AUTH_API_KEY` + -`USERLOG_MACHINE_AUTH_API_KEY` + - -a| [subs=-attributes] -++string ++ -a| [subs=-attributes] -++ ++ -a| [subs=-attributes] -Machine auth API key used to validate internal requests necessary to access resources from other services. - a|`OCIS_REVA_GATEWAY` + a| [subs=-attributes] diff --git a/services/_includes/adoc/users_configvars.adoc b/services/_includes/adoc/users_configvars.adoc index 5c92fa3a2c8..21e12a8ce35 100644 --- a/services/_includes/adoc/users_configvars.adoc +++ b/services/_includes/adoc/users_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the users service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/web_configvars.adoc b/services/_includes/adoc/web_configvars.adoc index d772af71e02..f6b23e9bd00 100644 --- a/services/_includes/adoc/web_configvars.adoc +++ b/services/_includes/adoc/web_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the web service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/webdav_configvars.adoc b/services/_includes/adoc/webdav_configvars.adoc index c6892f851e8..f7d9c384990 100644 --- a/services/_includes/adoc/webdav_configvars.adoc +++ b/services/_includes/adoc/webdav_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the webdav service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/adoc/webfinger_configvars.adoc b/services/_includes/adoc/webfinger_configvars.adoc index 07b3afd75ff..207facdfb6e 100644 --- a/services/_includes/adoc/webfinger_configvars.adoc +++ b/services/_includes/adoc/webfinger_configvars.adoc @@ -4,7 +4,7 @@ ifeval::[{show-deprecation} == true] -[#deprecation-note-2023-09-07-11-00-14] +[#deprecation-note-2023-09-07-13-26-46] [caption=] .Deprecation notes for the webfinger service [width="100%",cols="~,~,~,~",options="header"] diff --git a/services/_includes/clientlog-config-example.yaml b/services/_includes/clientlog-config-example.yaml new file mode 100644 index 00000000000..dc2570efb01 --- /dev/null +++ b/services/_includes/clientlog-config-example.yaml @@ -0,0 +1,31 @@ +# Autogenerated +# Filename: clientlog-config-example.yaml + +tracing: + enabled: false + type: "" + endpoint: "" + collector: "" +log: + level: "" + pretty: false + color: false + file: "" +debug: + addr: 127.0.0.1:9260 + token: "" + pprof: false + zpages: false +grpc_client_tls: null +token_manager: + jwt_secret: "" +reva_gateway: com.owncloud.api.gateway +events: + endpoint: 127.0.0.1:9233 + cluster: ocis-cluster + tls_insecure: false + tls_root_ca_certificate: "" + enable_tls: false +service_account: + service_account_id: "" + service_account_secret: "" diff --git a/services/_includes/clientlog_configvars.md b/services/_includes/clientlog_configvars.md new file mode 100644 index 00000000000..6e626633241 --- /dev/null +++ b/services/_includes/clientlog_configvars.md @@ -0,0 +1,25 @@ +## Environment Variables + +| Name | Type | Default Value | Description | +|------|------|---------------|-------------| +| OCIS_TRACING_ENABLED
CLIENTLOG_TRACING_ENABLED | bool | false | Activates tracing.| +| OCIS_TRACING_TYPE
CLIENTLOG_TRACING_TYPE | string | | The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now.| +| OCIS_TRACING_ENDPOINT
CLIENTLOG_TRACING_ENDPOINT | string | | The endpoint of the tracing agent.| +| OCIS_TRACING_COLLECTOR
CLIENTLOG_TRACING_COLLECTOR | string | | The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset.| +| OCIS_LOG_LEVEL
USERLOG_LOG_LEVEL | string | | The log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'.| +| OCIS_LOG_PRETTY
USERLOG_LOG_PRETTY | bool | false | Activates pretty log output.| +| OCIS_LOG_COLOR
USERLOG_LOG_COLOR | bool | false | Activates colorized log output.| +| OCIS_LOG_FILE
USERLOG_LOG_FILE | string | | The path to the log file. Activates logging to this file if set.| +| USERLOG_DEBUG_ADDR | string | 127.0.0.1:9260 | Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.| +| USERLOG_DEBUG_TOKEN | string | | Token to secure the metrics endpoint.| +| USERLOG_DEBUG_PPROF | bool | false | Enables pprof, which can be used for profiling.| +| USERLOG_DEBUG_ZPAGES | bool | false | Enables zpages, which can be used for collecting and viewing in-memory traces.| +| OCIS_JWT_SECRET
CLIENTLOG_JWT_SECRET | string | | The secret to mint and validate jwt tokens.| +| OCIS_REVA_GATEWAY | string | com.owncloud.api.gateway | CS3 gateway used to look up user metadata| +| OCIS_EVENTS_ENDPOINT
CLIENTLOG_EVENTS_ENDPOINT | string | 127.0.0.1:9233 | The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture.| +| OCIS_EVENTS_CLUSTER
CLIENTLOG_EVENTS_CLUSTER | string | ocis-cluster | The clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Mandatory when using NATS as event system.| +| OCIS_INSECURE
CLIENTLOG_EVENTS_TLS_INSECURE | bool | false | Whether to verify the server TLS certificates.| +| OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE
CLIENTLOG_EVENTS_TLS_ROOT_CA_CERTIFICATE | string | | The root CA certificate used to validate the server's TLS certificate. If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false.| +| OCIS_EVENTS_ENABLE_TLS
CLIENTLOG_EVENTS_ENABLE_TLS | bool | false | Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services..| +| OCIS_SERVICE_ACCOUNT_ID
CLIENTLOG_SERVICE_ACCOUNT_ID | string | | The ID of the service account the service should use. See the 'auth-service' service description for more details.| +| OCIS_SERVICE_ACCOUNT_SECRET
CLIENTLOG_SERVICE_ACCOUNT_SECRET | string | | The service account secret.| \ No newline at end of file diff --git a/services/_includes/userlog-config-example.yaml b/services/_includes/userlog-config-example.yaml index 70d14c8e674..7afd43af3aa 100644 --- a/services/_includes/userlog-config-example.yaml +++ b/services/_includes/userlog-config-example.yaml @@ -40,7 +40,6 @@ http: grpc_client_tls: null token_manager: jwt_secret: "" -machine_auth_api_key: "" reva_gateway: com.owncloud.api.gateway translation_path: "" events: diff --git a/services/_includes/userlog_configvars.md b/services/_includes/userlog_configvars.md index e342d40bfb4..2e15be061e9 100644 --- a/services/_includes/userlog_configvars.md +++ b/services/_includes/userlog_configvars.md @@ -24,7 +24,6 @@ | OCIS_HTTP_TLS_CERTIFICATE | string | | Path/File name of the TLS server certificate (in PEM format) for the http services.| | OCIS_HTTP_TLS_KEY | string | | Path/File name for the TLS certificate key (in PEM format) for the server certificate to use for the http services.| | OCIS_JWT_SECRET
USERLOG_JWT_SECRET | string | | The secret to mint and validate jwt tokens.| -| OCIS_MACHINE_AUTH_API_KEY
USERLOG_MACHINE_AUTH_API_KEY | string | | Machine auth API key used to validate internal requests necessary to access resources from other services.| | OCIS_REVA_GATEWAY | string | com.owncloud.api.gateway | CS3 gateway used to look up user metadata| | OCIS_TRANSLATION_PATH
USERLOG_TRANSLATION_PATH | string | | (optional) Set this to a path with custom translations to overwrite the builtin translations. Note that file and folder naming rules apply, see the documentation for more details.| | OCIS_EVENTS_ENDPOINT
USERLOG_EVENTS_ENDPOINT | string | 127.0.0.1:9233 | The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture.| diff --git a/services/antivirus/_index.md b/services/antivirus/_index.md index e495a777f42..c85195bab04 100644 --- a/services/antivirus/_index.md +++ b/services/antivirus/_index.md @@ -1,6 +1,6 @@ --- title: Antivirus -date: 2023-09-07T11:00:17.964750069Z +date: 2023-09-07T13:26:46.797935117Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/antivirus diff --git a/services/audit/_index.md b/services/audit/_index.md index 0a88619afee..79382efbdf2 100644 --- a/services/audit/_index.md +++ b/services/audit/_index.md @@ -1,6 +1,6 @@ --- title: Audit -date: 2023-09-07T11:00:17.964915449Z +date: 2023-09-07T13:26:46.798136773Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/audit diff --git a/services/auth-basic/_index.md b/services/auth-basic/_index.md index 82f1c19dde5..9885d7bb371 100644 --- a/services/auth-basic/_index.md +++ b/services/auth-basic/_index.md @@ -1,6 +1,6 @@ --- title: Auth-Basic -date: 2023-09-07T11:00:17.964985981Z +date: 2023-09-07T13:26:46.79822555Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/auth-basic diff --git a/services/auth-bearer/_index.md b/services/auth-bearer/_index.md index b16c75371df..1230c0bed53 100644 --- a/services/auth-bearer/_index.md +++ b/services/auth-bearer/_index.md @@ -1,6 +1,6 @@ --- title: Auth-Bearer -date: 2023-09-07T11:00:17.965086641Z +date: 2023-09-07T13:26:46.798314215Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/auth-bearer diff --git a/services/auth-machine/_index.md b/services/auth-machine/_index.md index d58cdebb5ab..225daa5f016 100644 --- a/services/auth-machine/_index.md +++ b/services/auth-machine/_index.md @@ -1,6 +1,6 @@ --- title: Auth-Machine -date: 2023-09-07T11:00:17.965174055Z +date: 2023-09-07T13:26:46.798419731Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/auth-machine diff --git a/services/eventhistory/_index.md b/services/eventhistory/_index.md index d6488e09ca1..1a3b6ad3da5 100644 --- a/services/eventhistory/_index.md +++ b/services/eventhistory/_index.md @@ -1,6 +1,6 @@ --- title: Eventhistory -date: 2023-09-07T11:00:17.965417292Z +date: 2023-09-07T13:26:46.798942176Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/eventhistory diff --git a/services/frontend/_index.md b/services/frontend/_index.md index 8e29ce8904f..49413260a6e 100644 --- a/services/frontend/_index.md +++ b/services/frontend/_index.md @@ -1,6 +1,6 @@ --- title: Frontend -date: 2023-09-07T11:00:17.965535384Z +date: 2023-09-07T13:26:46.799044607Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/frontend diff --git a/services/gateway/_index.md b/services/gateway/_index.md index 8d385e2de98..8fe25e67988 100644 --- a/services/gateway/_index.md +++ b/services/gateway/_index.md @@ -1,6 +1,6 @@ --- title: Gateway -date: 2023-09-07T11:00:17.965669385Z +date: 2023-09-07T13:26:46.799154042Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/gateway diff --git a/services/general-info/new-service-checklist.md b/services/general-info/new-service-checklist.md index 45dbf364bd8..dd50d3f1e7f 100644 --- a/services/general-info/new-service-checklist.md +++ b/services/general-info/new-service-checklist.md @@ -28,6 +28,8 @@ Use this checklist with copy/paste in your PR - right from the beginning. It ren - [ ] Make the service startable for binary and individual startup: - For single binary add service to `ocis/pkg/runtime` - For individual startup add service to `ocis/pkg/commands` + - Add the service config to `ocis-pkg/config/defaultconfig.go` +- [ ] If the service is using service accounts, add it to `ocis/pkg/init/init.go` - [ ] Add the service to `.drone.star` to enable CI. - [ ] Inform doc team in an _early stage_ to review the readme AND the environment variables created. - The description must reflect the behaviour AND usually has a positive code quality impact. diff --git a/services/general-info/port-ranges.md b/services/general-info/port-ranges.md index e3baac04d54..2252255da49 100644 --- a/services/general-info/port-ranges.md +++ b/services/general-info/port-ranges.md @@ -52,7 +52,7 @@ We also suggest to use the last port in your extensions' range as a debug/metric | 9195-9199 | FREE | | 9200-9204 | [proxy]({{< ref "../proxy/_index.md" >}}) | | 9205-9209 | [proxy]({{< ref "../proxy/_index.md" >}}) | -| 9210-9214 | [userlog]{{< ref "../userlog/_index.md" >}} | +| 9210-9214 | [userlog]({{< ref "../userlog/_index.md" >}}) | | 9215-9219 | [storage-system]({{< ref "../storage-system/_index.md" >}}) | | 9220-9224 | [search]({{< ref "../search/_index.md" >}}) | | 9225-9229 | [audit]({{< ref "../audit/_index.md" >}}) | @@ -61,8 +61,8 @@ We also suggest to use the last port in your extensions' range as a debug/metric | 9240-9244 | [app-registry]({{< ref "../app-registry/_index.md" >}}) | | 9245-9249 | FREE | | 9250-9254 | [ocis server (runtime)](https://github.com/owncloud/ocis/tree/master/ocis/pkg/runtime) | -| 9255-9259 | [postprocessing]({{ ref "../postprocessing/_index.md" >}}) | -| 9260-9264 | FREE | +| 9255-9259 | [postprocessing]({{< ref "../postprocessing/_index.md" >}}) | +| 9260-9264 | [clientlog]({{ ref "../clientlog/index.md" }}) | | 9265-9269 | FREE | | 9270-9274 | [eventhistory]({{< ref "../eventhistory/_index.md" >}}) | | 9275-9279 | FREE | diff --git a/services/graph/_index.md b/services/graph/_index.md index c7e9dcf3b48..a748d71a00e 100644 --- a/services/graph/_index.md +++ b/services/graph/_index.md @@ -1,6 +1,6 @@ --- title: Graph -date: 2023-09-07T11:00:17.965753372Z +date: 2023-09-07T13:26:46.799239019Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/graph diff --git a/services/idm/_index.md b/services/idm/_index.md index 06672b3967d..65c51f64a1e 100644 --- a/services/idm/_index.md +++ b/services/idm/_index.md @@ -1,6 +1,6 @@ --- title: IDM -date: 2023-09-07T11:00:17.965834386Z +date: 2023-09-07T13:26:46.799356088Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/idm diff --git a/services/idp/_index.md b/services/idp/_index.md index 1c6ee5d8168..2c8791d2ed4 100644 --- a/services/idp/_index.md +++ b/services/idp/_index.md @@ -1,6 +1,6 @@ --- title: IDP -date: 2023-09-07T11:00:17.965896963Z +date: 2023-09-07T13:26:46.799429615Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/idp diff --git a/services/invitations/_index.md b/services/invitations/_index.md index 9ad61e32550..ed267063570 100644 --- a/services/invitations/_index.md +++ b/services/invitations/_index.md @@ -1,6 +1,6 @@ --- title: Invitations -date: 2023-09-07T11:00:17.965976662Z +date: 2023-09-07T13:26:46.799511738Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/invitations diff --git a/services/nats/_index.md b/services/nats/_index.md index db8d37bfef6..705f57c7c6f 100644 --- a/services/nats/_index.md +++ b/services/nats/_index.md @@ -1,6 +1,6 @@ --- title: Nats -date: 2023-09-07T11:00:17.966071531Z +date: 2023-09-07T13:26:46.799614099Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/nats diff --git a/services/notifications/_index.md b/services/notifications/_index.md index 4388ab78de0..b8e795cadf4 100644 --- a/services/notifications/_index.md +++ b/services/notifications/_index.md @@ -1,6 +1,6 @@ --- title: Notification -date: 2023-09-07T11:00:17.966154406Z +date: 2023-09-07T13:26:46.799715919Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/notifications diff --git a/services/ocdav/_index.md b/services/ocdav/_index.md index 4fe843f28bd..15e481642d6 100644 --- a/services/ocdav/_index.md +++ b/services/ocdav/_index.md @@ -1,6 +1,6 @@ --- title: ocDAV -date: 2023-09-07T11:00:17.966246559Z +date: 2023-09-07T13:26:46.799809353Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/ocdav diff --git a/services/ocs/_index.md b/services/ocs/_index.md index 6f99bc0b6b8..d3c28e0c800 100644 --- a/services/ocs/_index.md +++ b/services/ocs/_index.md @@ -1,6 +1,6 @@ --- title: OCS Service -date: 2023-09-07T11:00:17.966356155Z +date: 2023-09-07T13:26:46.799983348Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/ocs diff --git a/services/policies/_index.md b/services/policies/_index.md index 1074948df2b..fff6ee6ab9b 100644 --- a/services/policies/_index.md +++ b/services/policies/_index.md @@ -1,6 +1,6 @@ --- title: Policies -date: 2023-09-07T11:00:17.966469547Z +date: 2023-09-07T13:26:46.800195643Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/policies diff --git a/services/postprocessing/_index.md b/services/postprocessing/_index.md index aa12b96aeb5..157fcda783c 100644 --- a/services/postprocessing/_index.md +++ b/services/postprocessing/_index.md @@ -1,6 +1,6 @@ --- title: Postprocessing -date: 2023-09-07T11:00:17.966591988Z +date: 2023-09-07T13:26:46.800348509Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/postprocessing diff --git a/services/proxy/_index.md b/services/proxy/_index.md index 11a1e07ba39..a023a440cf1 100644 --- a/services/proxy/_index.md +++ b/services/proxy/_index.md @@ -1,6 +1,6 @@ --- title: Proxy -date: 2023-09-07T11:00:17.966728444Z +date: 2023-09-07T13:26:46.800505391Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/proxy diff --git a/services/search/_index.md b/services/search/_index.md index 72142091567..7625e51c802 100644 --- a/services/search/_index.md +++ b/services/search/_index.md @@ -1,6 +1,6 @@ --- title: Search -date: 2023-09-07T11:00:17.966885479Z +date: 2023-09-07T13:26:46.800726243Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/search diff --git a/services/settings/_index.md b/services/settings/_index.md index a754a11a2cd..5f24357e4c0 100644 --- a/services/settings/_index.md +++ b/services/settings/_index.md @@ -1,6 +1,6 @@ --- title: Settings -date: 2023-09-07T11:00:17.967029388Z +date: 2023-09-07T13:26:46.801160402Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/settings diff --git a/services/sse/_index.md b/services/sse/_index.md index 6448cf1530b..c3115757619 100644 --- a/services/sse/_index.md +++ b/services/sse/_index.md @@ -1,6 +1,6 @@ --- title: SSE -date: 2023-09-07T11:00:17.967150015Z +date: 2023-09-07T13:26:46.801293972Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/sse @@ -18,9 +18,17 @@ The `sse` service is responsible for sending sse (Server-Sent Events) to a user. ## Table of Contents +* [The Log Service Ecosystem](#the-log-service-ecosystem) * [Subscribing](#subscribing) * [Example Yaml Config](#example-yaml-config) +## The Log Service Ecosystem + +Log services like the `userlog`, `clientlog` and `sse` are responsible for composing notifications for a certain audience. + - The `userlog` service translates and adjusts messages to be human readable. + - The `clientlog` service composes machine readable messages, so clients can act without the need to query the server. + - The `sse` service is only responsible for sending these messages. It does not care about their form or language. + ## Subscribing Clients can subscribe to the `/sse` endpoint to be informed by the server when an event happens. The `sse` endpoint will respect language changes of the user without needing to reconnect. Note that SSE has a limitation of six open connections per browser which can be reached if one has opened various tabs of the Web UI pointing to the same Infinite Scale instance. diff --git a/services/storage-system/_index.md b/services/storage-system/_index.md index 8b6435c7db9..87b704b3d43 100644 --- a/services/storage-system/_index.md +++ b/services/storage-system/_index.md @@ -1,6 +1,6 @@ --- title: Storage-System -date: 2023-09-07T11:00:17.967291862Z +date: 2023-09-07T13:26:46.801442158Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/storage-system diff --git a/services/storage-users/_index.md b/services/storage-users/_index.md index 57dfca18fac..36cb0ffb8eb 100644 --- a/services/storage-users/_index.md +++ b/services/storage-users/_index.md @@ -1,6 +1,6 @@ --- title: Storage-Users -date: 2023-09-07T11:00:17.967420363Z +date: 2023-09-07T13:26:46.801616053Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/storage-users diff --git a/services/thumbnails/_index.md b/services/thumbnails/_index.md index 2416533f757..2b790e91adb 100644 --- a/services/thumbnails/_index.md +++ b/services/thumbnails/_index.md @@ -1,6 +1,6 @@ --- title: Thumbnails -date: 2023-09-07T11:00:17.967537403Z +date: 2023-09-07T13:26:46.801776893Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/thumbnails diff --git a/services/userlog/_index.md b/services/userlog/_index.md index b41a9348b9d..b95a2a4a6dd 100644 --- a/services/userlog/_index.md +++ b/services/userlog/_index.md @@ -1,6 +1,6 @@ --- title: Userlog -date: 2023-09-07T11:00:17.96763729Z +date: 2023-09-07T13:26:46.801960064Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/userlog @@ -18,6 +18,7 @@ The `userlog` service is a mediator between the `eventhistory` service and clien ## Table of Contents +* [The Log Service Ecosystem](#the-log-service-ecosystem) * [Prerequisites](#prerequisites) * [Storing](#storing) * [Configuring](#configuring) @@ -30,6 +31,13 @@ The `userlog` service is a mediator between the `eventhistory` service and clien * [Translation Rules](#translation-rules) * [Example Yaml Config](#example-yaml-config) +## The Log Service Ecosystem + +Log services like the `userlog`, `clientlog` and `sse` are responsible for composing notifications for a certain audience. + - The `userlog` service translates and adjusts messages to be human readable. + - The `clientlog` service composes machine readable messages, so clients can act without the need to query the server. + - The `sse` service is only responsible for sending these messages. It does not care about their form or language. + ## Prerequisites Running the `userlog` service without running the `eventhistory` service is not possible. diff --git a/services/web/_index.md b/services/web/_index.md index 635166d6976..311213b5ce8 100644 --- a/services/web/_index.md +++ b/services/web/_index.md @@ -1,6 +1,6 @@ --- title: Web -date: 2023-09-07T11:00:17.967739712Z +date: 2023-09-07T13:26:46.80205959Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/web diff --git a/services/webdav/_index.md b/services/webdav/_index.md index 07aaa290654..52ced61d3f7 100644 --- a/services/webdav/_index.md +++ b/services/webdav/_index.md @@ -1,6 +1,6 @@ --- title: Webdav -date: 2023-09-07T11:00:17.967827938Z +date: 2023-09-07T13:26:46.802167801Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/webdav diff --git a/services/webfinger/_index.md b/services/webfinger/_index.md index bee04c626e9..ca6a64f43b8 100644 --- a/services/webfinger/_index.md +++ b/services/webfinger/_index.md @@ -1,6 +1,6 @@ --- title: Webfinger -date: 2023-09-07T11:00:17.967912796Z +date: 2023-09-07T13:26:46.802253231Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/services/webfinger