OpenCloud

https://docs.opencloud.eu
Admin
OpenCloud is an open-source, cloud-native file sharing and collaboration platform designed for...
Tokens:177,170
Snippets:2,428
Trust Score:7.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Docker

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/raspberry-pi

Use the official convenience script to install Docker.

```bash
curl -fsSL test.docker.com -o get-docker.sh && sh get-docker.sh
```

--------------------------------

### Install Git

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/bare-metal

Installs the Git version control system.

```bash
sudo apt install git
```

--------------------------------

### Global Configuration Example

Source: https://docs.opencloud.eu/docs/dev/server/configuration/config-system

Example of a global configuration file defining secrets and service-specific settings.

```yaml
# /etc/opencloud/opencloud.yaml  

# Global OpenCloud configuration defaults  

token_manager:  

  jwt_secret: 'x8Kz$3vQw9!Rb7#NfU2^BgT%Lp1@Hm0'  

machine_auth_api_key: 'X7gH2k9Vb4q!S6dP'  

system_user_api_key: 'mS9#cR4pZx7%aL1t'  

transfer_secret: 'Tq6!vB2^nY8@wF5z'  

url_signing_secret: 'U9p$R0e!K3#sH7cQ'  

system_user_id: d3b1f5a2-7c9d-4e2f-a1b2-3c4d5e6f7a8b  

admin_user_id: a1f2e3d4-5b6c-7d8e-9f01-23456789abcd  

## Service-specific configurations, same as in <service-name>.yaml files  

graph:  

  application:  

    id: a72387e1-fb22-49c9-9c94-12ff0abf9b38  

  events:  

    tls_insecure: true  

  spaces:  

    insecure: true  
```

--------------------------------

### PROPFIND Request Example

Source: https://docs.opencloud.eu/docs/dev/server/apis/http/webdav

Example of a PROPFIND request body with declared namespaces.

```xml
<?xml version="1.0"?>  

    <d:propfind xmlns:d="DAV:" xmlns:oc="http://owncloud.org/ns">  

    </d:propfind>
```

--------------------------------

### Unified Roles CLI Output Example

Source: https://docs.opencloud.eu/docs/dev/server/services/graph/information

Example output showing the structure of role information including UID, enabled status, and allowed resource actions.

```text
+--------------------------------------+----------+--------------------------------+--------------------------------+------------------------------------------+  
|                 UID                  | ENABLED  |          DESCRIPTION           |           CONDITION            |         ALLOWED RESOURCE ACTIONS         |
+--------------------------------------+----------+--------------------------------+--------------------------------+------------------------------------------+  
| a8d5fe5e-96e3-418d-825b-534dbdf22b99 | enabled  | View and download.             | exists @Resource.Root          | libre.graph/driveItem/path/read          |
|                                      |          |                                |                                | libre.graph/driveItem/quota/read         |
|                                      |          |                                |                                | libre.graph/driveItem/content/read       |
|                                      |          |                                |                                | libre.graph/driveItem/permissions/read   |
|                                      |          |                                |                                | libre.graph/driveItem/children/read      |
|                                      |          |                                |                                | libre.graph/driveItem/deleted/read       |
|                                      |          |                                |                                | libre.graph/driveItem/basic/read         |
+--------------------------------------+----------+--------------------------------+--------------------------------+------------------------------------------+
```

--------------------------------

### Start Server

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/bare-metal

Launches the OpenCloud server process.

```bash
./bin/opencloud server
```

--------------------------------

### Start Services with Decomposeds3 Configuration

Source: https://docs.opencloud.eu/docs/admin/configuration/storage/storage-decomposeds3

Include the decomposeds3 configuration file when starting the Docker containers.

```bash
docker compose -f docker-compose.yml -f storage/decomposeds3.yml up  
```

--------------------------------

### Install OpenCloud via Shell Script

Source: https://docs.opencloud.eu/docs/admin

Executes the automated installation script for OpenCloud. Requires root or sudo privileges to perform system-level setup.

```bash
curl -L https://opencloud.eu/install | /bin/bash
```

--------------------------------

### Enable and Start Docker Service

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/docker-compose-base

Configure the Docker service to start automatically on boot and initiate the service immediately.

```bash
systemctl enable docker && systemctl start docker
```

--------------------------------

### Service-Specific Configuration Example

Source: https://docs.opencloud.eu/docs/dev/server/configuration/config-system

