mirror of
https://github.com/opencloud-eu/opencloud.git
synced 2026-03-12 00:41:52 -05:00
[docs-only] Replace the legacy Extensions with Services (#5518)
* Replace the legacy Extensions with Services * Update docs/ocis/_index.md Co-authored-by: Michael Barz <mbarz@owncloud.com> --------- Co-authored-by: Michael Barz <mbarz@owncloud.com>
This commit is contained in:
@@ -8,7 +8,7 @@ geekdocFilePath: port-ranges.go
|
||||
geekdocCollapseSection: true
|
||||
---
|
||||
|
||||
oCIS extensions often need a port to expose their services to other services or the outside world.
|
||||
oCIS services often need a port to expose their services to other services or the outside world.
|
||||
As users may have many different extensions running on the same machine, we should track port usage in the oCIS ecosystem. In the best case we ensure that each extension uses a non colliding port range, to make life of users easier.
|
||||
|
||||
This page tracks the knowingly used port ranges.
|
||||
|
||||
@@ -21,13 +21,13 @@ graph TD
|
||||
sdk --- sdks{ocis-settings<br>available?}
|
||||
sdks ---|"yes"| os
|
||||
sdks ---|"no"| defaults[Use set of<br>default values]
|
||||
oa[oCIS extensions<br>e.g. ocis-accounts] ---|"saveSettingsBundle(bundle)"| os
|
||||
oa[oCIS services<br>e.g. ocis-accounts] ---|"saveSettingsBundle(bundle)"| os
|
||||
{{< /mermaid >}}
|
||||
|
||||
The diagram shows how the settings service integrates into oCIS:
|
||||
|
||||
**Settings management:**
|
||||
- oCIS extensions can register *settings bundles* with the ocis-settings service.
|
||||
- oCIS services can register *settings bundles* with the ocis-settings service.
|
||||
|
||||
**Settings usage:**
|
||||
- Extensions can query ocis-settings for *settings values* of a user.
|
||||
|
||||
@@ -9,7 +9,7 @@ geekdocFilePath: bundles.md
|
||||
|
||||
A **Settings Bundle** is a collection of settings, uniquely identified by the key of the
|
||||
extension registering the bundle and the key of the bundle itself. Its purpose is to let
|
||||
oCIS extensions define settings and make them available to users. They are dynamically
|
||||
oCIS services define settings and make them available to users. They are dynamically
|
||||
rendered into forms, available in the frontend.
|
||||
|
||||
As of now we support five different types of settings:
|
||||
|
||||
@@ -37,4 +37,4 @@ In the context of this extension and oCIS in general, we are using the following
|
||||
|
||||
- Manifestation of a setting for a specific user
|
||||
- E.g. used for customization (at runtime) in `ocis-web`
|
||||
- Can be queried and modified by other oCIS extensions
|
||||
- Can be queried and modified by other oCIS services
|
||||
|
||||
Reference in New Issue
Block a user