diff --git a/docs/admin/configuration/_category_.json b/docs/admin/configuration/_category_.json index c97c1d99..f10617d8 100644 --- a/docs/admin/configuration/_category_.json +++ b/docs/admin/configuration/_category_.json @@ -2,8 +2,7 @@ "label": "Configuration", "position": 5, "link": { - "type": "generated-index", - "description": "⚙️ Configuration", - "slug": "admin/configuration/" + "type": "doc", + "id": "admin-configuration" } } diff --git a/docs/admin/configuration/authentication-and-user-management/index.md b/docs/admin/configuration/authentication-and-user-management/index.md index 9944e0cb..b60a155d 100644 --- a/docs/admin/configuration/authentication-and-user-management/index.md +++ b/docs/admin/configuration/authentication-and-user-management/index.md @@ -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 @@ -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 @@ -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 diff --git a/docs/admin/configuration/collabora/_category_.json b/docs/admin/configuration/collabora/_category_.json index 3607b364..d3a23ec1 100644 --- a/docs/admin/configuration/collabora/_category_.json +++ b/docs/admin/configuration/collabora/_category_.json @@ -1,4 +1,8 @@ { "label": "Collabora", - "position": 30 + "position": 30, + "link": { + "type": "doc", + "id": "collabora" + } } diff --git a/docs/admin/configuration/collabora/index.md b/docs/admin/configuration/collabora/index.md index 44fb9f25..0674bb3b 100644 --- a/docs/admin/configuration/collabora/index.md +++ b/docs/admin/configuration/collabora/index.md @@ -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. diff --git a/docs/admin/configuration/index.md b/docs/admin/configuration/index.md new file mode 100644 index 00000000..06a6f016 --- /dev/null +++ b/docs/admin/configuration/index.md @@ -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) diff --git a/docs/admin/configuration/storage/_category_.json b/docs/admin/configuration/storage/_category_.json index e59f400f..5475fd5c 100644 --- a/docs/admin/configuration/storage/_category_.json +++ b/docs/admin/configuration/storage/_category_.json @@ -1,4 +1,8 @@ { "label": "Storage", - "position": 20 + "position": 20, + "link": { + "type": "doc", + "id": "storage" + } } diff --git a/docs/admin/configuration/storage/index.md b/docs/admin/configuration/storage/index.md new file mode 100644 index 00000000..5e06f6fa --- /dev/null +++ b/docs/admin/configuration/storage/index.md @@ -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 diff --git a/docs/admin/getting-started/_category_.json b/docs/admin/getting-started/_category_.json index b69776d8..9c8ea8d2 100644 --- a/docs/admin/getting-started/_category_.json +++ b/docs/admin/getting-started/_category_.json @@ -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" } } diff --git a/docs/admin/getting-started/container/_category_.json b/docs/admin/getting-started/container/_category_.json index edb9237b..df36e478 100644 --- a/docs/admin/getting-started/container/_category_.json +++ b/docs/admin/getting-started/container/_category_.json @@ -1,4 +1,8 @@ { "label": "Container", - "position": 2 + "position": 2, + "link": { + "type": "doc", + "id": "admin-getting-started-container" + } } diff --git a/docs/admin/getting-started/container/docker-compose/_category_.json b/docs/admin/getting-started/container/docker-compose/_category_.json index 545ef39c..1f12f757 100644 --- a/docs/admin/getting-started/container/docker-compose/_category_.json +++ b/docs/admin/getting-started/container/docker-compose/_category_.json @@ -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" + } } diff --git a/docs/admin/getting-started/container/index.md b/docs/admin/getting-started/container/index.md new file mode 100644 index 00000000..80b87af5 --- /dev/null +++ b/docs/admin/getting-started/container/index.md @@ -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 diff --git a/docs/admin/getting-started/index.md b/docs/admin/getting-started/index.md new file mode 100644 index 00000000..20853746 --- /dev/null +++ b/docs/admin/getting-started/index.md @@ -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 diff --git a/docs/admin/getting-started/other/_category_.json b/docs/admin/getting-started/other/_category_.json index f7650f9b..f82a569e 100644 --- a/docs/admin/getting-started/other/_category_.json +++ b/docs/admin/getting-started/other/_category_.json @@ -1,4 +1,8 @@ { "label": "Other", - "position": 3 + "position": 3, + "link": { + "type": "doc", + "id": "admin-getting-started-other" + } } diff --git a/docs/admin/getting-started/other/index.md b/docs/admin/getting-started/other/index.md new file mode 100644 index 00000000..bbe4f07f --- /dev/null +++ b/docs/admin/getting-started/other/index.md @@ -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 diff --git a/docs/admin/index.md b/docs/admin/index.md index 9596bb12..567ac18f 100644 --- a/docs/admin/index.md +++ b/docs/admin/index.md @@ -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. diff --git a/docs/admin/maintenance/_category_.json b/docs/admin/maintenance/_category_.json index a29ee248..15f8decd 100644 --- a/docs/admin/maintenance/_category_.json +++ b/docs/admin/maintenance/_category_.json @@ -2,8 +2,7 @@ "label": "Maintenance", "position": 6, "link": { - "type": "generated-index", - "description": "🛠️ Maintenance", - "slug": "admin/maintenance/" + "type": "doc", + "id": "admin-maintenance" } } diff --git a/docs/admin/maintenance/index.md b/docs/admin/maintenance/index.md new file mode 100644 index 00000000..368acdd3 --- /dev/null +++ b/docs/admin/maintenance/index.md @@ -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) diff --git a/docs/admin/maintenance/upgrade/_category_.json b/docs/admin/maintenance/upgrade/_category_.json index edaf657a..025a6822 100644 --- a/docs/admin/maintenance/upgrade/_category_.json +++ b/docs/admin/maintenance/upgrade/_category_.json @@ -2,8 +2,7 @@ "label": "Upgrade", "position": 1, "link": { - "type": "generated-index", - "description": "Upgrade", - "slug": "admin/maintainance/upgrade/" + "type": "doc", + "id": "upgrade" } } diff --git a/docs/admin/maintenance/upgrade/index.md b/docs/admin/maintenance/upgrade/index.md new file mode 100644 index 00000000..81b170b7 --- /dev/null +++ b/docs/admin/maintenance/upgrade/index.md @@ -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) diff --git a/docs/admin/maintenance/upgrade/upgrade-4.0.0.md b/docs/admin/maintenance/upgrade/upgrade-4.0.0.md index 2bb3667c..d5db9e11 100644 --- a/docs/admin/maintenance/upgrade/upgrade-4.0.0.md +++ b/docs/admin/maintenance/upgrade/upgrade-4.0.0.md @@ -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. ::: @@ -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. diff --git a/docs/admin/maintenance/upgrade/upgrade.md b/docs/admin/maintenance/upgrade/upgrade.md index ed7bb702..41555bca 100644 --- a/docs/admin/maintenance/upgrade/upgrade.md +++ b/docs/admin/maintenance/upgrade/upgrade.md @@ -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 diff --git a/docs/admin/resources/_category_.json b/docs/admin/resources/_category_.json index 52833a42..8211813c 100644 --- a/docs/admin/resources/_category_.json +++ b/docs/admin/resources/_category_.json @@ -2,8 +2,7 @@ "label": "Resources", "position": 7, "link": { - "type": "generated-index", - "description": "Resources", - "slug": "admin/resources/" + "type": "doc", + "id": "admin-resources" } } diff --git a/docs/admin/resources/index.md b/docs/admin/resources/index.md new file mode 100644 index 00000000..7f0ac633 --- /dev/null +++ b/docs/admin/resources/index.md @@ -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) diff --git a/versioned_docs/version-4.0/admin/configuration/authentication-and-user-management/index.md b/versioned_docs/version-4.0/admin/configuration/authentication-and-user-management/index.md index 9944e0cb..b60a155d 100644 --- a/versioned_docs/version-4.0/admin/configuration/authentication-and-user-management/index.md +++ b/versioned_docs/version-4.0/admin/configuration/authentication-and-user-management/index.md @@ -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 @@ -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 @@ -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 diff --git a/versioned_docs/version-4.0/admin/configuration/collabora/index.md b/versioned_docs/version-4.0/admin/configuration/collabora/index.md new file mode 100644 index 00000000..0674bb3b --- /dev/null +++ b/versioned_docs/version-4.0/admin/configuration/collabora/index.md @@ -0,0 +1,22 @@ +--- +sidebar_position: 1 +id: collabora +title: Collabora +description: Configuration guides for Collabora integration in OpenCloud +draft: false +--- + +# Collabora + +This section collects the most common Collabora configuration topics for OpenCloud. +It is meant as a quick entry point for administrators who want to improve document compatibility and editing experience. + +## 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) diff --git a/versioned_docs/version-4.0/admin/configuration/index.md b/versioned_docs/version-4.0/admin/configuration/index.md new file mode 100644 index 00000000..2d9d249c --- /dev/null +++ b/versioned_docs/version-4.0/admin/configuration/index.md @@ -0,0 +1,23 @@ +--- +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 +- [Frontend Update Check](./frontend-update-check.md) +- [Remove Mandatory Password from Public Link](./remove-password-link.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) diff --git a/versioned_docs/version-4.0/admin/configuration/storage/index.md b/versioned_docs/version-4.0/admin/configuration/storage/index.md new file mode 100644 index 00000000..5e06f6fa --- /dev/null +++ b/versioned_docs/version-4.0/admin/configuration/storage/index.md @@ -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 diff --git a/versioned_docs/version-4.0/admin/getting-started/container/docker-compose/index.md b/versioned_docs/version-4.0/admin/getting-started/container/docker-compose/index.md new file mode 100644 index 00000000..026147bf --- /dev/null +++ b/versioned_docs/version-4.0/admin/getting-started/container/docker-compose/index.md @@ -0,0 +1,46 @@ +--- +sidebar_position: 1 +id: docker-compose-overview +title: Docker Compose Overview +description: Choose your Docker Compose deployment architecture for OpenCloud +--- + +# Docker Compose Deployment + +This section guides you through deploying OpenCloud using Docker Compose. We support two main deployment architectures, suitable for different infrastructure scenarios. + +## Choose Your Deployment Path + +### 1. Integrated Traefik (Recommended for most users) + +Use the built-in Traefik reverse proxy and automatic Let's Encrypt SSL certificates. This is the standard, recommended path for new deployments. + +Best for: + +- Standalone servers +- No existing reverse proxy infrastructure +- Simple, self-contained setup + +[Get Started with Integrated Traefik →](./docker-compose-base.md) + +### 2. Behind External Proxy + +Use this setup if you want to run OpenCloud behind your own reverse proxy instead of the integrated Traefik setup. + +The guide includes the required OpenCloud settings and an example Nginx configuration. + +Best for: + +- Existing reverse proxy environments +- Custom TLS handling +- Separate proxy management + +[Deploy Behind External Proxy →](./docker-external-proxy.md) + +## Further Configuration + +After choosing and completing your deployment: + +- [Production Setup Considerations](./production-setup-consideration.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 diff --git a/versioned_docs/version-4.0/admin/getting-started/container/index.md b/versioned_docs/version-4.0/admin/getting-started/container/index.md new file mode 100644 index 00000000..80b87af5 --- /dev/null +++ b/versioned_docs/version-4.0/admin/getting-started/container/index.md @@ -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 diff --git a/versioned_docs/version-4.0/admin/getting-started/index.md b/versioned_docs/version-4.0/admin/getting-started/index.md new file mode 100644 index 00000000..20853746 --- /dev/null +++ b/versioned_docs/version-4.0/admin/getting-started/index.md @@ -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 diff --git a/versioned_docs/version-4.0/admin/getting-started/other/index.md b/versioned_docs/version-4.0/admin/getting-started/other/index.md new file mode 100644 index 00000000..bbe4f07f --- /dev/null +++ b/versioned_docs/version-4.0/admin/getting-started/other/index.md @@ -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 diff --git a/versioned_docs/version-4.0/admin/index.md b/versioned_docs/version-4.0/admin/index.md index 9596bb12..567ac18f 100644 --- a/versioned_docs/version-4.0/admin/index.md +++ b/versioned_docs/version-4.0/admin/index.md @@ -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. diff --git a/versioned_docs/version-4.0/admin/maintenance/index.md b/versioned_docs/version-4.0/admin/maintenance/index.md new file mode 100644 index 00000000..368acdd3 --- /dev/null +++ b/versioned_docs/version-4.0/admin/maintenance/index.md @@ -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) diff --git a/versioned_docs/version-4.0/admin/maintenance/upgrade/_category_.json b/versioned_docs/version-4.0/admin/maintenance/upgrade/_category_.json index edaf657a..025a6822 100644 --- a/versioned_docs/version-4.0/admin/maintenance/upgrade/_category_.json +++ b/versioned_docs/version-4.0/admin/maintenance/upgrade/_category_.json @@ -2,8 +2,7 @@ "label": "Upgrade", "position": 1, "link": { - "type": "generated-index", - "description": "Upgrade", - "slug": "admin/maintainance/upgrade/" + "type": "doc", + "id": "upgrade" } } diff --git a/versioned_docs/version-4.0/admin/maintenance/upgrade/index.md b/versioned_docs/version-4.0/admin/maintenance/upgrade/index.md new file mode 100644 index 00000000..81b170b7 --- /dev/null +++ b/versioned_docs/version-4.0/admin/maintenance/upgrade/index.md @@ -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) diff --git a/versioned_docs/version-4.0/admin/maintenance/upgrade/upgrade-4.0.0.md b/versioned_docs/version-4.0/admin/maintenance/upgrade/upgrade-4.0.0.md index 2bb3667c..d5db9e11 100644 --- a/versioned_docs/version-4.0/admin/maintenance/upgrade/upgrade-4.0.0.md +++ b/versioned_docs/version-4.0/admin/maintenance/upgrade/upgrade-4.0.0.md @@ -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. ::: @@ -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. diff --git a/versioned_docs/version-4.0/admin/maintenance/upgrade/upgrade.md b/versioned_docs/version-4.0/admin/maintenance/upgrade/upgrade.md index e2a29f30..41555bca 100644 --- a/versioned_docs/version-4.0/admin/maintenance/upgrade/upgrade.md +++ b/versioned_docs/version-4.0/admin/maintenance/upgrade/upgrade.md @@ -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](docs/admin/getting-started/container/docker.md) and [docker compose](docs/admin/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 diff --git a/versioned_docs/version-4.0/admin/resources/index.md b/versioned_docs/version-4.0/admin/resources/index.md new file mode 100644 index 00000000..7f0ac633 --- /dev/null +++ b/versioned_docs/version-4.0/admin/resources/index.md @@ -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)