Example of a service-specific configuration file for the proxy service.

```yaml
# /etc/opencloud/proxy.yaml  

role_assignment:  

  driver: oidc  

  oidc_role_mapper:  

    role_claim: opencloudRoles  

    role_mapping:  

      - role_name: admin  

        claim_value: myAdminRole  

      - role_name: spaceadmin  

        claim_value: mySpaceAdminRole  

      - role_name: user  

        claim_value: myUserRole  

      - role_name: user-light  

        claim_value: myGuestRole  
```

--------------------------------

### Start OpenCloud

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/raspberry-pi

Launch the OpenCloud services using Docker Compose.

```bash
docker compose up
```

--------------------------------

### Install npm

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/bare-metal

Installs the Node Package Manager.

```bash
sudo apt install npm -y
```

--------------------------------

### Example Directory Listing

Source: https://docs.opencloud.eu/docs/admin/maintenance/upgrade/upgrade-guide

Sample output of the directory contents after generating the patch.

```text
banned-password-list.txt

csp.yaml

opencloud.config.patch

opencloud.yaml

opencloud.yaml.2026-05-19-15-45-44.backup
```

--------------------------------

### Compare Descriptive Filenames

Source: https://docs.opencloud.eu/docs/user/spaces/best-practice

Examples demonstrating the difference between a generic filename and a descriptive one.

```text
contract.pdf
```

```text
Acme - Service Agreement - 2026.pdf
```

--------------------------------

### Example rclone Configuration

Source: https://docs.opencloud.eu/docs/admin/maintenance/migrate

Sample configuration entries for various webdav providers.

```ini
[opencloud-admin]
type = webdav
url = https://opencloud_url/remote.php/webdav
vendor = opencloud
owncloud_exclude_shares = true
user = admin
pass = sQOM4mn2DdR9ihRGkyAMcd50W6mniaSqSfx2qVOdBJs
description = opencloud-admin

[opencloud-alan]
type = webdav
url = https://opencloud_url/remote.php/webdav
vendor = opencloud
owncloud_exclude_shares = true
user = alan
pass = sQOM4mn2DdR9ihRGkyAMcd50W6mniaSqSfx2qVOdBJs
description = opencloud-alan

[ocis-admin]
type = webdav
url = https://ocis_url/remote.php/webdav
vendor = ocis
owncloud_exclude_shares = true
user = admin
pass = Sav5354nRTgBHyItQeCZp9tCBidX2BxbuMx_dDLwxqs
description = ocis-admin

[ocis-einstein]
type = webdav
url = https://ocis_url/remote.php/webdav
vendor = ocis-einstein
owncloud_exclude_shares = true
user = einstein
pass = dcYsf3PNvBxaIi7MMq-bqg74KMWWWS8p3uFT-WD17SA
description = ocis-einstein

[nc-admin]
type = webdav
url = http://nc_url/remote.php/webdav
vendor = nc
owncloud_exclude_shares = true
user = admin
pass = IBSkhC1wCDdS2Gt9iBV-C9IqlGek
description = nc-admin

[nc-bob]
type = webdav
url = http://localhost:8080/remote.php/webdav
vendor = nc-bob
owncloud_exclude_shares = true
user = bob
pass = ufOK3zPDjR4meEwwy3cWUVA18Lf8TpubBRyPL5m9KC508PkMiEVAXTxg6olu
description = nc-bob
```

--------------------------------

### Initialize environment configuration

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/raspberry-pi

Navigate to the directory and prepare the environment file.

```bash
cd opencloud-compose
```

```bash
cp .env.example .env
```

```bash
nano .env
```

--------------------------------

### GET /v1.0/extensions/org.libregraph/tags

Source: https://docs.opencloud.eu/swagger/libre-graph-api

Get all known tags.

```APIDOC
## GET /v1.0/extensions/org.libregraph/tags

### Description
Get all known tags.

### Method
GET

### Endpoint
/v1.0/extensions/org.libregraph/tags
```

--------------------------------

### GET /v1.0/education/schools

Source: https://docs.opencloud.eu/swagger/libre-graph-api

Get a list of schools and their properties.

```APIDOC
## GET /v1.0/education/schools

### Description
Get a list of schools and their properties.

### Method
GET

### Endpoint
/v1.0/education/schools
```

--------------------------------

### Clone and Prepare OpenCloud Repository

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/external-proxy

