From 7d1a752b65f9ba0dea09765c9fa01f2ba9fb9195 Mon Sep 17 00:00:00 2001 From: Heiko Pohl Date: Thu, 17 Jul 2025 13:42:04 +0200 Subject: [PATCH 1/2] Rework User Admin Dokus --- docs/user/admin/settings.md | 35 +++++++++++++++++--------------- docs/user/admin/web-dav.md | 40 ++++++++++++++++++++----------------- 2 files changed, 41 insertions(+), 34 deletions(-) diff --git a/docs/user/admin/settings.md b/docs/user/admin/settings.md index 1670e3e5..a73b688c 100644 --- a/docs/user/admin/settings.md +++ b/docs/user/admin/settings.md @@ -9,38 +9,41 @@ draft: false # Admin area overview In the admin area of OpenCloud you have extensive administration options for your organisation. Here are the most important areas: -Admin settings + + Admin settings ## General -- **Overview of edition and version**: - You can view information about the **Edition** and **Version** of your OpenCloud. +- Overview of edition and version: + You can view information about the Edition and Version of your OpenCloud. Admin general ## Users -- **Overview of users**: - Here you have an overview of all **users** of your OpenCloud. -- **Manage users**: +- Overview of users: + Here you have an overview of all users of your OpenCloud. +- Manage users: Depending on your user management settings, you can: - Create or delete users - Edit users (e.g. change rights or settings) - Change quota (storage space) of users - Add or remove users in groups - Allow or prohibit logins (for individual users) Admin users ## Groups -- **Overview of the groups**: - Here you can view the existing **groups** of your OpenCloud. -- **Manage groups**: - You can **create, edit or delete** local groups and add or remove members. -- **Imported groups**: - External groups that have been imported via an external user management system can **not be edited** here. These groups are labeled with a **lock symbol** to indicate that they are locked. +- Overview of the groups: + Here you can view the existing groups of your OpenCloud. +- Manage groups: + You can create, edit or delete local groups and add or remove members. +- Imported groups: + External groups that have been imported via an external user management system can not be edited here. These groups are labeled with a lock symbol to indicate that they are locked. Admin groups ## Spaces -- **Overview of the Spaces**: - Here you can see all existing **Spaces** in your OpenCloud. -- **Space management**: - As an administrator, you have full rights to: - **Edit** - **Deactivate or activate** - **Delete** +- Overview of the Spaces: + Here you can see all existing Spaces in your OpenCloud. +- Space management: + As an administrator, you have full rights to: - Edit - Deactivate or activate - Delete Admin spaces +:::note These admin settings allow you to comprehensively manage and customise your OpenCloud environment! +::: \ No newline at end of file diff --git a/docs/user/admin/web-dav.md b/docs/user/admin/web-dav.md index 91cc8b36..28600359 100644 --- a/docs/user/admin/web-dav.md +++ b/docs/user/admin/web-dav.md @@ -2,13 +2,15 @@ sidebar_position: 3 id: web-dav title: WebDAV +description: Connect to a Space via WebDAV +draft: false --- -# 🌐 Connect to a Space via WebDAV +# Connect to a Space via WebDAV With WebDAV, you can connect OpenCloud Spaces as network drives on your device and manage your files directly from your file manager — without using the browser. -## 🛠️ Prerequisites +## Prerequisites - A valid **OpenCloud account** with WebDAV information enabled in the preferences - Access to a **Space** in OpenCloud @@ -16,29 +18,31 @@ With WebDAV, you can connect OpenCloud Spaces as network drives on your device a - (Optional but recommended) An **App Token** → [How to create an App Token](./app-tokens.md) -## 🔧 Step-by-Step Guide +## Step-by-Step Guide -### 1. Enable WebDAV Info in the UI +### Enable WebDAV Info in the UI To display WebDAV information for your Spaces: -1. Go to **Account Settings** -2. Enable **"Show WebDAV info in details view"** +- Go to **Account Settings** +- Enable **"Show WebDAV info in details view"** -Enable WebDAV info + Enable WebDAV info -### 2. Create an App Token (if required) +### Create an App Token (if required) Some WebDAV clients (especially non-OIDC compatible ones like Mountain Duck) require an App Token for authentication. -> 🔐 We recommend using an App Token instead of your password for better security. +:::note +We recommend using an App Token instead of your password for better security. +::: - Go to **Settings > App Tokens** - Click **"+ New"**, give it a name, and set an expiration date - **Copy the token immediately** – it will only be shown once → [See App Token Guide](./app-tokens.md) -### 3. Get the WebDAV URL +### Get the WebDAV URL Open the **info panel** of your Space in the OpenCloud Web Interface. @@ -48,7 +52,7 @@ You’ll see a section labeled **WebDAV** — copy the full WebDAV URL. It looks WebDAV URL -### 4. Connect via WebDAV +### Connect via WebDAV Now connect your device using the WebDAV URL: @@ -57,30 +61,30 @@ Now connect your device using the WebDAV URL: You can use various clients depending on your operating system: -## 🪟 Windows +## Windows - Open **File Explorer** → Click on **“This PC”** → Choose **“Map network drive”** - Enter the WebDAV URL - Authenticate with username and App Token -## 🍎 macOS +## macOS - In **Finder**, choose **“Go” > “Connect to Server…”** - Enter the WebDAV URL - Login with your credentials or App Token -## 🐧 Linux +## Linux - Use your file manager’s **“Connect to Server”** option - Format the URL as: `davs://cloud.example.com/remote.php/dav/spaces//` -> ✅ Once connected, your Space will behave like a normal folder. - :::note +Once connected, your Space will behave like a normal folder. +::: +:::note - If your WebDAV client supports **OIDC**, you may not need an App Token - Always use `https://` to ensure secure access - App Tokens can be revoked anytime via your account settings - -::: +::: \ No newline at end of file From de2709bf2c58d27a9aa511b605f394d2bb9a18df Mon Sep 17 00:00:00 2001 From: Heiko Pohl Date: Thu, 17 Jul 2025 13:44:30 +0200 Subject: [PATCH 2/2] formater and linter --- docs/user/admin/settings.md | 4 ++-- docs/user/admin/web-dav.md | 38 +++++++++++++++++++------------------ 2 files changed, 22 insertions(+), 20 deletions(-) diff --git a/docs/user/admin/settings.md b/docs/user/admin/settings.md index a73b688c..1bd22f22 100644 --- a/docs/user/admin/settings.md +++ b/docs/user/admin/settings.md @@ -10,7 +10,7 @@ draft: false In the admin area of OpenCloud you have extensive administration options for your organisation. Here are the most important areas: - Admin settings +Admin settings ## General @@ -46,4 +46,4 @@ In the admin area of OpenCloud you have extensive administration options for you :::note These admin settings allow you to comprehensively manage and customise your OpenCloud environment! -::: \ No newline at end of file +::: diff --git a/docs/user/admin/web-dav.md b/docs/user/admin/web-dav.md index 28600359..af297452 100644 --- a/docs/user/admin/web-dav.md +++ b/docs/user/admin/web-dav.md @@ -12,10 +12,10 @@ With WebDAV, you can connect OpenCloud Spaces as network drives on your device a ## Prerequisites -- A valid **OpenCloud account** with WebDAV information enabled in the preferences -- Access to a **Space** in OpenCloud -- A **WebDAV client** (e.g. built-in OS support or [Mountain Duck](https://mountainduck.io/)) -- (Optional but recommended) An **App Token** +- A valid OpenCloud account with WebDAV information enabled in the preferences +- Access to a Space in OpenCloud +- A WebDAV client (e.g. built-in OS support or [Mountain Duck](https://mountainduck.io/)) +- (Optional but recommended) An App Token → [How to create an App Token](./app-tokens.md) ## Step-by-Step Guide @@ -24,8 +24,8 @@ With WebDAV, you can connect OpenCloud Spaces as network drives on your device a To display WebDAV information for your Spaces: -- Go to **Account Settings** -- Enable **"Show WebDAV info in details view"** +- Go to Account Settings +- Enable "Show WebDAV info in details view" Enable WebDAV info @@ -37,16 +37,16 @@ Some WebDAV clients (especially non-OIDC compatible ones like Mountain Duck) req We recommend using an App Token instead of your password for better security. ::: -- Go to **Settings > App Tokens** -- Click **"+ New"**, give it a name, and set an expiration date -- **Copy the token immediately** – it will only be shown once +- Go to Settings > App Tokens +- Click "+ New", give it a name, and set an expiration date +- Copy the token immediately – it will only be shown once → [See App Token Guide](./app-tokens.md) ### Get the WebDAV URL -Open the **info panel** of your Space in the OpenCloud Web Interface. +Open the info panel of your Space in the OpenCloud Web Interface. -You’ll see a section labeled **WebDAV** — copy the full WebDAV URL. It looks like: +You’ll see a section labeled WebDAV — copy the full WebDAV URL. It looks like: `https://cloud.example.com/remote.php/dav/spaces/12345678-abcd-efgh-ijkl-987654321000/` @@ -56,26 +56,26 @@ You’ll see a section labeled **WebDAV** — copy the full WebDAV URL. It looks Now connect your device using the WebDAV URL: -- **Username**: your OpenCloud username -- **Password**: your **App Token** (or password, if allowed) +- Username: your OpenCloud username +- Password: your App Token (or password, if allowed) You can use various clients depending on your operating system: ## Windows -- Open **File Explorer** → Click on **“This PC”** → Choose **“Map network drive”** +- Open File Explorer → Click on “This PC” → Choose “Map network drive” - Enter the WebDAV URL - Authenticate with username and App Token ## macOS -- In **Finder**, choose **“Go” > “Connect to Server…”** +- In Finder, choose “Go” > “Connect to Server…” - Enter the WebDAV URL - Login with your credentials or App Token ## Linux -- Use your file manager’s **“Connect to Server”** option +- Use your file manager’s “Connect to Server” option - Format the URL as: `davs://cloud.example.com/remote.php/dav/spaces//` @@ -84,7 +84,9 @@ Once connected, your Space will behave like a normal folder. ::: :::note -- If your WebDAV client supports **OIDC**, you may not need an App Token + +- If your WebDAV client supports OIDC, you may not need an App Token - Always use `https://` to ensure secure access - App Tokens can be revoked anytime via your account settings -::: \ No newline at end of file + + :::