From 33aa6965f6fe423e6731bd7f68d32be0eed9049f Mon Sep 17 00:00:00 2001 From: Klaas Freitag Date: Thu, 10 Jul 2025 15:53:30 +0200 Subject: [PATCH 1/3] Add snippet about data export --- docs/admin/maintenance/dataexport.md | 29 ++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 docs/admin/maintenance/dataexport.md diff --git a/docs/admin/maintenance/dataexport.md b/docs/admin/maintenance/dataexport.md new file mode 100644 index 00000000..99cc06fd --- /dev/null +++ b/docs/admin/maintenance/dataexport.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 5 +id: dataexport +title: "Data Export" +description:: "Information about data export." +--- + +# Data Export + +## Files + +OpenCloud stores files by default in the file system under the path `/var/lib/opencloud/`. Any other path that is local to the server instance running the OpenCloud backend can be configured as alternative path using the environment variable `OC_BASE_DATA_PATH`. + +Files and folders are stored in a folder structure underneath that base path in folder `data/storage/users/`. + +Files are by default stored in the original format and not encrypted. + +## Metadata + +File metadata is stored in the file system with every file. It is either in the extended file attributes (user namespace) or in a separate metadata file. That file is in the [MessagePack](https://msgpack.org) format and can be read with the cli tools for that file type. + +## Configuration + +Configuration files are written as yaml files by default under `$HOME/.config/OpenCloud`. + +## Other + +Other, non file related metadata such as links is also stored under the general data base path, in json format. + From 430d785a0786076912d1ecaf986ec477f88a601b Mon Sep 17 00:00:00 2001 From: Klaas Freitag Date: Fri, 11 Jul 2025 10:38:44 +0200 Subject: [PATCH 2/3] Use CLI instead of cli Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- docs/admin/maintenance/dataexport.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/admin/maintenance/dataexport.md b/docs/admin/maintenance/dataexport.md index 99cc06fd..3db62e77 100644 --- a/docs/admin/maintenance/dataexport.md +++ b/docs/admin/maintenance/dataexport.md @@ -17,7 +17,7 @@ Files are by default stored in the original format and not encrypted. ## Metadata -File metadata is stored in the file system with every file. It is either in the extended file attributes (user namespace) or in a separate metadata file. That file is in the [MessagePack](https://msgpack.org) format and can be read with the cli tools for that file type. +File metadata is stored in the file system with every file. It is either in the extended file attributes (user namespace) or in a separate metadata file. That file is in the [MessagePack](https://msgpack.org) format and can be read with the CLI tools for that file type. ## Configuration From 69d57628ea891f95d8eb2e04a50096170ebee58b Mon Sep 17 00:00:00 2001 From: Klaas Freitag Date: Fri, 11 Jul 2025 10:39:51 +0200 Subject: [PATCH 3/3] Some spell corrections Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- docs/admin/maintenance/dataexport.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/admin/maintenance/dataexport.md b/docs/admin/maintenance/dataexport.md index 3db62e77..31472f83 100644 --- a/docs/admin/maintenance/dataexport.md +++ b/docs/admin/maintenance/dataexport.md @@ -25,5 +25,5 @@ Configuration files are written as yaml files by default under `$HOME/.config/Op ## Other -Other, non file related metadata such as links is also stored under the general data base path, in json format. +Other, non-file-related metadata such as links is also stored under the general data base path, in JSON format.