Initialize the project directory and create the environment configuration file.

```bash
git clone https://github.com/opencloud-eu/opencloud-compose.git
cd opencloud-compose
cp .env.example .env
nano .env
```

--------------------------------

### Create Environment File

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/docker-compose-base

Initialize the .env file using the provided template.

```bash
cp .env.example .env
```

--------------------------------

### GET /v1.0/education/users/{user-id}

Source: https://docs.opencloud.eu/swagger/libre-graph-api

Get properties of a specific education user.

```APIDOC
## GET /v1.0/education/users/{user-id}

### Description
Get properties of a specific education user.

### Method
GET

### Endpoint
/v1.0/education/users/{user-id}

### Parameters
#### Path Parameters
- **user-id** (string) - Required - The unique identifier of the user.
```

--------------------------------

### Configuration Diff Output Example

Source: https://docs.opencloud.eu/docs/admin/maintenance/upgrade/upgrade-4.0.x

Sample output showing the result of the configuration diff command.

```text
opencloud init --diff

Do you want to configure OpenCloud with certificate checking disabled?

 This is not recommended for public instances! [yes | no = default] yes

running in diff mode

diff -u /etc/opencloud/opencloud.yaml /etc/opencloud/opencloud.yaml.tmp

--- /etc/opencloud/opencloud.yaml

+++ /etc/opencloud/opencloud.yaml.tmp

@@ -3,6 +3,7 @@

 machine_auth_api_key: k55Y7i3Djeeu4aPPNzM67Q39rf3ZHz^9

 system_user_api_key: GeTXN@Mj7-4n8Yhuwb&#oq8Gb1hF7Q%^

 transfer_secret: ANy#T5.IvknED9-Ud39+YmlXzN^TdaKi

+url_signing_secret: zB#FtAYid24Z^DkuBoTllnId=igo!tCO

 system_user_id: 8cc36d34-cd87-4434-b9e2-726e5553609c

 admin_user_id: 34a73600-a02c-4064-8aec-341cd1865a71

 graph:

  

diff written to /etc/opencloud/opencloud.config.patch
```

--------------------------------

### Install Corepack

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/bare-metal

Installs corepack globally to manage package managers.

```bash
sudo npm install -g corepack
```

--------------------------------

### Create Required Directories

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker

Prepare the host directories for bind mounts to persist configuration and data.

```bash
mkdir -p $HOME/opencloud/opencloud-config  

mkdir -p $HOME/opencloud/opencloud-data  
```

--------------------------------

### Install libvips dependencies on macOS

Source: https://docs.opencloud.eu/docs/dev/server/services/thumbnails/information

Install required build dependencies for libvips on macOS systems.

```bash
brew install vips pkg-config  

export PKG_CONFIG_PATH="/usr/local/opt/libffi/lib/pkgconfig"  
```

--------------------------------

### WebDAV Error Response Examples

Source: https://docs.opencloud.eu/docs/dev/server/apis/http/webdav

Examples of error responses for bad requests and missing resources.

```xml
<?xml version="1.0" encoding="UTF-8"?>  

<d:error xmlns:d="DAV" xmlns:s="http://sabredav.org/ns">  

    <s:exception>Sabre\DAV\Exception\BadRequest</s:exception>  

    <s:message>Invalid Depth header value: 3</s:message>  

</d:error>
```

```xml
<?xml version="1.0" encoding="UTF-8"?>  

<d:error xmlns:d="DAV" xmlns:s="http://sabredav.org/ns">  

    <s:exception>Sabre\DAV\Exception\NotFound</s:exception>  

    <s:message>Resource not found</s:message>  

</d:error>
```

--------------------------------

### Listing Properties with PROPFIND

Source: https://docs.opencloud.eu/docs/dev/server/apis/http/webdav

Use these examples to retrieve resource properties or directory listings via WebDAV.

```bash
curl -L -X PROPFIND 'https://localhost:9200/dav/spaces/storage-users-1%24some-admin-user-id-0000-000000000000/' \

-H 'Depth: 1' \

-d '<?xml version="1.0"?>

<d:propfind  xmlns:d="DAV:" xmlns:oc="http://owncloud.org/ns">

  <d:prop>

    <oc:permissions />

    <oc:favorite />

    <oc:fileid />

    <oc:owner-id />

    <oc:owner-display-name />

    <oc:share-types />

    <oc:privatelink />

    <d:getcontentlength />

    <oc:size />

    <d:getlastmodified />

    <d:getetag />

    <d:getcontenttype />

    <d:resourcetype />

    <oc:downloadURL />

  </d:prop>

</d:propfind>'
```

