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
5 changes: 2 additions & 3 deletions docs/admin/configuration/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
"label": "Configuration",
"position": 5,
"link": {
"type": "generated-index",
"description": "⚙️ Configuration",
"slug": "admin/configuration/"
"type": "doc",
"id": "admin-configuration"
}
}
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: 'Authentication and Identity Management'
title: 'Internal and External IDP'
---

# Authentication and Identity Management
# Internal and External IDP

OpenCloud offers two ways to handle user authentication:
OpenCloud offers two ways to handle user authentication and identity management:

1. **Built-in IDP (Identity Provider)**:
- Based on LibreGraph Connect (Lico)
1. **Internal IDP**:
- Built into OpenCloud
- Targeted at smaller installations (up to 500 users)
- Designed for standalone or small deployments

Expand All @@ -18,14 +18,14 @@ OpenCloud offers two ways to handle user authentication:

## Your Use Cases

### Choose Lico if you need
### Choose the internal IDP if you need

- A simple, lightweight and minimal OpenID Connect Provider
- Small to medium deployments
- Minimal resource footprint
- Quick setup with basic features
- Ideal for development environment
- No Multifactor Authentication (MFA) and migration path to other IDPs
- No Multifactor Authentication (MFA) and no migration path to other IDPs

### Choose Keycloak if you need

Expand All @@ -40,7 +40,7 @@ OpenCloud offers two ways to handle user authentication:

### Bottom Line

Keycloak is a comprehensive, enterprise-ready IAM platform with extensive features including SSO, user federation, and support for multiple protocols like OpenID Connect, OAuth 2.0, and SAML, while Lico is a lightweight OpenID Connect provider with integrated web login and consent forms, designed as a simpler alternative for smaller installations. Keycloak offers more features but requires more resources and expertise, while Lico provides a minimalist approach suitable for basic authentication needs.
Keycloak is a comprehensive, enterprise-ready IAM platform with extensive features including SSO, user federation, and support for multiple protocols like OpenID Connect, OAuth 2.0, and SAML. It offers more features but requires more resources and expertise, which makes it a better fit for larger or more complex environments.

## Authentication with Keycloak

Expand Down
6 changes: 5 additions & 1 deletion docs/admin/configuration/collabora/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
{
"label": "Collabora",
"position": 30
"position": 30,
"link": {
"type": "doc",
"id": "collabora"
}
}
4 changes: 0 additions & 4 deletions docs/admin/configuration/collabora/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,3 @@ It is meant as a quick entry point for administrators who want to improve docume

- [Install additional fonts](./collabora-fonts)
- [Enable MS-Office formats](./collabora-ms-office-formats)

## Recommended order

If you are setting up Collabora for the first time, start with fonts and then decide whether Microsoft file formats should be available in the creation menu.
24 changes: 24 additions & 0 deletions docs/admin/configuration/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
sidebar_position: 0
id: admin-configuration
title: Configuration
description: Overview of OpenCloud administration configuration topics
---

# Configuration

Use these guides to tune OpenCloud behavior, integrations, and default settings.

## In this section

