Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ to work with OpenCloud:

The following environment variables are relevant when connecting OpenCloud to
an external IDP. An example configuration for Keycloak is provided the
[Keycloak integration](keycloak.md) documentation.
[Keycloak integration](./keycloak.md) documentation.

- `OC_OIDC_ISSUER`: Set this to the issuer URL of the external Identity Provider
- `OC_EXCLUDE_RUN_SERVICES`: When using and external IDP the built-in Identity Provider
Expand Down
8 changes: 4 additions & 4 deletions docs/user/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,18 +30,18 @@ Through intelligent file management and a strong open source community, files be

OpenCloud can be accessed in different ways, depending on the device and use case:

- The ["Web Client"](./general/) provides full access to all OpenCloud features directly in the browser. It allows file management, user and space administration, and online collaboration via Collabora.
- The ["Web Client"](./general) provides full access to all OpenCloud features directly in the browser. It allows file management, user and space administration, and online collaboration via Collabora.

- The ["Desktop Client"](./desktop-client/) synchronizes files between the OpenCloud and a local computer, enabling offline work and automatic updates.
- The ["Desktop Client"](./desktop-client) synchronizes files between the OpenCloud and a local computer, enabling offline work and automatic updates.

- The Mobile Apps for ["iOS"](./ios-app/) and ["Android"](./android-app/) allow quick access to files and basic management functions while on the go.
- The Mobile Apps for ["iOS"](./ios-app) and ["Android"](./android-app) allow quick access to files and basic management functions while on the go.

Each client is designed for a specific workflow:
the Web Client for full-featured online use, the Desktop Client for local synchronization, and the Mobile Apps for mobile productivity.

## How can I use OpenCloud?

Instructions on how to install and set up your own OpenCloud can be found in the ["Admin" Documentation](../admin/) under ["Getting-Started"](../admin/getting-started/)
Instructions on how to install and set up your own OpenCloud can be found in the ["Admin" Documentation](../admin) under ["Getting-Started"](../admin/getting-started)

## Documentation Versions

Expand Down
10 changes: 5 additions & 5 deletions i18n/de/docusaurus-plugin-content-docs/current/user/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,16 @@ Durch intelligentes Dateimanagement und eine starke Open-Source-Community werden

Der Zugriff auf OpenCloud ist auf verschiedene Arten möglich – je nach Gerät und Anwendungsfall:

- Der [Web Client](./general/) bietet den vollständigen Zugriff auf alle Funktionen der OpenCloud direkt im Browser. Er ermöglicht Dateimanagement, Benutzer- und Space-Verwaltung sowie die Online-Zusammenarbeit über Collabora.
- Der [Desktop Client](./desktop-client/) synchronisiert Dateien zwischen der OpenCloud und einem lokalen Computer und ermöglicht so die Offline-Arbeit sowie automatische Aktualisierungen.
- Die mobilen Apps für [iOS](./ios-app/) und [Android](./android-app/) bieten schnellen Zugriff auf Dateien und grundlegende Verwaltungsfunktionen – auch unterwegs.
- Der [Web Client](./general) bietet den vollständigen Zugriff auf alle Funktionen der OpenCloud direkt im Browser. Er ermöglicht Dateimanagement, Benutzer- und Space-Verwaltung sowie die Online-Zusammenarbeit über Collabora.
- Der [Desktop Client](./desktop-client) synchronisiert Dateien zwischen der OpenCloud und einem lokalen Computer und ermöglicht so die Offline-Arbeit sowie automatische Aktualisierungen.
- Die mobilen Apps für [iOS](./ios-app) und [Android](./android-app) bieten schnellen Zugriff auf Dateien und grundlegende Verwaltungsfunktionen – auch unterwegs.

Jeder Client ist für einen bestimmten Anwendungsfall konzipiert:
der Web Client für die umfassende Online-Nutzung, der Desktop Client für die lokale Synchronisierung und die mobilen Apps für produktives Arbeiten von unterwegs.