```http
PROPFIND /dav/spaces/storage-users-1%24some-admin-user-id-0000-000000000000/ HTTP/1.1

Host: localhost:9200

Origin: https://localhost

Access-Control-Request-Method: PROPFIND

Depth: 1

Content-Type: application/xml

Authorization: Basic YWRtaW46YWRtaW4=

Content-Length: 436


<?xml version="1.0"?>

<d:propfind  xmlns:d="DAV:" xmlns:oc="http://owncloud.org/ns">

  <d:prop>

    <oc:permissions />

    <oc:favorite />

    <oc:fileid />

    <oc:owner-id />

    <oc:owner-display-name />

    <oc:share-types />

    <oc:privatelink />

    <d:getcontentlength />

    <oc:size />

    <d:getlastmodified />

    <d:getetag />

    <d:getcontenttype />

    <d:resourcetype />

    <oc:downloadURL />

  </d:prop>

</d:propfind>
```

--------------------------------

### Bundle web frontend

Source: https://docs.opencloud.eu/docs/dev/web/testing/running-tests

Prepares the web frontend for end-to-end testing, as the development server is not used.

```bash
pnpm build:w
```

--------------------------------

### Install Microsoft Core Fonts

Source: https://docs.opencloud.eu/docs/admin/configuration/collabora/collabora-fonts

Install the ttf-mscorefonts-installer package to add common fonts like Arial.

```bash
apt install ttf-mscorefonts-installer
```

--------------------------------

### Install for standalone Vue applications

Source: https://docs.opencloud.eu/design-system/gettingStarted/installation.html

Install the design system package for use in standalone Vue projects.

```shell
$ npm install @opencloud-eu/design-system

$ pnpm add @opencloud-eu/design-system

$ yarn add @opencloud-eu/design-system
```

--------------------------------

### WebDAV Multistatus Response Example

Source: https://docs.opencloud.eu/docs/dev/server/apis/http/webdav

Example of a d:multistatus response containing file properties and status codes.

```xml
<oc:checksum>SHA1:1c68ea370b40c06fcaf7f26c8b1dba9d9caf5dea MD5:2205e48de5f93c784733ffcca841d2b5 ADLER32:058801ab</oc:checksum>  

                </oc:checksums>  

                <oc:favorite>0</oc:favorite>  

                <oc:fileid>storage-users-1$some-admin-user-id-0000-000000000000!90cc3e73-0c6c-4346-9c4d-f529976d4990</oc:fileid>  

                <oc:id>storage-users-1$some-admin-user-id-0000-000000000000!90cc3e73-0c6c-4346-9c4d-f529976d4990</oc:id>  

                <oc:owner-id>admin</oc:owner-id>  

                <oc:owner-display-name>Admin</oc:owner-display-name>  

                <oc:share-types>  

                    <oc:share-type>0</oc:share-type>  

                    <oc:share-type>1</oc:share-type>  

                    <oc:share-type>3</oc:share-type>  

                </oc:share-types>  

                <oc:privatelink>https://localhost:9200/f/storage-users-1$some-admin-user-id-0000-000000000000%2190cc3e73-0c6c-4346-9c4d-f529976d4990</oc:privatelink>  

                <d:getcontentlength>5</d:getcontentlength>  

                <oc:size>5</oc:size>  

                <d:getlastmodified>Mon, 28 Aug 2023 20:45:03 GMT</d:getlastmodified>  

                <d:getetag>"75115347c74701a3be9c635ddebbf5c4"</d:getetag>  

                <d:getcontenttype>text/plain</d:getcontenttype>  

                <d:resourcetype></d:resourcetype>  

            </d:prop>  

            <d:status>HTTP/1.1 200 OK</d:status>  

        </d:propstat>  

    </d:response>  

    <d:response>  

        <d:href>/dav/spaces/storage-users-1$some-admin-user-id-0000-000000000000/NewFolder/</d:href>  

        <d:propstat>  

            <d:prop>  

                <oc:permissions>RDNVCKZP</oc:permissions>  

                <oc:favorite>0</oc:favorite>  

                <oc:fileid>storage-users-1$some-admin-user-id-0000-000000000000!5c73ecd9-d9f4-44f4-b685-ca4cb40aa6b7</oc:fileid>  

                <oc:id>storage-users-1$some-admin-user-id-0000-000000000000!5c73ecd9-d9f4-44f4-b685-ca4cb40aa6b7</oc:id>  

                <oc:owner-id>admin</oc:owner-id>  

                <oc:owner-display-name>Admin</oc:owner-display-name>  

                <oc:privatelink>https://localhost:9200/f/storage-users-1$some-admin-user-id-0000-000000000000%215c73ecd9-d9f4-44f4-b685-ca4cb40aa6b7</oc:privatelink>  

                <oc:size>0</oc:size>  

                <d:getlastmodified>Mon, 28 Aug 2023 20:45:10 GMT</d:getlastmodified>  

                <d:getetag>"e83367534cc595a45d706857fa5f03d8"</d:getetag>  

                <d:resourcetype>  

                    <d:collection/>  

                </d:resourcetype>  

            </d:prop>  

            <d:status>HTTP/1.1 200 OK</d:status>  

        </d:propstat>  

        <d:propstat>  

            <d:prop>  

                <oc:checksums></oc:checksums>  

                <oc:share-types></oc:share-types>  

                <d:getcontentlength></d:getcontentlength>  

                <d:getcontenttype></d:getcontenttype>  

            </d:prop>  

            <d:status>HTTP/1.1 404 Not Found</d:status>  

        </d:propstat>  

    </d:response>  

</d:multistatus>
```

