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 CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co

## Overview

This is an [Antora](https://antora.org/)-based documentation site for ownCloud Server. Documentation is written in AsciiDoc and built into a static HTML site. This repo is not built standalone in production — it is built as part of the main [owncloud/docs](https://github.com/owncloud/docs) repository, but can be built locally for preview.
This is an [Antora](https://antora.org/)-based documentation site for ownCloud Classic. Documentation is written in AsciiDoc and built into a static HTML site. This repo is not built standalone in production — it is built as part of the main [owncloud/docs](https://github.com/owncloud/docs) repository, but can be built locally for preview.

## Commands

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# ownCloud Server Documentation
# ownCloud Classic Documentation

<!-- OSPO-managed README | Generated: 2026-04-16 | v2 -->

[![License](https://img.shields.io/badge/License-AGPL--3.0-blue.svg)](LICENSE) [![ownCloud OSPO](https://img.shields.io/badge/OSPO-ownCloud-blue)](https://kiteworks.com/opensource)

Antora-based documentation component for ownCloud Server (OC10). This repository contains the AsciiDoc source files for server administration, user management, configuration, and maintenance documentation, published to [doc.owncloud.com](https://doc.owncloud.com).
Antora-based documentation component for ownCloud Classic (OC10). This repository contains the AsciiDoc source files for server administration, user management, configuration, and maintenance documentation, published to [doc.owncloud.com](https://doc.owncloud.com).

## Getting Started

Expand All @@ -26,7 +26,7 @@ This generates a standalone preview at `http://localhost:8080`. For the full sit

## Part of ownCloud Documentation

This is a content component for the [ownCloud docs](https://github.com/owncloud/docs) Antora build. The ownCloud Server source code lives at [owncloud/core](https://github.com/owncloud/core). Published documentation is available at [doc.owncloud.com](https://doc.owncloud.com).
This is a content component for the [ownCloud docs](https://github.com/owncloud/docs) Antora build. The ownCloud Classic source code lives at [owncloud/core](https://github.com/owncloud/core). Published documentation is available at [doc.owncloud.com](https://doc.owncloud.com).

## Community & Support

Expand Down
2 changes: 1 addition & 1 deletion agents.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# AI Agent Guidelines for ownCloud Server Documentation
# AI Agent Guidelines for ownCloud Classic Documentation

This file provides context for AI coding agents (Claude Code, GitHub Copilot, Cursor, etc.) working in this repository.

Expand Down
2 changes: 1 addition & 1 deletion antora.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: server
title: ownCloud Server
title: ownCloud Classic
version: next
prerelease: true
start_page: ROOT:index.adoc
Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
= Introduction to ownCloud Server
= Introduction to ownCloud Classic

Welcome to the ownCloud Server documentation. These documents provide an xref:admin_manual:index.adoc[admin guide] with information for installation, configuration and administrative tasks as well as documentation for xref:developer_manual:index.adoc[developers]. An xref:classic_ui:index.adoc[ownCloud User Manual] for the server is provided in the web documentation.
Welcome to the ownCloud Classic documentation. These documents provide an xref:admin_manual:index.adoc[admin guide] with information for installation, configuration and administrative tasks as well as documentation for xref:developer_manual:index.adoc[developers]. An xref:classic_ui:index.adoc[ownCloud User Manual] for the server is provided in the web documentation.
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,11 @@ On your Universal Forwarder or Heavy Forwarder instance, you must enable input u
. Copy `$SPLUNK_HOME/etc/apps/TA_owncloud/default/inputs.conf.example` to `$SPLUNK_HOME/etc/apps/TA_owncloud/local` directory and rename the file to `inputs.conf`.
. Open `$SPLUNK_HOME/etc/apps/TA_owncloud/local/inputs.conf` for editing.
. Check all `index = owncloud` settings and change the index name if needed.
. Check the ownCloud logs locations (default: `/var/www/owncloud/data/`) and change them to the values you configured on the ownCloud Server.
. Check the ownCloud logs locations (default: `/var/www/owncloud/data/`) and change them to the values you configured on the ownCloud Classic server.
. Save the `$SPLUNK_HOME/etc/apps/TA_owncloud/local/inputs.conf` file.
. Copy `$SPLUNK_HOME/etc/apps/TA_owncloud/default/owncloud.conf.example` to `$SPLUNK_HOME/etc/apps/TA_owncloud/local` directory and rename the file to `owncloud.conf`.
. Open `$SPLUNK_HOME/etc/apps/TA_owncloud/local/owncloud.conf` for editing.
. Change the `METRICSAPIKEY` setting to the Metrics API key value you configured on the ownCloud Server.
. Change the `METRICSAPIKEY` setting to the Metrics API key value you configured on the ownCloud Classic server.
. Change the `API_HOST` setting to your ownCloud instance domain name or IP address. This value is used to query the Metrics API for data.
. Save the `$SPLUNK_HOME/etc/apps/TA_owncloud/local/owncloud.conf` file.
. Restart the Splunk instance.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ go/enable-http-strict-transport-security.adoc

== Introduction

ownCloud aims to ship with secure defaults that do not need to get modified by administrators. However, in some cases some additional security hardening can be applied in scenarios were the administrator has complete control over the ownCloud instance. This page assumes that you run ownCloud Server on Apache2 in a Linux environment.
ownCloud aims to ship with secure defaults that do not need to get modified by administrators. However, in some cases some additional security hardening can be applied in scenarios were the administrator has complete control over the ownCloud instance. This page assumes that you run ownCloud Classic on Apache2 in a Linux environment.

NOTE: ownCloud will warn you in the administration interface if some critical security-relevant options are missing. However, it is still up to the server administrator to review and maintain system security.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= ownCloud Server Tuning
= ownCloud Classic Tuning
:toc: right
:memcached-url: https://memcached.org
:thp-url: https://www.kernel.org/doc/Documentation/vm/transhuge.txt
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Marketplace URL: {oc-marketplace-url}/apps/metrics[Metrics]

Monitoring and reporting of ownCloud Server. For details please see the
Monitoring and reporting of ownCloud Classic. For details please see the
xref:enterprise/reporting/metrics.adoc[Metrics] documentation.

Set a secret for authenticating requests at the endpoint.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Process the notifications stored by the `wnd:listen` command

== Set the Service Account

NOTE: This command is deprecated starting with ownCloud 10.8. All mount options marked as _password_ are now encrypted by default. Existing old settings are migrated automatically.
NOTE: This command is deprecated starting with ownCloud Classic 10.8. All mount options marked as _password_ are now encrypted by default. Existing old settings are migrated automatically.

Sets the service account for the target mount point. You'll be asked for the password of the service account.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ upgrade [options]

[width="100%",cols="20%,70%",]
|===
| `--major` | Automatically update apps to new major versions during minor updates of ownCloud Server.
| `--major` | Automatically update apps to new major versions during minor updates of ownCloud Classic.
| `--no-app-disable` | Skip disabling of third party apps.
|===

When you are performing an update or upgrade on your ownCloud Server (see the Maintenance section of this manual), it is better to use `occ` to perform the database upgrade step, rather than the Web GUI, in order to avoid timeouts. PHP scripts invoked from the Web interface are limited to 3600 seconds. In larger environments this may not be enough, leaving the system in an inconsistent state. After performing all the preliminary steps (see the xref:maintenance/upgrading/upgrade.adoc[Maintenance - Upgrade documentation]) use this command to upgrade your databases, like this example:
When you are performing an update or upgrade on your ownCloud Classic (see the Maintenance section of this manual), it is better to use `occ` to perform the database upgrade step, rather than the Web GUI, in order to avoid timeouts. PHP scripts invoked from the Web interface are limited to 3600 seconds. In larger environments this may not be enough, leaving the system in an inconsistent state. After performing all the preliminary steps (see the xref:maintenance/upgrading/upgrade.adoc[Maintenance - Upgrade documentation]) use this command to upgrade your databases, like this example:

[source,docker,subs="attributes+"]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Convert charset of MySQL/MariaDB to use utf8mb4. If you are using an older ownCl

== Restore the Table Format

This command sets the default row format of MySQL/MariaDB tables. This is only necessary once before you are going to e.g. install MariaDB 10.6 or higher because the COMPRESSED row format is now read-only by default. As a prerequisite, ownCloud 10.9 needs to be installed first. See the xref:maintenance/upgrading/database_upgrade.adoc[Database Upgrade] guide for details.
This command sets the default row format of MySQL/MariaDB tables. This is only necessary once before you are going to e.g. install MariaDB 10.6 or higher because the COMPRESSED row format is now read-only by default. As a prerequisite, ownCloud Classic 10.9 needs to be installed first. See the xref:maintenance/upgrading/database_upgrade.adoc[Database Upgrade] guide for details.

[source,docker,subs="attributes+"]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ Use `encryption:disable` to disable your encryption module. You must first put y

`encryption:fix-encrypted-version` fixes the encrypted version of files if the encrypted file(s) are not downloadable for a given user. You only need this command if you get an "Invalid Signature" message in the browser or the clients.

Background: the `oc_filecache` database table contains the integer columns "version" and "encryptedVersion" which start with 1 and are incremented on every file modification. When using encryption, those values are used together with the ciphertext to generate a cryptographic signature for the file. The version value is required to verify the signature. In some very rare cases like timeouts or bugs etc., the value might not get updated accordingly or get lost. The brute-force approach is to use the `fix:encrypted:version` command until the file can be decrypted. Starting with ownCloud 10.8, the behavior of the command got improved so that the encryptedVersion value is reset to its original value if no correct version was found. Before that fix, the last tried value was stored in the database thus modifying the state of the system and making further rescue attempts non-deterministic.
Background: the `oc_filecache` database table contains the integer columns "version" and "encryptedVersion" which start with 1 and are incremented on every file modification. When using encryption, those values are used together with the ciphertext to generate a cryptographic signature for the file. The version value is required to verify the signature. In some very rare cases like timeouts or bugs etc., the value might not get updated accordingly or get lost. The brute-force approach is to use the `fix:encrypted:version` command until the file can be decrypted. Starting with ownCloud Classic 10.8, the behavior of the command got improved so that the encryptedVersion value is reset to its original value if no correct version was found. Before that fix, the last tried value was stored in the database thus modifying the state of the system and making further rescue attempts non-deterministic.

=== Arguments

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

== Introduction

Your ownCloud Server has a built-in configuration checker, and it reports its findings at the top of your Admin page. These are some of the warnings you might see, and what to do about them.
Your ownCloud Classic has a built-in configuration checker, and it reports its findings at the top of your Admin page. These are some of the warnings you might see, and what to do about them.

image:security-setup-warning-complete.png[image]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The web UI can be configured for optimal user experience.

=== Hide the Upload Estimation

Note that this setting is available for ownCloud Server only.
Note that this setting is available for ownCloud Classic only.

When uploading a document, an upload estimation (progress bar) is shown like in the example below:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The sections below will explain these areas and provide configuration examples u

For the configuration examples, let's assume we have:

- ownCloud Server available as `+https://cloud.example.com+`
- ownCloud Classic available as `+https://cloud.example.com+`
- Kopano Konnect available as `+https://idp.example.com+`

=== Set Up and Configure Kopano
Expand All @@ -31,9 +31,9 @@ Specifically, you have to:

TIP: Kopano Konnect can be set up via Docker. Images are available on Docker Hub (`kopano/konnectd`).

=== Configure ownCloud Server
=== Configure ownCloud Classic

To set up ownCloud Server to work with OpenID Connect, you have to:
To set up ownCloud Classic to work with OpenID Connect, you have to:

1. Enable the OpenID Connect App
2. Configure via environment variables
Expand All @@ -43,7 +43,7 @@ TIP: It is recommended to first figure out all configurations on a test system a

==== List of OpenID Connect config.php Parameters

Follow this link to read more about the xref:configuration/server/config_apps_sample_php_parameters.adoc#app-openid-connect-oidc[OIDC config.php parameters] available to configure OpenID Connect on ownCloud Server.
Follow this link to read more about the xref:configuration/server/config_apps_sample_php_parameters.adoc#app-openid-connect-oidc[OIDC config.php parameters] available to configure OpenID Connect on ownCloud Classic.

==== Example config.php

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,9 @@ When it comes to use `127.0.0.1` instead of `localhost` as Redirect URI, the tas

image:configuration/user/oidc/ms-azure-ad/ms-azure-manifest.png[width=350]

=== Configure ownCloud Server
=== Configure ownCloud Classic

To set up ownCloud Server to work with OpenID Connect, you have to:
To set up ownCloud Classic to work with OpenID Connect, you have to:

1. Install the {oc-marketplace-url}/apps/openidconnect[OpenID Connect App].
2. Configure `config.php`.
Expand All @@ -96,7 +96,7 @@ TIP: It is recommended to first figure out all configurations on a test system a
==== List of OpenID Connect config.php Parameters

Follow this link to read more about the
xref:configuration/server/config_apps_sample_php_parameters.adoc#app-openid-connect-oidc[OIDC config.php parameters] available to configure OpenID Connect on ownCloud Server.
xref:configuration/server/config_apps_sample_php_parameters.adoc#app-openid-connect-oidc[OIDC config.php parameters] available to configure OpenID Connect on ownCloud Classic.

==== Example config.php Setup

Expand Down Expand Up @@ -145,7 +145,7 @@ If you want to let ownCloud create users which are not present during a OIDC aut

=== Use oAuth2 authentication for ownCloud Desktop and Mobile Clients

To allow the ownCloud clients (ownCloud Web, Desktop, Android and iOS) to interact with the ownCloud Server, you have to install and enable the oAuth2 app. Please see the xref:configuration/server/security/oauth2.adoc[Open Authentication (OAuth2)] for more details. In this setup, your ownCloud Clients will work without extra hassles, but please be advised that the ownCloud Server is acting as identity provider for the clients and you will not be able to delete those clients directly from your identity management solution.
To allow the ownCloud clients (ownCloud Web, Desktop, Android and iOS) to interact with the ownCloud Classic server, you have to install and enable the oAuth2 app. Please see the xref:configuration/server/security/oauth2.adoc[Open Authentication (OAuth2)] for more details. In this setup, your ownCloud Clients will work without extra hassles, but please be advised that the ownCloud Classic server is acting as identity provider for the clients and you will not be able to delete those clients directly from your identity management solution.

=== Register ownCloud Desktop and Mobile Clients with Azure AD

Expand Down
10 changes: 5 additions & 5 deletions modules/admin_manual/pages/configuration/user/oidc/oidc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Click on the xref:attachment$/configuration/user/oidc/OAuth-code-flow-sequence-d

== Supported Identity Providers

ownCloud Server can work with identity providers (IdP) that support OpenID Connect. There are many identity providers available and the OpenID Connect implementations vary a lot in terms of supported features as well as configuration needs.
ownCloud Classic can work with identity providers (IdP) that support OpenID Connect. There are many identity providers available and the OpenID Connect implementations vary a lot in terms of supported features as well as configuration needs.

The currently supported products are

Expand All @@ -45,11 +45,11 @@ Please get in touch with ownCloud Consulting if you need help with a specific id

== Prerequisites

Setting up ownCloud Server to work with OpenID Connect requires a couple of components to work together:
Setting up ownCloud Classic to work with OpenID Connect requires a couple of components to work together:

* An external identity provider configured to work with the ownCloud components
* A distributed memcache setup - such as Redis or Memcached - is required to operate this app. Follow the xref:configuration/server/caching_configuration.adoc[caching documentation] on how to set it up.
* The `OpenID Connect` app enabled on ownCloud Server.
* The `OpenID Connect` app enabled on ownCloud Classic.
* Set the environment variable:
+
--
Expand Down Expand Up @@ -99,7 +99,7 @@ NOTE: Only set either the database or the config.php keys but not both for the O

. Webserver Service Discovery Information
+
In order to allow the ownCloud Clients (Desktop/Android/iOS) to make use of OpenID Connect, the webserver serving ownCloud Server needs to _provide service discovery information_ under the following static path:
In order to allow the ownCloud Clients (Desktop/Android/iOS) to make use of OpenID Connect, the webserver serving ownCloud Classic needs to _provide service discovery information_ under the following static path:
+
[source,url]
----
Expand Down Expand Up @@ -246,7 +246,7 @@ ownCloud desktop and mobile apps come with default `scope` and `prompt` paramete

=== Migrate Clients from Basic Authentication to OIDC

If your users are logged in to their desktop and mobile clients via basic authentication (username/password) against ownCloud Server and you are not using OAuth2 to authorize the ownCloud clients, a migration to OIDC can be conducted as follows:
If your users are logged in to their desktop and mobile clients via basic authentication (username/password) against ownCloud Classic and you are not using OAuth2 to authorize the ownCloud clients, a migration to OIDC can be conducted as follows:

1. Make sure you have a working OIDC configuration based on the above sections.
2. Enable the OpenID Connect App.
Expand Down
Loading