diff --git a/services/antivirus/README.md b/services/antivirus/README.md index 2ed95fc63..875eee148 100644 --- a/services/antivirus/README.md +++ b/services/antivirus/README.md @@ -1,4 +1,4 @@ -# Antivirus Service +# Antivirus The `antivirus` service is responsible for scanning files for viruses. diff --git a/services/audit/README.md b/services/audit/README.md index 31239cb2c..744f51197 100644 --- a/services/audit/README.md +++ b/services/audit/README.md @@ -1,4 +1,4 @@ -# Audit service +# Audit The audit service logs all events of the system as an audit log. Per default, it will be logged to standard out, but can also be configured to a file output. Supported log formats are json or a minimal human-readable format. diff --git a/services/auth-basic/README.md b/services/auth-basic/README.md index 82db24a70..c1b1db30b 100644 --- a/services/auth-basic/README.md +++ b/services/auth-basic/README.md @@ -1,4 +1,4 @@ -# Auth-Basic Service +# Auth-Basic The oCIS Auth Basic service provides basic authentication for those clients who cannot handle OpenID Connect. This should only be enabled for tests and development. diff --git a/services/auth-bearer/README.md b/services/auth-bearer/README.md index a8ece5de9..6ada9310e 100644 --- a/services/auth-bearer/README.md +++ b/services/auth-bearer/README.md @@ -1,4 +1,4 @@ -# Auth-Bearer Service +# Auth-Bearer The oCIS Auth Bearer service communicates with the configured OpenID Connect identity provider to authenticate requests. OpenID Connect is the default authentication mechanism for all clients: web, desktop and mobile. Basic auth is only used for testing and has to be explicity enabled. diff --git a/services/eventhistory/README.md b/services/eventhistory/README.md index ff3ab0997..66b7b1359 100644 --- a/services/eventhistory/README.md +++ b/services/eventhistory/README.md @@ -1,4 +1,4 @@ -# Eventhistory Service +# Eventhistory The `eventhistory` consumes all events from the configured event system like NATS, stores them and allows other services to retrieve them via an eventid. diff --git a/services/frontend/README.md b/services/frontend/README.md index 8065bad7c..d8597106e 100644 --- a/services/frontend/README.md +++ b/services/frontend/README.md @@ -1,4 +1,4 @@ -# Frontend Service +# Frontend The frontend service translates various owncloud related HTTP APIs to CS3 requests. diff --git a/services/gateway/README.md b/services/gateway/README.md index fb267ad16..bd16605b5 100644 --- a/services/gateway/README.md +++ b/services/gateway/README.md @@ -1,4 +1,4 @@ -# Gateway Service +# Gateway The gateway service is an ... diff --git a/services/graph/README.md b/services/graph/README.md index 8908121d3..0bcc40a4d 100644 --- a/services/graph/README.md +++ b/services/graph/README.md @@ -1,4 +1,4 @@ -# Graph service +# Graph The graph service provides the Graph API which is a RESTful web API used to access Infinite Scale resources. It is inspired by the [Microsoft Graph API](https://learn.microsoft.com/en-us/graph/use-the-api) and can be used by clients or other services or extensions. diff --git a/services/idm/README.md b/services/idm/README.md index 74a43ad28..fe168f5ad 100644 --- a/services/idm/README.md +++ b/services/idm/README.md @@ -1,4 +1,4 @@ -# Idm +# IDM The IDM service provides a minimal LDAP Service, based on [Libregraph idm](https://github.com/libregraph/idm), for oCIS. It is started as part of the default configuration and serves as a central place for storing user and group information. diff --git a/services/idp/README.md b/services/idp/README.md index 4afef73e2..01aefeb0c 100644 --- a/services/idp/README.md +++ b/services/idp/README.md @@ -1,4 +1,4 @@ -# IDP Service +# IDP This service provides a builtin minimal OpenID Connect provider based on [LibreGraph Connect (lico)](https://github.com/libregraph/lico) for oCIS. diff --git a/services/invitations/README.md b/services/invitations/README.md index f64fd8db4..ae8bd1fdc 100644 --- a/services/invitations/README.md +++ b/services/invitations/README.md @@ -1,4 +1,4 @@ -# Invitations Service +# Invitations The invitations service provides an [Invitation Manager](https://learn.microsoft.com/en-us/graph/api/invitation-post?view=graph-rest-1.0&tabs=http) that can be used to invite external users, aka guests, to an organization. diff --git a/services/nats/README.md b/services/nats/README.md index 823953be1..c72f1e599 100644 --- a/services/nats/README.md +++ b/services/nats/README.md @@ -1,4 +1,4 @@ -# Nats Service +# Nats The nats service is the event broker of the system. It distributes events among all other services and enables other services to communicate asynchronous. diff --git a/services/notifications/README.md b/services/notifications/README.md index 507d7afab..51d58bc9b 100644 --- a/services/notifications/README.md +++ b/services/notifications/README.md @@ -1,4 +1,4 @@ -# Notification service +# Notification The notification service is responsible for sending emails to users informing them about events that happened. To do this it hooks into the event system and listens for certain events that the users need to be informed about. diff --git a/services/ocs/README.md b/services/ocs/README.md index 81db9da61..12e8ff629 100644 --- a/services/ocs/README.md +++ b/services/ocs/README.md @@ -1,4 +1,4 @@ -# OCS Service +# OCS The ocs service is an ... diff --git a/services/policies/README.md b/services/policies/README.md index dd93f6e5d..b0911a28e 100644 --- a/services/policies/README.md +++ b/services/policies/README.md @@ -1,4 +1,4 @@ -# Policies Service +# Policies The policies service provides a new gRPC API which can be used to check whether a requested operation is allowed or not. To do so, Open Policy Agent (OPA) is used to define the set of rules of what is permitted and what is not. diff --git a/services/postprocessing/README.md b/services/postprocessing/README.md index d5717b343..50f35ee29 100644 --- a/services/postprocessing/README.md +++ b/services/postprocessing/README.md @@ -1,4 +1,4 @@ -# Postprocessing Service +# Postprocessing The `postprocessing` service handles the coordination of asynchronous postprocessing steps. diff --git a/services/proxy/README.md b/services/proxy/README.md index 73db853a1..eae7359dd 100644 --- a/services/proxy/README.md +++ b/services/proxy/README.md @@ -1,4 +1,4 @@ -# Proxy Service +# Proxy The proxy service is an API-Gateway for the ownCloud Infinite Scale microservices. Every HTTP request goes through this service. Authentication, logging and other preprocessing of requests also happens here. Mechanisms like request rate limitting or intrusion prevention are **not** included in the proxy service and must be setup in front like with an external reverse proxy. diff --git a/services/search/README.md b/services/search/README.md index fc93daf3c..fa36b3b80 100644 --- a/services/search/README.md +++ b/services/search/README.md @@ -1,4 +1,4 @@ -# Search Service +# Search The search service is responsible for metadata and content extraction, stores that data as index and makes it searchable. The following clarifies the extraction terms _metadata_ and _content_: diff --git a/services/storage-system/README.md b/services/storage-system/README.md index 5cdb8cb44..005713cfc 100644 --- a/services/storage-system/README.md +++ b/services/storage-system/README.md @@ -1,4 +1,4 @@ -# Storage-System Service +# Storage-System Purpose and description to be added @@ -15,4 +15,4 @@ The `storage-system` service caches file metadata via the configured store in `S 1. Note that in-memory stores are by nature not reboot persistent. 2. Though usually not necessary, a database name can be configured for event stores if the event store supports this. Generally not applicapable for stores of type `in-memory`, `redis` and `redis-sentinel`. These settings are blank by default which means that the standard settings of the configured store applies. 3. The `storage-system` service can be scaled if not using `in-memory` stores and the stores are configured identically over all instances. -4. When using `redis-sentinel`, the Redis master to use is configured via `STORAGE_SYSTEM_CACHE_NODES` in the form of `:/` like `10.10.0.200:26379/mymaster`. \ No newline at end of file +4. When using `redis-sentinel`, the Redis master to use is configured via `STORAGE_SYSTEM_CACHE_NODES` in the form of `:/` like `10.10.0.200:26379/mymaster`. diff --git a/services/storage-users/README.md b/services/storage-users/README.md index 5e36463e8..c9e1702c2 100644 --- a/services/storage-users/README.md +++ b/services/storage-users/README.md @@ -1,4 +1,4 @@ -# Storage-Users Service +# Storage-Users Purpose and description to be added @@ -94,4 +94,4 @@ The `storage-users` service caches file metadata via the configured store in `ST 1. Note that in-memory stores are by nature not reboot persistent. 2. Though usually not necessary, a database name can be configured for event stores if the event store supports this. Generally not applicapable for stores of type `in-memory`, `redis` and `redis-sentinel`. These settings are blank by default which means that the standard settings of the configured store applies. 3. The `storage-users` service can be scaled if not using `in-memory` stores and the stores are configured identically over all instances. -4. When using `redis-sentinel`, the Redis master to use is configured via `STORAGE_SYSTEM_CACHE_NODES` in the form of `:/` like `10.10.0.200:26379/mymaster`. \ No newline at end of file +4. When using `redis-sentinel`, the Redis master to use is configured via `STORAGE_SYSTEM_CACHE_NODES` in the form of `:/` like `10.10.0.200:26379/mymaster`. diff --git a/services/thumbnails/README.md b/services/thumbnails/README.md index 5592a601f..43dbc463d 100644 --- a/services/thumbnails/README.md +++ b/services/thumbnails/README.md @@ -1,4 +1,4 @@ -# Thumbnails Service +# Thumbnails The thumbnails service provides methods to generate thumbnails for various files and resolutions based on requests. It retrieves the sources at the location where the user files are stored and saves the thumbnails where system files are stored. Those locations have defaults but can be manually defined via environment variables. diff --git a/services/userlog/README.md b/services/userlog/README.md index d91154e0d..f8cc6fed9 100644 --- a/services/userlog/README.md +++ b/services/userlog/README.md @@ -1,4 +1,4 @@ -# Userlog Service +# Userlog The `userlog` service is a mediator between the `eventhistory` service and clients who want to be informed about user related events. It provides an API to retrieve those. diff --git a/services/web/README.md b/services/web/README.md index 9e2cbeadc..cb988fec1 100644 --- a/services/web/README.md +++ b/services/web/README.md @@ -1,4 +1,4 @@ -# Web Service +# Web The web service embeds and serves the static files for the [Infinite Scale Web Client](https://github.com/owncloud/web). Note that clients will respond with a connection error if the web service is not available. diff --git a/services/webdav/README.md b/services/webdav/README.md index 72c773123..d13656c4d 100644 --- a/services/webdav/README.md +++ b/services/webdav/README.md @@ -1,4 +1,4 @@ -# Webdav Service +# Webdav The webdav service, like the [ocdav](https://github.com/owncloud/ocis/tree/master/services/ocdav) service, provides a HTTP API following the webdav protocol. It receives HTTP calls from requestors like clients and issues gRPC calls to other services executing these requests. After the called service has finished the request, the webdav service will render their responses in `xml` and sends them back to the requestor. diff --git a/services/webfinger/README.md b/services/webfinger/README.md index f306e97d9..9409d21e6 100644 --- a/services/webfinger/README.md +++ b/services/webfinger/README.md @@ -1,4 +1,4 @@ -# Webfinger Service +# Webfinger The webfinger service provides an RFC7033 WebFinger lookup of ownCloud instances relevant for a given user account via endpoints a the /.well-known/webfinger implementation.