--------------------------------

### Install as dev dependency for OpenCloud Web

Source: https://docs.opencloud.eu/design-system/gettingStarted/installation.html

Install the design system as a development dependency to enable type support and helper functions in OpenCloud Web apps.

```shell
$ npm install @opencloud-eu/design-system --save-dev

$ pnpm add @opencloud-eu/design-system -D

$ yarn add @opencloud-eu/design-system -D
```

--------------------------------

### Deploy OpenCloud with Docker

Source: https://docs.opencloud.eu/docs/admin/maintenance/upgrade/upgrade-4.0.x

Starts the OpenCloud container with necessary volume mounts and environment variables.

```bash
docker run \
    --name opencloud \
    --rm \
    -d \
    -p 9200:9200 \
    -v $HOME/opencloud/opencloud-config:/etc/opencloud \
    -v $HOME/opencloud/opencloud-data:/var/lib/opencloud \
    -e OC_INSECURE=true \
    -e PROXY_HTTP_ADDR=0.0.0.0:9200 \
    -e OC_URL=https://localhost:9200 \
    opencloudeu/opencloud:4.0.x
```

--------------------------------

### Set recommended host directory permissions

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/docker-compose-volume-permissions

Create directories and assign ownership to UID/GID 1000 for standard Docker setups.

```bash
sudo mkdir -p /your/local/path/opencloud/{config,data}  

sudo chown -R 1000:1000 /your/local/path/opencloud  

sudo chmod -R 0700 /your/local/path/opencloud  
```

--------------------------------

### GET /me/drives

Source: https://docs.opencloud.eu/docs/dev/server/apis/http/graph/spaces

List My Spaces.

```APIDOC
## GET /me/drives

### Description
List My Spaces.

### Method
GET

### Endpoint
/me/drives
```

--------------------------------

### Implement Flat Folder Structures with Descriptive Filenames

Source: https://docs.opencloud.eu/docs/user/spaces/best-practice

Recommended approach using a flatter hierarchy and descriptive filenames to preserve context.

```text
Customers/  

└── Acme/  

    └── Contracts/  

        └── Acme - Service Agreement - 2026.pdf  
```

--------------------------------

### GET /drives

Source: https://docs.opencloud.eu/docs/dev/server/apis/http/graph/spaces

List all spaces.

```APIDOC
## GET /drives

### Description
List all spaces.

### Method
GET

### Endpoint
/drives
```

--------------------------------

### Create Backup Directory

Source: https://docs.opencloud.eu/docs/admin/maintenance/upgrade/upgrade-4.0.x

Prepare a local directory to store container data backups.

```bash
mkdir -p ~/opencloud-backups  
```

--------------------------------

### Initialize OpenCloud

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker

Perform the first-time setup to initialize the environment. The admin password can be customized via the IDM_ADMIN_PASSWORD environment variable.

