Skip to content
Open
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
26 changes: 12 additions & 14 deletions docs/user/admin/app-tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 2
id: app-tokens
title: App Tokens
description: App Tokens in OpenCLoud
description: App Tokens in OpenCloud
draft: false
---

Expand All @@ -12,17 +12,15 @@ App Tokens allow you to connect external apps and services (such as WebDAV clien

This improves security in several ways:

- You never need to expose your login password to third party applications
- App tokens can be revoked. If you're ever afraid that your app token has been compromised, just delete it.
- App tokens have a configurable expiry. This prevents unintended attack vectors.
- You never need to expose your login password to third-party applications.
- App tokens can be revoked. If you think one has been compromised, just delete it.
- App tokens have a configurable expiry date. This reduces the risk of misuse.

In addition to improved security, App Tokens also maximize compatibility with third party applications. Many
applications don't support modern login flows like OpenID Connect, but only accept standard logins with a username and
password instead. Your username in combination with any of your App Tokens serves as just that.
In addition to improved security, App Tokens also maximize compatibility with third-party applications. Many applications do not support modern login flows like OpenID Connect, but only accept standard logins with a username and password instead. Your username together with any of your App Tokens works as the login credentials.

:::important
App Tokens allow third party applications to access all your data. Make sure that you create
individual App Tokens per application and use a reasonable expiration period. If you don't want to
App Tokens allow third-party applications to access all your data. Make sure that you create
one App Token per application and use a reasonable expiration period. If you do not want to
expose access to all your data, consider using a public link instead.
:::

Expand All @@ -31,22 +29,22 @@ expose access to all your data, consider using a public link instead.
- Go to the App Tokens section in your OpenCloud account settings.
- Click on “+ New” to create a new token.

<img src={require("./img/app-tokens/create.png").default} alt="Create App Token" width="400"/>
<img src={require("./img/app-tokens/create.png").default} alt="Create App Token" width="1920"/>

- Enter a name for the token (e.g., "WebDAV Client").
- Select an expiration date for added security.
- Click Confirm.
<img src={require("./img/app-tokens/enter-name.png").default} alt="Enter the name an exparation date" width="400"/>
<img src={require("./img/app-tokens/enter-name.png").default} alt="Enter the name and expiration date" width="1920"/>

## Copy the App Token

- Once the token is created, it will be shown only once.
- Copy it immediately and store it in a secure place.

<img src={require("./img/app-tokens/copy-token.png").default} alt="Copy Token" width="400"/>
<img src={require("./img/app-tokens/copy-token.png").default} alt="Copy Token" width="1920"/>

:::note
If you lose the token, you’ll need to delete it and create a new one.
If you lose the token, you need to delete it and create a new one.
:::

## Use the App Token
Expand All @@ -59,7 +57,7 @@ You can now use the token in place of your password when connecting:

:::info
The username is usually the same as the one you use for your regular login.
However, if the Identity Provider is operating in autoprovisioning mode, only the UUID can be used.
However, if the identity provider is operating in autoprovisioning mode, only the UUID can be used.
You can find this UUID in the Preferences overview page.
:::

Expand Down
Binary file modified docs/user/admin/img/app-tokens/copy-token.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user/admin/img/app-tokens/create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user/admin/img/app-tokens/enter-name.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user/admin/img/webdav/preferences.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user/admin/img/webdav/webdav-url.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
64 changes: 24 additions & 40 deletions docs/user/admin/web-dav.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,45 +8,32 @@ draft: false

# Connect to a Space via WebDAV

With WebDAV, you can connect OpenCloud Spaces and Folders as network drives on your device and manage your files directly from your file manager without using the browser.
With WebDAV, you can connect OpenCloud Spaces and folders as network drives on your device and manage your files directly from your file manager without using the browser.

## Prerequisites

- A valid OpenCloud account with WebDAV information enabled in the preferences
- Access to a resource in OpenCloud, either a Space, a Folder or the root of your account
- 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 account settings
- Access to a resource in OpenCloud, either a Space, a folder, or the root of your account
- A WebDAV client, for example built-in OS support or [Mountain Duck](https://mountainduck.io/)
- If your WebDAV client requires it, an App Token
→ [How to create an App Token](./app-tokens)

## Step-by-Step Guide

### Enable WebDAV Info in the UI
### Enable WebDAV info in the UI

To display WebDAV information for your Spaces:
To display WebDAV information for a Space:

- Go to Account Settings
- Enable "Show WebDAV info in details view"
- Open Account Settings.
- Enable "Show WebDAV info in details view".

<img src={require("./img/webdav/preferences.png").default} alt="Enable WebDAV info" width="1920"/>

### Create an App Token (if required)

Some WebDAV clients (especially non-OIDC compatible ones like Mountain Duck) require an App Token for authentication.

:::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#copy-the-app-token)

### Get the WebDAV URL

Open the info panel of the resource you want to access in the OpenCloud Web Interface.
Open the info panel of the Space, folder, or account root you want to access in the OpenCloud web interface.

You’ll see a section labeled WebDAV — copy the full WebDAV URL. It looks like:
You will see a section labeled WebDAV. Copy the full WebDAV URL. It looks like this:

`https://cloud.example.com/remote.php/dav/spaces/12345678-abcd-efgh-ijkl-987654321000/`

Expand All @@ -57,36 +44,33 @@ You’ll see a section labeled WebDAV — copy the full WebDAV URL. It looks lik
Now connect your device using the WebDAV URL:

- Username: your OpenCloud username
- Password: your App Token (or password, if allowed)
- Password: your OpenCloud password or an App Token, depending on your setup

You can use various clients depending on your operating system:

## Windows

- Open File Explorer → Click on “This PC” → Choose “Map network drive”
- Enter the WebDAV URL
- Authenticate with username and App Token
- Open File Explorer.
- Click on "This PC" and choose "Map network drive".
- Enter the WebDAV URL.
- Authenticate with your username and password or App Token.

## macOS

- In Finder, choose “Go” > Connect to Server…”
- Enter the WebDAV URL
- Login with your credentials or App Token
- In Finder, choose "Go" > "Connect to Server...".
- Enter the WebDAV URL.
- Log in with your credentials or App Token.

## Linux

- Use your file manager’s Connect to Server option
- Format the URL as:
- Use your file manager’s "Connect to Server" option.
- Format the URL as:
`davs://cloud.example.com/remote.php/dav/spaces/<SPACE-ID>/`

:::note
Once connected, your Space will behave like a normal folder.
:::

:::note
Once connected, your Space behaves like a normal folder.

- 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
- If your client supports OIDC, you may not need an App Token.
- Use `https://` to ensure secure access.

:::
64 changes: 24 additions & 40 deletions versioned_docs/version-4.0/user/admin/web-dav.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,45 +8,32 @@ draft: false

# Connect to a Space via WebDAV

With WebDAV, you can connect OpenCloud Spaces and Folders as network drives on your device and manage your files directly from your file manager without using the browser.
With WebDAV, you can connect OpenCloud Spaces and folders as network drives on your device and manage your files directly from your file manager without using the browser.

## Prerequisites

- A valid OpenCloud account with WebDAV information enabled in the preferences
- Access to a resource in OpenCloud, either a Space, a Folder or the root of your account
- 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 account settings
- Access to a resource in OpenCloud, either a Space, a folder, or the root of your account
- A WebDAV client, for example built-in OS support or [Mountain Duck](https://mountainduck.io/)
- If your WebDAV client requires it, an App Token
→ [How to create an App Token](./app-tokens)

## Step-by-Step Guide

### Enable WebDAV Info in the UI
### Enable WebDAV info in the UI

To display WebDAV information for your Spaces:
To display WebDAV information for a Space:

- Go to Account Settings
- Enable "Show WebDAV info in details view"
- Open Account Settings.
- Enable "Show WebDAV info in details view".

<img src={require("./img/webdav/preferences.png").default} alt="Enable WebDAV info" width="1920"/>

### Create an App Token (if required)

Some WebDAV clients (especially non-OIDC compatible ones like Mountain Duck) require an App Token for authentication.

:::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)

### Get the WebDAV URL

Open the info panel of the resource you want to access in the OpenCloud Web Interface.
Open the info panel of the Space, folder, or account root you want to access in the OpenCloud web interface.

You’ll see a section labeled WebDAV — copy the full WebDAV URL. It looks like:
You will see a section labeled WebDAV. Copy the full WebDAV URL. It looks like this:

`https://cloud.example.com/remote.php/dav/spaces/12345678-abcd-efgh-ijkl-987654321000/`

Expand All @@ -57,36 +44,33 @@ You’ll see a section labeled WebDAV — copy the full WebDAV URL. It looks lik
Now connect your device using the WebDAV URL:

- Username: your OpenCloud username
- Password: your App Token (or password, if allowed)
- Password: your OpenCloud password or an App Token, depending on your setup

You can use various clients depending on your operating system:

## Windows

- Open File Explorer → Click on “This PC” → Choose “Map network drive”
- Enter the WebDAV URL
- Authenticate with username and App Token
- Open File Explorer.
- Click on "This PC" and choose "Map network drive".
- Enter the WebDAV URL.
- Authenticate with your username and password or App Token.

## macOS

- In Finder, choose “Go” > Connect to Server…”
- Enter the WebDAV URL
- Login with your credentials or App Token
- In Finder, choose "Go" > "Connect to Server...".
- Enter the WebDAV URL.
- Log in with your credentials or App Token.

## Linux

- Use your file manager’s Connect to Server option
- Format the URL as:
- Use your file manager’s "Connect to Server" option.
- Format the URL as:
`davs://cloud.example.com/remote.php/dav/spaces/<SPACE-ID>/`

:::note
Once connected, your Space will behave like a normal folder.
:::

:::note
Once connected, your Space behaves like a normal folder.

- 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
- If your client supports OIDC, you may not need an App Token.
- Use `https://` to ensure secure access.

:::