Skip to content
Open
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 @@ -62,3 +62,9 @@ This mode is suitable in scenarios where the OpenIDConnect provider is external
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](./keycloak#autoprovisioning-mode) guide.

## Guides

- [External OpenID Connect Identity Provider](./external-idp.md) - Requirements for integrating external OpenID Connect IDPs
- [Keycloak Integration](./keycloak.md) - Configure Keycloak in Shared User Directory or Autoprovisioning mode
- [Adding users with Keycloak](./keycloak-user.md) - Create new users in Keycloak, including users without a personal space
4 changes: 2 additions & 2 deletions docs/admin/configuration/collabora/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ It is meant as a quick entry point for administrators who want to improve docume

## Guides

- [Install additional fonts](./collabora-fonts)
- [Enable MS-Office formats](./collabora-ms-office-formats)
- [Install additional fonts](./collabora-fonts) - Add fonts so documents render reliably
- [Enable MS-Office formats](./collabora-ms-office-formats) - Create `.docx`, `.xlsx`, and `.pptx` files from the New menu
20 changes: 11 additions & 9 deletions docs/admin/configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,15 @@ Use these guides to tune OpenCloud behavior, integrations, and default settings.
- [Authentication and Identity Management](./authentication-and-user-management/) - Internal and external IDP setup
- [Storage](./storage/) - Storage drivers and backend setup
- [Collabora](./collabora/) - Collabora integration and document compatibility
- [Set Default Quota](./set-default-quota.md)
- [Frontend Update Check](./frontend-update-check.md)
- [Mail Notifications](./mail-notifications.md)
- [Radicale Integration](./radicale-integration.md)
- [Collaborative Editing](./collaborative-editing.md)
- [Web Applications](./web-applications.md)
- [Link Password Policy](./link-password-policy.md)
- [Default Language](./default-language.md)
- [Set Default Quota](./set-default-quota.md) - Define the default storage quota for users
- [Frontend Update Check](./frontend-update-check.md) - Disable the update check in the web frontend
- [Mail Notifications](./mail-notifications.md) - Send notifications to users by email
- [Radicale Integration](./radicale-integration.md) - Calendar and contacts with Radicale
- [Collaborative Editing](./collaborative-editing.md) - Real-time collaborative editing with the Yjs server
- [Web Applications](./web-applications.md) - Enable additional web apps
- [Link Password Policy](./link-password-policy.md) - Password enforcement and requirements for public links
- [Default Language](./default-language.md) - Set the default language
- [Euro Office](./euro-office.md) - Community supported Euro Office setup
- [Logging](./logging.md)
- [Logging](./logging.md) - Configure logging in OpenCloud
- [n8n](./n8n.md) - Automate OpenCloud workflows with n8n
- [Announcement Banner](./announcement-banner.md) - Notify all users with a global banner
4 changes: 2 additions & 2 deletions docs/admin/getting-started/container/docker-compose/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,5 +42,5 @@ Best for:
After choosing and completing your deployment:

- [Production Setup Considerations](./production-considerations.md) – Persistent storage, backups, image versions
- [Verify TLS Certificates](./docker-compose-base.md#verify-tls-certificates) – Validate your SSL setup
- [Configure Authentication](../../../configuration/authentication-and-user-management/) – Users, authentication, and optional Keycloak integration
- [Keycloak Integration](./keycloak-deployment.md) – Add Keycloak as identity provider to your Docker Compose deployment
- [Volume Permissions](./volume-permissions.md) – Set the filesystem permissions for bind-mounted volumes
1 change: 1 addition & 0 deletions docs/admin/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ curl -L https://opencloud.eu/install | /bin/bash
- Getting Started – Set up and deploy OpenCloud
- Configuration – Customize and integrate with existing systems and storage
- Maintenance – Learn how to update, backup and migrate
- Resources – Find troubleshooting help, FAQs, and release information

## Explore the Admin Docs

Expand Down
12 changes: 6 additions & 6 deletions docs/admin/maintenance/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ Use these guides to keep your OpenCloud installation updated, backed up, and man

## In this section

- [Upgrade](./upgrade/index.md)
- [Backup](./backup.md)
- [Migrate](./migrate.md)
- [Uninstall](./uninstall.md)
- [Data Export](./dataexport.md)
- [Maintenance Commands](./maintenance-commands.md)
- [Upgrade](./upgrade/index.md) - Upgrade guides and release notes
- [Backup](./backup.md) - Back up your OpenCloud data
- [Migrate](./migrate.md) - Migrate data using rclone
- [Uninstall](./uninstall.md) - Remove OpenCloud from your system
- [Data Export](./dataexport.md) - Export user data
- [Maintenance Commands](./maintenance-commands.md) - Common commands for administrators
10 changes: 5 additions & 5 deletions docs/admin/maintenance/upgrade/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ This section collects the guides you need when upgrading OpenCloud.

## Guides

- [Standard Upgrade Guide](./upgrade.md)
- [Upgrade 8.x.x](./upgrade-8.x.x.md)
- [Upgrade 7.x.x](./upgrade-7.x.x.md)
- [Upgrade 4.0.x](./upgrade-4.0.0.md)
- [Release notes](./release-notes.md)
- [Standard Upgrade Guide](./upgrade.md) - Standard steps to upgrade Docker and Docker Compose setups
- [Upgrade 8.x.x](./upgrade-8.x.x.md) - Version-specific upgrade steps for OpenCloud 8.x.x (Rolling)
- [Upgrade 7.x.x](./upgrade-7.x.x.md) - Version-specific upgrade steps for OpenCloud 7.x.x
- [Upgrade 4.0.x](./upgrade-4.0.0.md) - Version-specific upgrade steps for OpenCloud 4.0.x
- [Release notes](./release-notes.md) - Migration notes for breaking changes
10 changes: 5 additions & 5 deletions docs/admin/resources/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ Use this section for troubleshooting, lifecycle information, and general admin h

## In this section

- [FAQ](./faq.md)
- [What's New](./whats-new.md)
- [Release Lifecycle](./lifecycle.md)
- [Common Issues & Help](./common-issues/index.md)
- [Demo User](./demo-user.md)
- [FAQ](./faq.md) - Answers to frequently asked questions
- [What's New](./whats-new.md) - Latest release notes on GitHub
- [Release Lifecycle](./lifecycle.md) - Compare Rolling, Production, and LTS releases and find available downloads
- [Common Issues & Help](./common-issues/index.md) - Troubleshooting for common administration issues
- [Demo User](./demo-user.md) - Overview of pre-configured demo users, their roles, group memberships, and credentials
6 changes: 6 additions & 0 deletions docs/dev/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,9 @@ Please be patient, we are working on the content.
If you want to contribute to the dev docs, please visit [OpenCloud on Github](https://github.com/opencloud-eu/).

Contents will be transferred during the build process.

## In this section

- [Server](./server/index.md) - Architecture, APIs, and configuration of the OpenCloud server
- [Web](./web/index.md) - Development of the OpenCloud Web frontend
- [cdPerf](./cdperf.md) - Performance testing with cdPerf
6 changes: 6 additions & 0 deletions docs/dev/server/apis/http/graph/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,9 @@ curl 'https://cloud.opencloud.test/graph/v1.0/me' -H 'accept: application/json'
```

## Resources

- [Users](./users.md) - Read and manage users
- [Groups](./groups.md) - Read and manage groups and their members
- [Spaces](./spaces.md) - Read and manage spaces (drives)
- [Permissions](./permissions.md) - Manage sharing permissions on files, folders, and spaces
- [Role](./role.md) - List the available sharing roles
7 changes: 7 additions & 0 deletions docs/dev/server/apis/http/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,10 @@ sidebar_position: 1
The [Hypertext Transfer Protocol (HTTP)](https://www.rfc-editor.org/rfc/rfc2616) is a stateless application-level protocol for distributed, collaborative, hypertext information systems. HTTP is the foundation of data communication for the World Wide Web, where hypertext documents include hyperlinks to other resources that the user can easily access, for example by a mouse click or by tapping the screen in a web browser.

Development of HTTP was initiated by Tim Berners-Lee at CERN in 1989 and summarized in a simple document describing the behavior of a client and a server using the first HTTP protocol version that was named 0.9. That first version of HTTP protocol soon evolved into a more elaborated version that was the first draft toward a far future version 1.0

## In this section

- [LibreGraph](./graph/index.md) - REST API inspired by the Microsoft Graph API
- [WebDAV](./webdav/index.md) - Manage files, metadata, and locks via WebDAV
- [Authorization](./authorization.md) - Supported OpenID Connect authentication flows
- [Resumable Upload](./tus_upload.md) - Upload large files reliably with the tus protocol
7 changes: 7 additions & 0 deletions docs/dev/server/configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,10 @@
title: Configuration
sidebar_position: 1
---

This section describes how the OpenCloud server is configured.

## In this section

- [Configuration System](./config-system.md) - How configuration files, environment variables, and overrides work together
- [Global Environment Variables](./global-envvars.mdx) - Environment variables that apply to multiple services
5 changes: 5 additions & 0 deletions docs/dev/server/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,8 @@ sidebar_position: 1
Our current Architecture Diagrams can be found <a href="/likec4" target="_blank">here</a>.

You’ll find the Libre Graph API documentation by clicking <a href="https://docs.opencloud.eu/swagger/libre-graph-api/" target="_blank">this link</a>.

## In this section

- [APIs](./apis/index.md) - HTTP and gRPC APIs of OpenCloud
- [Configuration](./configuration/index.md) - Configuration system and global environment variables
11 changes: 11 additions & 0 deletions docs/dev/web/extension-system/extension-types/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,14 @@ title: 'Extension Types'

This section is a guide about the different predefined extension types of OpenCloud Web. Please refer to the respective
subpages to learn more about the individual extension types.

## In this section

- [Action extensions](./action-extensions.md) - Register actions that are rendered across the UI
- [Application menu item extensions](./app-menu-item-extensions.md) - Add links to the application switcher
- [Custom component extensions](./custom-component-extensions.md) - Render custom components at defined extension points
- [Folder view extensions](./folder-view-extensions.md) - Provide new views for folders, files, and spaces
- [Left sidebar menu item extensions](./left-sidebar-menu-item-extensions.md) - Add items to the left sidebar
- [Right sidebar panel extensions](./right-sidebar-panel-extensions.md) - Add panels to the right sidebar
- [Search extensions](./search-extensions.md) - Add search providers to the top bar search
- [Floating Action Button extensions](./floating-action-button-extensions.md) - Register actions for the left sidebar or as a floating button on mobile
9 changes: 9 additions & 0 deletions docs/dev/web/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,12 @@ title: 'Web UI'
This is the next generation OpenCloud frontend.
If you're new here, head over to the the [getting started guide](./getting-started)
for a quick introduction.

## In this section

- [Getting Started](./getting-started.md) - Source code and first steps with OpenCloud Web
- [Development](./development/tooling.md) - Tooling, repo structure, and conventions
- [Testing](./testing/e2e-testing-standards.md) - Standards for end-to-end tests
- [Embed Mode](./embed-mode.md) - Integrate OpenCloud Web into another application
- [Extension System](./extension-system/index.md) - Extend OpenCloud Web with apps and extensions
- [Design System](./design-system.md) - UI components of OpenCloud Web
8 changes: 4 additions & 4 deletions docs/user/desktop-client/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ The OpenCloud Desktop Client synchronizes files between your computer and OpenCl

## In this section

- [Windows](./windows/installation.md)
- [Windows](./windows/index.md)
Install, set up, and configure the Desktop Client on Windows.

- [MacOS](./macos/installation.md)
- [MacOS](./macos/index.md)
Install, set up, and configure the Desktop Client on macOS.

- [Linux](./linux/installation.md)
- [Linux](./linux/index.md)
Install, set up, and configure the Desktop Client on Linux.

- [Common functionality](./common-functionality/multiple-accounts.md)
- [Common functionality](./common-functionality/index.md)
Learn about shared features such as multiple accounts, file naming rules, conflict handling, and logging.
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ lokalen Dateien.

## In diesem Abschnitt

- [Windows](./windows/installation.md)
- [Windows](./windows/index.md)
Installieren, einrichten und konfigurieren Sie den Desktop Client unter Windows.

- [macOS](./macos/installation.md)
- [macOS](./macos/index.md)
Installieren, einrichten und konfigurieren Sie den Desktop Client unter macOS.

- [Linux](./linux/installation.md)
- [Linux](./linux/index.md)
Installieren, einrichten und konfigurieren Sie den Desktop Client unter Linux.

- [Gemeinsame Funktionen](./common-functionality/multiple-accounts.md)
- [Gemeinsame Funktionen](./common-functionality/index.md)
Erfahren Sie mehr über gemeinsame Funktionen wie mehrere Konten, Dateinamenregeln, Konfliktbehandlung und Logging.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: OpenCloud Desktop Client für Windows

# OpenCloud Desktop Client für Windows

Der OpenCloud Desktop Client für Windows ermöglicht die Synchronisierung von Dateien zwischen Ihrem Windows-Gerät und Ihrer OpenCloud-Instanz. Dieser Abschnitt führt Sie durch alle wichtigen Schritte – von der Installation und Ersteinrichtung über die Konfiguration der Synchronisierung und der Anwendungseinstellungen bis hin zur Verwendung des Windows Virtual File System (VFS).
Der OpenCloud Desktop Client für Windows ermöglicht die Synchronisierung von Dateien zwischen Ihrem Windows-Gerät und Ihrer OpenCloud-Instanz. Dieser Abschnitt führt Sie durch alle wichtigen Schritte – von der Installation und Ersteinrichtung über die Konfiguration der Synchronisierung und der Anwendungseinstellungen bis hin zur Aktualisierung auf neuere Versionen.

## In diesem Abschnitt

Expand All @@ -21,3 +21,6 @@ Der OpenCloud Desktop Client für Windows ermöglicht die Synchronisierung von D

- [Einstellungen unter Windows](./settings.md)
Passen Sie den Desktop Client an, indem Sie allgemeine, erweiterte, Netzwerk- und Bandbreiteneinstellungen konfigurieren.

- [OpenCloud Desktop Client unter Windows aktualisieren](./upgrade.md)
Erfahren Sie, wie Sie den OpenCloud Desktop Client über den Microsoft Store aktualisieren und dabei Ihre bestehende Konfiguration und synchronisierten Dateien beibehalten.
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ lokalen Dateien.

## In diesem Abschnitt

- [Windows](./windows/installation.md)
- [Windows](./windows/index.md)
Installieren, einrichten und konfigurieren Sie den Desktop Client unter Windows.

- [macOS](./macos/installation.md)
- [macOS](./macos/index.md)
Installieren, einrichten und konfigurieren Sie den Desktop Client unter macOS.

- [Linux](./linux/installation.md)
- [Linux](./linux/index.md)
Installieren, einrichten und konfigurieren Sie den Desktop Client unter Linux.

- [Gemeinsame Funktionen](./common-functionality/multiple-accounts.md)
- [Gemeinsame Funktionen](./common-functionality/index.md)
Erfahren Sie mehr über gemeinsame Funktionen wie mehrere Konten, Dateinamenregeln, Konfliktbehandlung und Logging.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: OpenCloud Desktop Client für Windows

# OpenCloud Desktop Client für Windows

Der OpenCloud Desktop Client für Windows ermöglicht die Synchronisierung von Dateien zwischen Ihrem Windows-Gerät und Ihrer OpenCloud-Instanz. Dieser Abschnitt führt Sie durch alle wichtigen Schritte – von der Installation und Ersteinrichtung über die Konfiguration der Synchronisierung und der Anwendungseinstellungen bis hin zur Verwendung des Windows Virtual File System (VFS).
Der OpenCloud Desktop Client für Windows ermöglicht die Synchronisierung von Dateien zwischen Ihrem Windows-Gerät und Ihrer OpenCloud-Instanz. Dieser Abschnitt führt Sie durch alle wichtigen Schritte – von der Installation und Ersteinrichtung über die Konfiguration der Synchronisierung und der Anwendungseinstellungen bis hin zur Aktualisierung auf neuere Versionen.

## In diesem Abschnitt

Expand All @@ -21,3 +21,6 @@ Der OpenCloud Desktop Client für Windows ermöglicht die Synchronisierung von D

- [Einstellungen unter Windows](./settings.md)
Passen Sie den Desktop Client an, indem Sie allgemeine, erweiterte, Netzwerk- und Bandbreiteneinstellungen konfigurieren.

- [OpenCloud Desktop Client unter Windows aktualisieren](./upgrade.md)
Erfahren Sie, wie Sie den OpenCloud Desktop Client über den Microsoft Store aktualisieren und dabei Ihre bestehende Konfiguration und synchronisierten Dateien beibehalten.
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ lokalen Dateien.

## In diesem Abschnitt

- [Windows](./windows/installation.md)
- [Windows](./windows/index.md)
Installieren, einrichten und konfigurieren Sie den Desktop Client unter Windows.

- [macOS](./macos/installation.md)
- [macOS](./macos/index.md)
Installieren, einrichten und konfigurieren Sie den Desktop Client unter macOS.

- [Linux](./linux/installation.md)
- [Linux](./linux/index.md)
Installieren, einrichten und konfigurieren Sie den Desktop Client unter Linux.

- [Gemeinsame Funktionen](./common-functionality/multiple-accounts.md)
- [Gemeinsame Funktionen](./common-functionality/index.md)
Erfahren Sie mehr über gemeinsame Funktionen wie mehrere Konten, Dateinamenregeln, Konfliktbehandlung und Logging.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: OpenCloud Desktop Client für Windows

# OpenCloud Desktop Client für Windows

Der OpenCloud Desktop Client für Windows ermöglicht die Synchronisierung von Dateien zwischen Ihrem Windows-Gerät und Ihrer OpenCloud-Instanz. Dieser Abschnitt führt Sie durch alle wichtigen Schritte – von der Installation und Ersteinrichtung über die Konfiguration der Synchronisierung und der Anwendungseinstellungen bis hin zur Verwendung des Windows Virtual File System (VFS).
Der OpenCloud Desktop Client für Windows ermöglicht die Synchronisierung von Dateien zwischen Ihrem Windows-Gerät und Ihrer OpenCloud-Instanz. Dieser Abschnitt führt Sie durch alle wichtigen Schritte – von der Installation und Ersteinrichtung über die Konfiguration der Synchronisierung und der Anwendungseinstellungen bis hin zur Aktualisierung auf neuere Versionen.

## In diesem Abschnitt

Expand All @@ -21,3 +21,6 @@ Der OpenCloud Desktop Client für Windows ermöglicht die Synchronisierung von D

- [Einstellungen unter Windows](./settings.md)
Passen Sie den Desktop Client an, indem Sie allgemeine, erweiterte, Netzwerk- und Bandbreiteneinstellungen konfigurieren.

- [OpenCloud Desktop Client unter Windows aktualisieren](./upgrade.md)
Erfahren Sie, wie Sie den OpenCloud Desktop Client über den Microsoft Store aktualisieren und dabei Ihre bestehende Konfiguration und synchronisierten Dateien beibehalten.
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,9 @@ This mode is suitable in scenarios where the OpenIDConnect provider is external
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](./keycloak#autoprovisioning-mode) guide.

## Guides

- [External OpenID Connect Identity Provider](./external-idp.md) - Requirements for integrating external OpenID Connect IDPs
- [Keycloak Integration](./keycloak.md) - Configure Keycloak in Shared User Directory or Autoprovisioning mode
- [Adding users with Keycloak](./keycloak-user.md) - Create new users in Keycloak, including users without a personal space
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,7 @@ It is meant as a quick entry point for administrators who want to improve docume
## What you will find here

- Add additional fonts so documents render more reliably across systems.
- Enable Microsoft Office formats in the New menu when you want to create `.docx`, `.xlsx`, or `.pptx` files directly.

## Guides

- [Install additional fonts](./collabora-fonts)
- [Enable MS-Office formats](./collabora-ms-office-formats)
- [Install additional fonts](../collabora.md) - Add fonts so documents render reliably
Loading
Loading