- [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
- [Default Language](./default-language.md)
- [Frontend Update Check](./frontend-update-check.md)
- [Link Password Policy](./link-password-policy.md)
- [Logging](./logging.md)
- [Mail Notifications](./mail-notifications.md)
- [Radicale Integration](./radicale-integration.md)
- [Set Default Quota](./set-default-quota.md)
- [Web Applications](./web-applications.md)
6 changes: 5 additions & 1 deletion docs/admin/configuration/storage/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
{
"label": "Storage",
"position": 20
"position": 20,
"link": {
"type": "doc",
"id": "storage"
}
}
16 changes: 16 additions & 0 deletions docs/admin/configuration/storage/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
sidebar_position: 0
id: storage
title: Storage
description: Overview of OpenCloud storage configuration options
draft: false
---

# Storage

Use these guides to configure the storage backend for your OpenCloud deployment.

## In this section

- [PosixFS](./posixfs.md) - Use a regular filesystem as the OpenCloud storage backend
- [DecomposedS3](./decomposeds3.md) - Use S3-compatible object storage with MinIO
5 changes: 2 additions & 3 deletions docs/admin/getting-started/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
"label": "Getting Started",
"position": 4,
"link": {
"type": "generated-index",
"description": "🚀 Getting Started",
"slug": "admin/getting-started/"
"type": "doc",
"id": "admin-getting-started"
}
}
6 changes: 5 additions & 1 deletion docs/admin/getting-started/container/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
{
"label": "Container",
"position": 2
"position": 2,
"link": {
"type": "doc",
"id": "admin-getting-started-container"
}
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
{
"label": "Docker Compose",
"position": 1,
"description": "Deploy OpenCloud using Docker Compose with Traefik or an external reverse proxy"
"description": "Deploy OpenCloud using Docker Compose with Traefik or an external reverse proxy",
"link": {
"type": "doc",
"id": "docker-compose-overview"
}
}
15 changes: 15 additions & 0 deletions docs/admin/getting-started/container/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
sidebar_position: 0
id: admin-getting-started-container
title: Container
description: Overview of container-based OpenCloud deployment guides
---

# Container Deployments

Use the container guides if you want to run OpenCloud with Docker or Docker Compose.

## In this section

- [Docker](./docker.md) - Run OpenCloud with a plain Docker setup
- [Docker Compose](./docker-compose/index.md) - Use Docker Compose with Traefik or an external proxy
16 changes: 16 additions & 0 deletions docs/admin/getting-started/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
sidebar_position: 0
id: admin-getting-started
title: Getting Started
description: Overview of the OpenCloud getting started guides for administrators
---

# Getting Started

Use this section to install and deploy OpenCloud in the environment that fits your setup best.

## In this section

- [Requirements](./requirements.md) - Check prerequisites before you install OpenCloud
- [Container Deployments](./container/index.md) - Run OpenCloud in Docker or Docker Compose
- [Other Deployment Options](./other/index.md) - Bare metal and Raspberry Pi installations
6 changes: 5 additions & 1 deletion docs/admin/getting-started/other/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
{
"label": "Other",
"position": 3
"position": 3,
"link": {
"type": "doc",
"id": "admin-getting-started-other"
}
}
15 changes: 15 additions & 0 deletions docs/admin/getting-started/other/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
sidebar_position: 0
id: admin-getting-started-other
title: Other
description: Alternative OpenCloud deployment guides
---

# Other Deployment Options

These guides cover deployments outside the standard container-based setup.

## In this section

- [Bare Metal](./bare-metal.md) - Install OpenCloud directly on a server (not officially supported)
- [Raspberry Pi](./raspberry-pi.md) - Run OpenCloud on a Raspberry Pi
7 changes: 7 additions & 0 deletions docs/admin/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,13 @@ curl -L https://opencloud.eu/install | /bin/bash
- Configuration – Customize and integrate with existing systems and storage
- Maintenance – Learn how to update, backup and migrate

## Explore the Admin Docs

- [Getting Started](./getting-started/index.md) - Install and deploy OpenCloud
- [Configuration](./configuration/index.md) - Tune OpenCloud behavior and integrations
- [Maintenance](./maintenance/index.md) - Backups, exports, migration, and uninstall
- [Resources](./resources/index.md) - Troubleshooting, lifecycle, and FAQ

## Documentation Versions

Our documentation is versioned to ensure you always find the right information for your software version.
Expand Down
5 changes: 2 additions & 3 deletions docs/admin/maintenance/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
"label": "Maintenance",
"position": 6,
"link": {
"type": "generated-index",
"description": "🛠️ Maintenance",
"slug": "admin/maintenance/"
"type": "doc",
"id": "admin-maintenance"
}
}
18 changes: 18 additions & 0 deletions docs/admin/maintenance/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
sidebar_position: 0
id: admin-maintenance
title: Maintenance
description: Overview of OpenCloud maintenance tasks
---

# Maintenance

Use these guides to keep your OpenCloud installation updated, backed up, and manageable over time.

## In this section

- [Upgrade](./upgrade/index.md)
- [Backup](./backup.md)
- [Migrate](./migrate.md)
- [Uninstall](./uninstall.md)
- [Data Export](./dataexport.md)
5 changes: 2 additions & 3 deletions docs/admin/maintenance/upgrade/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
"label": "Upgrade",
"position": 1,
"link": {
"type": "generated-index",
"description": "Upgrade",
"slug": "admin/maintainance/upgrade/"
"type": "doc",
"id": "upgrade"
}
}
17 changes: 17 additions & 0 deletions docs/admin/maintenance/upgrade/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
sidebar_position: 0
id: upgrade
title: Upgrade
description: Overview of OpenCloud upgrade guides and release notes
draft: false
---

# Upgrade

This section collects the guides you need when upgrading OpenCloud.

## Guides

- [Standard Upgrade Guide](./upgrade.md)
- [Upgrade 4.0.x](./upgrade-4.0.0.md)
- [Release notes](./release-notes.md)
4 changes: 2 additions & 2 deletions docs/admin/maintenance/upgrade/upgrade-4.0.0.md
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.x release of Ope

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

Expand Down Expand Up @@ -113,7 +113,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](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
11 changes: 6 additions & 5 deletions docs/admin/maintenance/upgrade/upgrade.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
---
sidebar_position: 1
id: update
title: Upgrade
description: Keep your setup up to date with the latest features!
id: upgrade-guide
title: Standard Upgrade Guide
description: Standard guide for upgrading OpenCloud
draft: false
slug: upgrade-guide
---

# Upgrade
# Standard Upgrade Guide

import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'

This guide provides steps to upgrade OpenCloud for both [docker](../../getting-started/container/docker.md) and [docker compose](../../getting-started/container/docker-compose/docker-compose-base.md)
This guide provides the standard steps to upgrade OpenCloud for both [docker](../../getting-started/container/docker.md) and [docker compose](../../getting-started/container/docker-compose/docker-compose-base.md)

## Stop OpenCloud

Expand Down
5 changes: 2 additions & 3 deletions docs/admin/resources/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
"label": "Resources",
"position": 7,
"link": {
"type": "generated-index",
"description": "Resources",
"slug": "admin/resources/"
"type": "doc",
"id": "admin-resources"
}
}
18 changes: 18 additions & 0 deletions docs/admin/resources/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
sidebar_position: 0
id: admin-resources
title: Resources
description: Helpful resources for OpenCloud administrators
---

# Resources

Use this section for troubleshooting, lifecycle information, and general admin help.

## In this section

- [FAQ](./faq.md)
- [What's New](./whats-new.md)
- [Release Lifecycle](./lifecycle.md)
- [Common Issues & Help](./common-issues.md)
- [Demo User](./demo-user.md)
Loading