## Wie kann ich OpenCloud nutzen?

Anweisungen zur Installation und Einrichtung Ihrer eigenen OpenCloud finden Sie nur in Englisch in der [„Admin“-Dokumentation](/docs/admin/index.md) unter [Erste Schritte](/docs/admin/getting-started/).
Anweisungen zur Installation und Einrichtung Ihrer eigenen OpenCloud finden Sie nur in Englisch in der [„Admin“-Dokumentation](../admin) unter [Erste Schritte](../admin/getting-started).

## Dokumentations-Versionen

Expand Down Expand Up @@ -71,7 +71,7 @@ Hier finden Sie Informationen zur Arbeit mit Spaces.

Hier finden Sie Anleitungen zur Installation und Einrichtung des Desktop-Clients.

### [OpenCloud iOS App](./ios-app/)
### [OpenCloud iOS App](./ios-app)

Hier erhalten Sie Informationen zur Nutzung der OpenCloud iOS App.

Expand Down
10 changes: 5 additions & 5 deletions i18n/de/docusaurus-plugin-content-docs/version-4.0/user/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,16 @@ Durch intelligentes Dateimanagement und eine starke Open-Source-Community werden

Der Zugriff auf OpenCloud ist auf verschiedene Arten möglich – je nach Gerät und Anwendungsfall:

- Der [Web Client](./general/) bietet den vollständigen Zugriff auf alle Funktionen der OpenCloud direkt im Browser. Er ermöglicht Dateimanagement, Benutzer- und Space-Verwaltung sowie die Online-Zusammenarbeit über Collabora.
- Der [Desktop Client](./desktop-client/) synchronisiert Dateien zwischen der OpenCloud und einem lokalen Computer und ermöglicht so die Offline-Arbeit sowie automatische Aktualisierungen.
- Die mobilen Apps für [iOS](./ios-app/) und [Android](./android-app/) bieten schnellen Zugriff auf Dateien und grundlegende Verwaltungsfunktionen – auch unterwegs.
- Der [Web Client](./general) bietet den vollständigen Zugriff auf alle Funktionen der OpenCloud direkt im Browser. Er ermöglicht Dateimanagement, Benutzer- und Space-Verwaltung sowie die Online-Zusammenarbeit über Collabora.
- Der [Desktop Client](./desktop-client) synchronisiert Dateien zwischen der OpenCloud und einem lokalen Computer und ermöglicht so die Offline-Arbeit sowie automatische Aktualisierungen.
- Die mobilen Apps für [iOS](./ios-app) und [Android](./android-app) bieten schnellen Zugriff auf Dateien und grundlegende Verwaltungsfunktionen – auch unterwegs.

Jeder Client ist für einen bestimmten Anwendungsfall konzipiert:
der Web Client für die umfassende Online-Nutzung, der Desktop Client für die lokale Synchronisierung und die mobilen Apps für produktives Arbeiten von unterwegs.

## Wie kann ich OpenCloud nutzen?

Anweisungen zur Installation und Einrichtung Ihrer eigenen OpenCloud finden Sie nur in Englisch in der [„Admin“-Dokumentation](/docs/admin/index.md) unter [Erste Schritte](/docs/admin/getting-started/).
Anweisungen zur Installation und Einrichtung Ihrer eigenen OpenCloud finden Sie nur in Englisch in der [„Admin“-Dokumentation](../admin) unter [Erste Schritte](../admin/getting-started).

## Dokumentations-Versionen

Expand Down Expand Up @@ -71,7 +71,7 @@ Hier finden Sie Informationen zur Arbeit mit Spaces.

Hier finden Sie Anleitungen zur Installation und Einrichtung des Desktop-Clients.

### [OpenCloud iOS App](./ios-app/)
### [OpenCloud iOS App](./ios-app)