```bash
docker run --rm -it \  

    -v $HOME/opencloud/opencloud-config:/etc/opencloud \  

    -v $HOME/opencloud/opencloud-data:/var/lib/opencloud \  

    -e IDM_ADMIN_PASSWORD=admin \  

    opencloudeu/opencloud-rolling:latest init  
```

--------------------------------

### GET /v1.0/education/classes

Source: https://docs.opencloud.eu/swagger/libre-graph-api

List education classes.

```APIDOC
## GET /v1.0/education/classes

### Description
List education classes.

### Method
GET

### Endpoint
/v1.0/education/classes
```

--------------------------------

### Initialize OpenCloud

Source: https://docs.opencloud.eu/docs/admin/getting-started/other/bare-metal

Initializes the server with insecure mode enabled and sets the admin password.

```bash
./bin/opencloud init --insecure true --admin-password admin
```

--------------------------------

### GET /groups

Source: https://docs.opencloud.eu/docs/dev/server/apis/http/graph/groups

Returns a list of all groups.

```APIDOC
## GET /groups

### Description
Returns a list of all groups.

### Method
GET

### Endpoint
/groups

### Response
#### Success Response (200)
- **value** (array) - List of group objects
```

--------------------------------

### Backup Bind Mounts

Source: https://docs.opencloud.eu/docs/admin/maintenance/upgrade/upgrade-4.0.x

Create copies of host directories used for configuration and data storage.

```bash
cp -a /mnt/opencloud/config /mnt/opencloud/config-backup  

cp -a /mnt/opencloud/data /mnt/opencloud/data-backup  
```

--------------------------------

### GET /v1.0/education/users

Source: https://docs.opencloud.eu/swagger/libre-graph-api

Retrieves a list of education users.

```APIDOC
## GET /v1.0/education/users

### Description
Retrieves a list of education users.

### Method
GET

### Endpoint
/v1.0/education/users
```

--------------------------------

### GET /v1beta1/roleManagement/permissions/roleDefinitions

Source: https://docs.opencloud.eu/docs/dev/server/apis/http/graph/role

Lists the available role definitions.

```APIDOC
## GET /v1beta1/roleManagement/permissions/roleDefinitions

### Description
List all available role definitions.

### Method
GET

### Endpoint
/v1beta1/roleManagement/permissions/roleDefinitions
```

--------------------------------

### Enable notifications service

Source: https://docs.opencloud.eu/docs/admin/configuration/mail-notifications

Add the notifications service to the startup configuration in the .env file.

```text
START_ADDITIONAL_SERVICES="notifications"
```

--------------------------------

### Create Certbot Webroot Directory

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/external-proxy

Prepare the directory structure required for the Certbot webroot challenge.

```bash
sudo mkdir -p /var/www/certbot  

sudo chown -R www-data:www-data /var/www/certbot  
```

--------------------------------

### Configure DATA_CALENDAR_FROM_YEAR

Source: https://docs.opencloud.eu/cdperf/k6-tests/src/values/env

Sets the starting year for the calendar.

```bash
export DATA_CALENDAR_FROM_YEAR=2000
```

--------------------------------

### GET /v1.0/me

Source: https://docs.opencloud.eu/swagger/libre-graph-api

Retrieves information about the currently authenticated user.

```APIDOC
## GET /v1.0/me

### Description
Get current user information.

### Method
GET

### Endpoint
/v1.0/me
```

--------------------------------

### Navigate to Configuration Folder

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/docker-compose-base

Change the current directory to the cloned repository folder.

```bash
cd opencloud-compose
```

--------------------------------

### GET /auth-app/tokens

Source: https://docs.opencloud.eu/docs/dev/server/services/auth-app/information

Lists all application tokens associated with the user.

```APIDOC
## GET /auth-app/tokens

### Description
Retrieves a list of all application tokens for the user. Note that the returned token field is the UUID, not the secret token.

### Method
GET

### Endpoint
https://<your host:9200>/auth-app/tokens

### Response
#### Success Response (200)
- **token** (string) - The UUID of the token
- **expiration_date** (string) - Token expiration timestamp
- **created_date** (string) - Token creation timestamp
- **label** (string) - Description of the token
```

--------------------------------

### GET /drives/{drive-id}/root/permissions

Source: https://docs.opencloud.eu/docs/dev/server/apis/http/graph/spaces

List permissions of a space.

