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
2 changes: 1 addition & 1 deletion docs/dev/server/apis/http/authorization.md
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](../../../../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
6 changes: 3 additions & 3 deletions docs/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](./http) and [gRPC](./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](./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](./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
2 changes: 1 addition & 1 deletion docs/dev/server/configuration/config-system.md
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](../services/activitylog), [Proxy](../services/proxy), [Frontend](../services/frontend)).
- Individual service pages for service‑specific options and examples (e.g. [Activity Log](../services/activitylog/), [Proxy](../services/proxy/), [Frontend](../services/frontend)/).
2 changes: 1 addition & 1 deletion docs/dev/web/development/repo-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ within the `files` app. We currently bundle the following apps with the default
- `web-app-preview` a viewer for various media files (audio / video / image formats)
- `web-app-text-editor` a simple editor for `.txt`, `.md` and other plain text files

If you're interested in writing your own viewer or editor app for certain file types, please have a look at the [extension system docs](../extension-system).
If you're interested in writing your own viewer or editor app for certain file types, please have a look at the [extension system docs](../extension-system/).

### Testing

Expand Down
2 changes: 1 addition & 1 deletion docs/dev/web/extension-system/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ The user can then select one out of all the extensions which have been registere

#### Creating a new extension

Please check out the [web-app-skeleton repository](https://github.com/opencloud-eu/web-app-skeleton) for a boilerplate application that also includes an extension. In addition to that, the [extension types docs](./extension-types) provide instructions and examples on how to implement the different extension types.
Please check out the [web-app-skeleton repository](https://github.com/opencloud-eu/web-app-skeleton) for a boilerplate application that also includes an extension. In addition to that, the [extension types docs](./extension-types/) provide instructions and examples on how to implement the different extension types.

### Helpful packages

Expand Down
4 changes: 2 additions & 2 deletions docs/dev/web/extension-system/viewer-editor-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ An app is essentially a distinct package that must be specified as an external a

The structure of an app is quite simple and straightforward. Consider, for example, the [pdf-viewer app](https://github.com/opencloud-eu/web/tree/main/packages/web-app-pdf-viewer). It consists of a `package.json` file, a `src` directory containing all the source code, and a `l10n` directory for translations. Optionally, you may also include a `tests` directory if your application requires testing.

To learn more about apps in general, please refer to the [Web app docs](../extension-system).
To learn more about apps in general, please refer to the [Web app docs](../extension-system/).

### App setup

Inside the `src` folder you will need an `index.ts` file that sets up the app so it can be registered by the Web runtime. It follows the basic structure as described in [the apps section](../extension-system), so it may look like this:
Inside the `src` folder you will need an `index.ts` file that sets up the app so it can be registered by the Web runtime. It follows the basic structure as described in [the apps section](../extension-system/), so it may look like this:

```typescript
import { AppWrapperRoute, defineWebApplication, AppMenuItemExtension } from '@opencloud-eu/web-pkg';
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/web/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Additional CSS files to further customize the user experience and adapt it to yo
Additional JavaScript files to further customize the user experience and adapt it to your specific needs. Expects an array of objects that specify a `src` attribute, pointing to the path/URL of your script, and an optional `async` attribute (defaults to false), like `[{ "src": "js/custom.js", "async": true }]`.

:::note
Check out the [extension system docs](./extension-system) for a more convenient way to add functionality to the Web client.
Check out the [extension system docs](./extension-system/) for a more convenient way to add functionality to the Web client.
:::

### `sentry`
Expand Down
24 changes: 12 additions & 12 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 All @@ -55,35 +55,35 @@ Through intelligent file management and a strong open source community, files be

## Table of contents

### [User Interface and Navigation](./general)
### [User Interface and Navigation](./general/)

Here you will find general information about account settings, customizations and view modes.

### [Manage Files and Folders](./files-and-folders)
### [Manage Files and Folders](./files-and-folders/)

Here you will find information about the management of files and folders.

### [Share Files and Folders](./sharing)
### [Share Files and Folders](./sharing/)

Here you will find information on how to share files and folders.

### [Working in Teams with Spaces](./spaces)
### [Working in Teams with Spaces](./spaces/)

Here you will find information for dealing with Spaces.

### [OpenCloud Desktop](./desktop-client)
### [OpenCloud Desktop](./desktop-client/)

Here you will find information on how to install and set up the desktop client.

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

Here you will find information about the OpenCloud iOS App.

### [Roles](./roles)
### [Roles](./roles/)

Here you will find information about the different roles that can be assigned.

### [Administration of OpenCloud](./admin)
### [Administration of OpenCloud](./admin/)

Here you will find information on what options admins have and how you can use them.

Expand Down
24 changes: 12 additions & 12 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](../admin) unter [Erste Schritte](../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 All @@ -51,35 +51,35 @@ Unsere Dokumentation ist versioniert, damit Sie stets die passende Version zu Ih

## Inhaltsverzeichnis

### [Benutzeroberfläche und Navigation](./general)
### [Benutzeroberfläche und Navigation](./general/)

Hier finden Sie allgemeine Informationen zu Kontoeinstellungen, Anpassungsmöglichkeiten und Ansichtsmodi.

### [Verwalten von Dateien und Ordner](./files-and-folders)
### [Verwalten von Dateien und Ordner](./files-and-folders/)

Hier finden Sie Informationen zur Verwaltung von Dateien und Ordnern.

### [Teilen von Dateien und Ordner](./sharing)
### [Teilen von Dateien und Ordner](./sharing/)

Hier erfahren Sie, wie Sie Dateien und Ordner freigeben können.

### [Arbeiten im Team mit Spaces](./spaces)
### [Arbeiten im Team mit Spaces](./spaces/)

Hier finden Sie Informationen zur Arbeit mit Spaces.

### [OpenCloud Desktop](./desktop-client)
### [OpenCloud Desktop](./desktop-client/)

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.

### [Rollen](./roles)
### [Rollen](./roles/)

Hier erfahren Sie mehr über die verschiedenen zuweisbaren Rollen.

### [Administration von OpenCloud](./admin)
### [Administration von OpenCloud](./admin/)

Hier finden Sie Informationen über die Administrationsfunktionen und deren Nutzungsmöglichkeiten.

Expand Down
24 changes: 12 additions & 12 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](../admin) unter [Erste Schritte](../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 All @@ -51,35 +51,35 @@ Unsere Dokumentation ist versioniert, damit Sie stets die passende Version zu Ih

## Inhaltsverzeichnis

### [Benutzeroberfläche und Navigation](./general)
### [Benutzeroberfläche und Navigation](./general/)

Hier finden Sie allgemeine Informationen zu Kontoeinstellungen, Anpassungsmöglichkeiten und Ansichtsmodi.

### [Verwalten von Dateien und Ordner](./files-and-folders)
### [Verwalten von Dateien und Ordner](./files-and-folders/)

Hier finden Sie Informationen zur Verwaltung von Dateien und Ordnern.

### [Teilen von Dateien und Ordner](./sharing)
### [Teilen von Dateien und Ordner](./sharing/)

Hier erfahren Sie, wie Sie Dateien und Ordner freigeben können.

### [Arbeiten im Team mit Spaces](./spaces)
### [Arbeiten im Team mit Spaces](./spaces/)

Hier finden Sie Informationen zur Arbeit mit Spaces.

### [OpenCloud Desktop](./desktop-client)
### [OpenCloud Desktop](./desktop-client/)

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.

### [Rollen](./roles)
### [Rollen](./roles/)

Hier erfahren Sie mehr über die verschiedenen zuweisbaren Rollen.

### [Administration von OpenCloud](./admin)
### [Administration von OpenCloud](./admin/)

Hier finden Sie Informationen über die Administrationsfunktionen und deren Nutzungsmöglichkeiten.

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](../../../../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
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](./http) and [gRPC](./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](./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](./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](../services/activitylog), [Proxy](../services/proxy), [Frontend](../services/frontend)).
- Individual service pages for service‑specific options and examples (e.g. [Activity Log](../services/activitylog/), [Proxy](../services/proxy/), [Frontend](../services/frontend)/).
Loading
Loading