Hier erhalten Sie Informationen zur Nutzung der OpenCloud iOS App.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ to work with OpenCloud:

The following environment variables are relevant when connecting OpenCloud to
an external IDP. An example configuration for Keycloak is provided the
Copy link

Copilot AI Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Corrected spelling of 'relativ' to 'relative' in the PR title.

Suggested change
an external IDP. An example configuration for Keycloak is provided the
an external IDP. An example configuration for Keycloak is provided in the

Copilot uses AI. Check for mistakes.
[Keycloak integration](keycloak.md) documentation.
[Keycloak integration](./keycloak.md) documentation.

- `OC_OIDC_ISSUER`: Set this to the issuer URL of the external Identity Provider
- `OC_EXCLUDE_RUN_SERVICES`: When using and external IDP the built-in Identity Provider
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,12 @@ OpenCloud now supports two authentication modes when using Keycloak with LDAP:
In this mode, LDAP serves as a central user directory for both Keycloak and OpenCloud.
This setup is suitable for scenarios where the LDAP server is not under the control of the OpenCloud admin and can be connected to KeyCloak and OpenCloud using standard attributes and a read-only bind user.

For detailed configuration and setup instructions, see the [Keycloak Shared User Directory](/docs/admin/configuration/authentication-and-user-management/keycloak#shared-user-directory-mode) guide.
For detailed configuration and setup instructions, see the [Keycloak Shared User Directory](./keycloak#shared-user-directory-mode) guide.

### Autoprovisioning Mode

In this mode, Keycloak is holding all users and OpenCloud autoprovisions new users during first login.
This mode is suitable in scenarios where the OpenIDConnect provider is external and not under control of the OpenCloud admin. To mitigate that lack of control, OpenCloud will use an LDAP server which is fully under the control of the OpenCloud admin to store the users and groups and additional attributes.
OpenCloud can disable users for login to actively prevent unwanted access to the system when the workflow with the external Identity Provider is slow or indirect. In this case, the LDAP server needs an OpenCloud Schema and write access for the LDAP bind user.

For detailed configuration and setup instructions, see the [Keycloak with Autoprovisioning](/docs/admin/configuration/authentication-and-user-management/keycloak#autoprovisioning-mode) guide.
For detailed configuration and setup instructions, see the [Keycloak with Autoprovisioning](./keycloak#autoprovisioning-mode) guide.
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@ GRAPH_USERNAME_MATCH=none
OC_EXCLUDE_RUN_SERVICES=idp,idm # it is not supported to run keycloak with the built-in idm
```

Look [OpenCloud external IDP configuration](/docs/admin/configuration/authentication-and-user-management/external-idp#opencloud-configuration) for some more details about these settings.
Look [OpenCloud external IDP configuration](./external-idp#opencloud-configuration) for some more details about these settings.

### Client Configuration

The [OIDC clients](/docs/admin/configuration/authentication-and-user-management/external-idp#client-configuration) required by OpenCloud are pre-configured in the Docker Compose setup and match the clients used by the built-in IdP.
The [OIDC clients](./external-idp#client-configuration) required by OpenCloud are pre-configured in the Docker Compose setup and match the clients used by the built-in IdP.

### Manual Client Configuration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,4 @@ After logging in, you should see the OpenCloud interface:

If you run into any issues or errors, check the following resource:

- [Common Issues & Help](/docs/admin/resources/common-issues)
- [Common Issues & Help](../../resources/common-issues)
Original file line number Diff line number Diff line change
Expand Up @@ -271,4 +271,4 @@ Password: (your password)

## Troubleshooting

If you encounter any issues, check the [Common Issues & Help](/docs/admin/resources/common-issues)
If you encounter any issues, check the [Common Issues & Help](../../../resources/common-issues)
Original file line number Diff line number Diff line change
Expand Up @@ -76,4 +76,4 @@ Your OpenCloud server is now running and ready to use 🚀

If you encounter any issues or errors, try finding a solution here:

- [Common Issues & Help](/docs/admin/resources/common-issues)
- [Common Issues & Help](../../resources/common-issues)
Original file line number Diff line number Diff line change
Expand Up @@ -128,4 +128,4 @@ Your OpenCloud server is now running and ready to use 🚀

If you encounter any issues or errors, try finding a solution here

- [Common Issues & Help](/docs/admin/resources/common-issues)
- [Common Issues & Help](../../resources/common-issues)
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Following this guide, you can safely migrate to the stable v4.0.0 release of Ope

:::important
Important: Always create a backup before upgrading to prevent data loss.
We strongly recommend following the [backup documentation](/docs/admin/maintenance/backup) and creating copies of your configuration and data directories.
We strongly recommend following the [backup documentation](../backup) and creating copies of your configuration and data directories.
:::

<Tabs> <TabItem value="bind-mounts" label="Using Bind Mounts">
Expand Down Expand Up @@ -112,7 +112,7 @@ cd opencloud-compose

### Migrate Environment Variables

Transfer your existing environment variables to the new opencloud-compose structure. Refer to the [Docker Compose configuration documentation](/docs/admin/getting-started/container/docker-compose/docker-compose-base.md) for detailed instructions.
Transfer your existing environment variables to the new opencloud-compose structure. Refer to the [Docker Compose configuration documentation](../../getting-started/container/docker-compose/docker-compose-base.md) for detailed instructions.

</TabItem>

Expand Down Expand Up @@ -236,6 +236,6 @@ Your OpenCloud instance should now be running on `v4.0.0`.
If you encounter issues during or after the upgrade:

1. Review the logs for error messages
2. Consult the [troubleshooting guide](/docs/admin/resources/common-issues)
2. Consult the [troubleshooting guide](../../resources/common-issues)
3. Restore from backup if necessary
4. Contact support or open an issue on [GitHub](https://github.com/opencloud-eu/opencloud/issues)
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Stop the currently running OpenCloud instance:

## Backup Config and Data

It is recommended to create a [backup](/docs/admin/maintenance/backup) before proceeding with the upgrade.
It is recommended to create a [backup](../backup) before proceeding with the upgrade.

## Pull the new Opencloud version

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ In its default configuration, OpenCloud supports three authentication methods as
2. Implicit Flow
3. Hybrid Flow

For detailed information on OpenCloud's support for OpenID Connect (OIDC), please consult the [Official Documentation](/docs/admin/configuration/authentication-and-user-management).
For detailed information on OpenCloud's support for OpenID Connect (OIDC), please consult the [Official Documentation](../../../../admin/configuration/authentication-and-user-management).

While selecting an OpenCloud client for authentication, take note of specific limitations such as the `Redirect URI`:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ For more information about OData query options please check the [API specificati

### Authorization

For development purposes the examples in the developer documentation use Basic Auth. It is disabled by default and should only be enabled by setting `PROXY_ENABLE_BASIC_AUTH` in [the proxy](/docs/dev/server/services/proxy/environment-variables) for development or test instances.
For development purposes the examples in the developer documentation use Basic Auth. It is disabled by default and should only be enabled by setting `PROXY_ENABLE_BASIC_AUTH` in [the proxy](../../../services/proxy/environment-variables) for development or test instances.

To authenticate with a Bearer token or OpenID Connect access token replace the `-u user:password` Basic Auth option of curl with a `-H 'Authorization: Bearer <token>'` header. A `<token>` can be obtained by copying it from a request in the browser, although it will time out within minutes. To automatically refresh the OpenID Connect access token an ssh-agent like solution like [oidc-agent](https://github.com/indigo-dc/oidc-agent) should be used. The graph endpoints that support a preconfigured token can be found in the [API specification](https://github.com/opencloud-eu/libre-graph-api)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ The WebDAV protocol was created before the REST paradigm has become the de-facto

### Authentication

For development purposes the examples in the developer documentation use Basic Auth. It is disabled by default and should only be enabled by setting `PROXY_ENABLE_BASIC_AUTH` in [the proxy](/docs/dev/server/services/proxy/environment-variables) for development or test instances.
For development purposes the examples in the developer documentation use Basic Auth. It is disabled by default and should only be enabled by setting `PROXY_ENABLE_BASIC_AUTH` in [the proxy](../../../services/proxy/environment-variables) for development or test instances.

To authenticate with a Bearer token or OpenID Connect access token replace the `-u user:password` Basic Auth option of curl with a `-H 'Authorization: Bearer <token>'` header. A `<token>` can be obtained by copying it from a request in the browser, although it will time out within minutes. To automatically refresh the OpenID Connect access token an ssh-agent like solution like [oidc-agent](https://github.com/indigo-dc/oidc-agent) should be used.

Expand Down
6 changes: 3 additions & 3 deletions versioned_docs/version-4.0/dev/server/apis/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 1

OpenCloud provides a large set of different **application programming interfaces (APIs)**. OpenCloud is built by microservices. That means many calls to "functions" in the code are remote calls.

Basically we have two different API "universes": [HTTP](/docs/dev/server/apis/http) and [gRPC](/docs/dev/server/apis/grpc_apis).
Basically we have two different API "universes": [HTTP](./http) and [gRPC](./grpc_apis).

| HTTP | gRPC |
| -------------------------------- | -------------------------------- |
Expand All @@ -15,7 +15,7 @@ For inter-service-communication we are using mostly gRPC calls because it has so

![OpenCloud APIs Architecture](/img/oc-apis.drawio.svg)

## [HTTP](/docs/dev/server/apis/http)
## [HTTP](./http)

HTTP APIs are mostly used for client < > server communication. Modern applications are embracing a [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) software architecture style. REST APIs are using the HTTP protocol to transfer data between clients and servers. All our clients talk to the Server using HTTP APIs. This has legacy reasons and is well-supported across many platforms and technologies. OpenCloud uses an HTTP API gateway (proxy service) to route client requests to the correct service.

Expand All @@ -27,7 +27,7 @@ It is best practise to define APIs and their behavior by a spec. We are using th

Some APIs have become a de facto standard and are additionally covered by an [RFC](https://en.wikipedia.org/wiki/Request_for_Comments).

## [gRPC](/docs/dev/server/apis/grpc_apis)
## [gRPC](./grpc_apis)

In gRPC, a client application can directly call methods on a server application on a different machine as if it was a local object. This makes it easier to create distributed applications based on microservices. In gRPC we can define a service and specify the methods that can be called remotely. A gRPC client has a stub that provides the same methods and types as the server.
OpenCloud uses a gRPC API Gateway (gateway service) to route the requests to the correct service.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,4 +128,4 @@ Environment variables take precedence over both `opencloud.yaml` and `<service-n
### More information

- [Global environment variable reference](./global-environment-variables)
- Individual service pages for service‑specific options and examples (e.g. [Activity Log](/docs/dev/server/services/activitylog), [Proxy](/docs/dev/server/services/proxy), [Frontend](/docs/dev/server/services/frontend)).
- Individual service pages for service‑specific options and examples (e.g. [Activity Log](../services/activitylog), [Proxy](../services/proxy), [Frontend](../services/frontend)).
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ for a suitable one and open a pull request!

To make sure your pull request can be efficiently reviewed and won't need a lot of changes down the road, please run all formal checks (linter, formatter, type checks and unit tests) via `pnpm check:all` locally. Our [CI](https://ci.opencloud.eu/repos/6) will run on
pull requests and report back any problems after that. For a further introduction on how we handle testing, please head to
the [testing docs](/docs/dev/web/testing/running-tests).
the [testing docs](../testing/running-tests).

## Code Conventions

Expand Down
Loading
Loading