```APIDOC
## GET /drives/{drive-id}/root/permissions

### Description
List permissions of a space.

### Method
GET

### Endpoint
/drives/{drive-id}/root/permissions

### Parameters
#### Path Parameters
- **drive-id** (string) - Required - The ID of the drive.
```

--------------------------------

### Provision Test Users

Source: https://docs.opencloud.eu/cdperf/k6-tests/docs

Initializes the test environment by creating a specified number of users. Errors may occur for existing users, but new users will be created successfully.

```shell
ADMIN_LOGIN=admin \
ADMIN_PASSWORD=admin \
PLATFORM_BASE_URL=https://localhost:9200 \
SEED_USERS_TOTAL=75 \
AUTH_N_PROVIDER_KOPANO_BASE_URL=https://localhost:9200 \
AUTH_N_PROVIDER_KOPANO_REDIRECT_URL=https://localhost:9200/oidc-callback.html \
k6 run packages/k6-tests/artifacts/_seeds-up-k6.js
```

--------------------------------

### GET /groups/{groupid}

Source: https://docs.opencloud.eu/docs/dev/server/apis/http/graph/groups

Retrieves details for a specific group.

```APIDOC
## GET /groups/{groupid}

### Description
Retrieves details for a specific group.

### Method
GET

### Endpoint
/groups/{groupid}

### Parameters
#### Path Parameters
- **groupid** (string) - Required - The unique identifier of the group
```

--------------------------------

### Generate Configuration Diff

Source: https://docs.opencloud.eu/docs/admin/maintenance/upgrade/upgrade-guide

Run the initialization command inside the container to identify necessary configuration updates.

```bash
opencloud init --diff
```

--------------------------------

### GET /me/drives

Source: https://docs.opencloud.eu/docs/dev/server/apis/http/graph/spaces

Lists spaces where the acting user is a regular member.

```APIDOC
## GET /me/drives

### Description
List spaces where the acting user is a regular member.

### Method
GET

### Endpoint
/me/drives
```

--------------------------------

### Identify permission denied errors

Source: https://docs.opencloud.eu/docs/admin/resources/common-issues

Example log output indicating a failure to create a storage directory due to insufficient permissions.

```text
opencloud-1 | {"level":"fatal","service":"nats","time":"2025-04-08T09:59:59Z","line":"github.com/opencloud-eu/opencloud/services/nats/pkg/logging/nats.go:33","message":"Can't start JetStream: could not create storage directory - mkdir /var/lib/opencloud/nats: permission denied"}  
```

--------------------------------

### GET /drives

Source: https://docs.opencloud.eu/docs/dev/server/apis/http/graph/spaces

Lists all available spaces, requiring elevated permissions.

```APIDOC
## GET /drives

### Description
Returns a list of all available spaces, even ones where the acting user is not a regular member. Requires elevated permissions.

### Method
GET

### Endpoint
/drives
```

--------------------------------

### Environment Variable Configuration

Source: https://docs.opencloud.eu/docs/dev/server/configuration/config-system

Examples of setting global and service-specific environment variables to override configuration files.

```bash
# Raise log level globally for all services  

export OC_LOG_LEVEL=debug  

  

# Override only the Proxy service log level  

export PROXY_LOG_LEVEL=info  

  

# Make public shares not require a password globally  

export OC_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD=false  
```

--------------------------------

### GET /me

Source: https://docs.opencloud.eu/docs/dev/server/apis/http/graph/users

Returns the user object of the currently signed-in user.

```APIDOC
## GET /me

### Description
Returns the user object of the currently signed-in user.

### Method
GET

### Endpoint
/me

### Response
#### Success Response (200)
- **displayName** (string) - The full name of the user
- **id** (string) - Unique stable identifier
- **mail** (string) - User's email address
- **onPremisesSamAccountName** (string) - Login name of the user

#### Response Example
{
  "displayName": "Dennis Ritchie",
  "id": "4c510ada-c86b-4815-8820-42cdf82c3d51",
  "mail": "dennis@example.org",
  "onPremisesSamAccountName": "dennis"
}
```

--------------------------------

### Configure directory permissions

Source: https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose/docker-compose-production-considerations

Create local directories and set ownership/permissions for the container user (UID/GID 1000).

```bash
sudo mkdir -p /your/local/path/opencloud/{config,data}

sudo chown -R 1000:1000 /your/local/path/opencloud

sudo chmod -R 0700 /your/local/path/opencloud
```
Tokens:
Raw