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
69 changes: 26 additions & 43 deletions docs/user/desktop-client/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,64 +6,47 @@ description: Install OpenCloud Client
draft: false
---

# 🖥️ Install OpenCloud Desktop
# Install OpenCloud Desktop

The OpenCloud Desktop client is available for **Windows**, **macOS**, and **Linux**. Choose your operating system below and follow the installation steps.
The OpenCloud Desktop client is available for Windows, macOS, and Linux. Choose your operating system below and follow the installation steps.

## 🪟 Windows Installation (Microsoft Store)
## Windows Installation (Microsoft Store)

### Step 1
- Open the Microsoft Store and search for OpenCloud Desktop or click on the image below
<a href="https://apps.microsoft.com/detail/9pbx43hcmldq?mode=direct">
<img alt="Download from Microsoft Store" src="https://get.microsoft.com/images/en-us%20dark.svg" width="200"/>
</a>

Open the **Microsoft Store** and search for **OpenCloud Desktop** or click on the image below
<a href="https://apps.microsoft.com/detail/9pbx43hcmldq?mode=direct">
<img alt="Download from Microsoft Store" src="https://get.microsoft.com/images/en-us%20dark.svg" width="200"/>
</a>
- Click Install

### Step 2
- Once installed, launch the app from your Start Menu

Click **Install**
:::note
Installing from the Microsoft Store ensures automatic updates and tight system integration.
:::

### Step 3
## macOS Installation (.pkg file)

Once installed, launch the app from your Start Menu
- Download the latest or preferred `.pkg` file for macOS from the [GitHub repository](https://github.com/opencloud-eu/desktop/releases)

> ℹ️ Installing from the Microsoft Store ensures automatic updates and tight system integration.
- Double-click the downloaded file to start the installer

## 🍎 macOS Installation (.pkg file)
- Follow the on-screen instructions to complete the installation

### Step 1
- After installation, launch OpenCloud Desktop from the Applications folder or Launchpad

Download the latest or preferred `.pkg` file for macOS from the [GitHub repository](https://github.com/opencloud-eu/desktop/releases)
## Linux Installation (AppImage)

### Step 2
We recommend using AppImageLauncher to manage AppImages conveniently and to ensure proper system integration.

Double-click the downloaded file to start the installer

### Step 3

Follow the on-screen instructions to complete the installation

### Step 4

After installation, launch **OpenCloud Desktop** from the **Applications** folder or **Launchpad**

## 🐧 Linux Installation (AppImage)

We recommend using **AppImageLauncher** to manage AppImages conveniently and to ensure proper system integration.

### Step 1

Download the latest or wanted `.AppImage` version of OpenCloud Desktop from the [GitHub repository](https://github.com/opencloud-eu/desktop/releases).

### Step 2

AppImageLauncher automatically integrates AppImages into your system menu.

👉 Follow the installation instructions here:
[AppImageLauncher Installation Guide](https://github.com/TheAssassin/AppImageLauncher#installation)

### Step 3
- Download the latest or wanted `.AppImage` version of OpenCloud Desktop from the [GitHub repository](https://github.com/opencloud-eu/desktop/releases).

- AppImageLauncher automatically integrates AppImages into your system menu.
- Right-click the downloaded `OpenCloud.AppImage` file and choose `Open with AppImageLauncher`.
- Confirm when AppImageLauncher prompts you to integrate the app.
- OpenCloud Desktop will now be available in your application menu like any other app

:::note
Follow the installation instructions here:
[AppImageLauncher Installation Guide](https://github.com/TheAssassin/AppImageLauncher#installation)
:::
40 changes: 22 additions & 18 deletions docs/user/desktop-client/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,46 +12,50 @@ If you need to generate logs for troubleshooting, follow these steps:

## Access Log Settings

- Click on **Settings → Advanced → Log Settings**
- Click on Settings → Advanced → Log Settings

<img src={require("./img/logging/logging-access.png").default} alt="Logging access" width="400"/>
<img src={require("./img/logging/logging-access.png").default} alt="Logging access" width="400"/>

## Enable Logging

- In the **Log Output** window, check the box for **Enable logging to temporary folder**
- To help the Support-Team and the developers, it is helpful to enable the **Log Http traffic**
- In the Log Output window, check the box for Enable logging to temporary folder
- To help the Support-Team and the developers, it is helpful to enable the Log Http traffic

<img src={require("./img/logging/logging-enable.png").default} alt="Enable logging" width="400"/>
<img src={require("./img/logging/logging-enable.png").default} alt="Enable logging" width="400"/>

## Find the Log Files

- Click **Open folder** to access the logs.
- Click Open folder to access the logs.

<img src={require("./img/logging/logging-open-folder.png").default} alt="Open logfile folder" width="400"/>
<img src={require("./img/logging/logging-open-folder.png").default} alt="Open logfile folder" width="400"/>

- Select the log files for the time frame when the issue occurred.

<img src={require("./img/logging/logging-logfiles.png").default} alt="Logfiles overview" width="400"/>
<img src={require("./img/logging/logging-logfiles.png").default} alt="Logfiles overview" width="400"/>

:::note
These logs can help diagnose and fix any issues with your OpenCloud Desktop Client.
:::

### Log Content Description

`25-02-17 09:02:35:174 [ info sync.httplogger ]: REQUEST 3710cc12-7391-4793-8e89-00499dc11983 {"request":{"body":{"length":0},"header":{"accept":"*/*","accept-language":"en_DE","original-request-id":"3710cc12-7391-4793-8e89-00499dc11983","user-agent":"Mozilla/5.0 (Macintosh) mirall/1.0.0-git (OpenCloud, macos-24.3.0 ClientArchitecture: x86_64 OsArchitecture: arm64)","x-request-id":"3710cc12-7391-4793-8e89-00499dc11983"},"info":{"cached":false,"id":"3710cc12-7391-4793-8e89-00499dc11983","method":"GET","url":"https://cloud.opencloud.test/.well-known/openid-configuration"}}}`

| Log Content | Description |
| ---------------------------------------- | ------------------------------------------------- |
| **25-02-17 09:02:35:174** | Timestamp of the request |
| **[ info sync.httplogger ]** | Log category label |
| **3710cc12-7391-4793-8e89-00499dc11983** | X-REQUEST-ID (used to match requests & responses) |
| **Header: { }** | List of HTTP headers |
| **Data: []** | HTTP bodies (JSON, XML) |
| **(112ms)** | Response time (since the request was sent) |
| Log Content | Description |
| ------------------------------------ | ------------------------------------------------- |
| 25-02-17 09:02:35:174 | Timestamp of the request |
| [ info sync.httplogger ] | Log category label |
| 3710cc12-7391-4793-8e89-00499dc11983 | X-REQUEST-ID (used to match requests & responses) |
| Header: { } | List of HTTP headers |
| Data: [] | HTTP bodies (JSON, XML) |
| (112ms) | Response time (since the request was sent) |

### Using X-REQUEST-ID for Debugging

- The OpenCloud desktop app sends an **X-REQUEST-ID** header with every request.
- The OpenCloud desktop app sends an X-REQUEST-ID header with every request.
- This ID helps in finding corresponding requests and responses in logs.
- You can configure your web server to add the **X-REQUEST-ID** to its logs for deeper analysis.
- You can configure your web server to add the X-REQUEST-ID to its logs for deeper analysis.

:::note
This feature is useful for debugging sync issues, monitoring network activity, and troubleshooting connectivity problems.
:::
18 changes: 10 additions & 8 deletions docs/user/desktop-client/multiple-accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ You can synchronize multiple accounts from different OpenCloud servers to your l

## How to Add a New Account

- Open **OpenCloud Desktop**
- Click on **Add Account**
- Open OpenCloud Desktop
- Click on Add Account

<img src={require("./img/multiple-accounts/multiple-accounts-add-account.png").default} alt="Add accounts" width="400"/>

Expand All @@ -24,19 +24,21 @@ You can synchronize multiple accounts from different OpenCloud servers to your l

## Switching Between Accounts

- After adding multiple accounts, they will appear in the **account overview** in the settings menu
- After adding multiple accounts, they will appear in the account overview in the settings menu
- You can easily switch between them to manage synchronization settings for each account separately

<img src={require("./img/multiple-accounts/multiple-accounts-switch-accounts.png").default} alt="Switch accounts" width="400"/>

## How Files are Stored Locally

- In your **File Explorer**, each account will have a separate folder
- In your File Explorer, each account will have a separate folder
- By default, the folders are named:
- **OpenCloud** (for the first account)
- **OpenCloud (2)** (for the second account)
- **OpenCloud (3)** (for the third account), and so on
- OpenCloud (for the first account)
- OpenCloud (2) (for the second account)
- OpenCloud (3) (for the third account), and so on

<img src={require("./img/multiple-accounts/multiple-accounts-locally.png").default} alt="Multiple accounts in explorer or finder" width="400"/>

This setup ensures that files from different accounts remain **organized and do not mix**.
:::note
This setup ensures that files from different accounts remain organized and do not mix.
:::
32 changes: 15 additions & 17 deletions docs/user/desktop-client/set-up.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,46 +12,44 @@ Follow these simple steps to install and configure your OpenCloud Desktop and st

## Enter the Server URL

- Open your **OpenCloud Desktop**
- Open your OpenCloud Desktop
- Enter the URL of your OpenCloud instance
- Click **"Continue"**
- Click "Continue"

<img src={require("./img/set-up/set-up-enter-url.png").default} alt="Enter URL" width="400"/>
<img src={require("./img/set-up/set-up-enter-url.png").default} alt="Enter URL" width="400"/>

## Log In via Web Browser

- Click **"Open web browser"** to log in automatically
- Click "Open web browser" to log in automatically
- Alternatively, copy the provided URL and paste it into your browser manually

<img src={require("./img/set-up/set-up-login.png").default} alt="Open browser to login" width="400"/>
<img src={require("./img/set-up/set-up-login.png").default} alt="Open browser to login" width="400"/>

## Enter Your Credentials

- Enter your **username** and **password**
- Click **"Login"**
- Enter your username and password
- Click "Login"

<img src={require("./img/set-up/set-up-user-password.png").default} alt="Enter credentials" width="400"/>
<img src={require("./img/set-up/set-up-user-password.png").default} alt="Enter credentials" width="400"/>

## Grant Access

- Accept the access request to link your account with OpenCloud Desktop.

<img src={require("./img/set-up/set-up-accept-access.png").default} alt="Grand access" width="400"/>
<img src={require("./img/set-up/set-up-accept-access.png").default} alt="Grand access" width="400"/>

## Finalize Setup

### Optional Advanced Configuration
## Optional Advanced Configuration

- Choose whether to **sync all files** or **select specific folders** (this can be adjusted later).
- Change the **local download directory** where your files will be stored.
- Choose whether to sync all files or select specific folders (this can be adjusted later).
- Change the local download directory where your files will be stored.

<img src={require("./img/set-up/set-up-advanced-configuration.png").default} alt="Finalize setup" width="400"/>
<img src={require("./img/set-up/set-up-advanced-configuration.png").default} alt="Finalize setup" width="400"/>

Once you're ready, click **Done** to complete the setup.
Once you're ready, click Done to complete the setup.

<img src={require("./img/set-up/set-up-all-set.png").default} alt="All set" width="400"/>

## Congratulations

**OpenCloud Desktop** is now successfully set up.
OpenCloud Desktop is now successfully set up.
You can start syncing your files seamlessly between your device and the OpenCloud server!
26 changes: 14 additions & 12 deletions docs/user/desktop-client/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ You can customize OpenCloud Desktop settings by following these steps:

## Open Settings

- Click on **"Settings"** in the top-right corner of OpenCloud Desktop
- Click on "Settings" in the top-right corner of OpenCloud Desktop

<img src={require("./img/settings/settings-overview.png").default} alt="Settings overview" width="400"/>
<img src={require("./img/settings/settings-overview.png").default} alt="Settings overview" width="400"/>

## Overview of Settings Sections

Expand All @@ -24,7 +24,7 @@ You can customize OpenCloud Desktop settings by following these steps:
- Choose whether to show desktop notifications
- Set your preferred language

<img src={require("./img/settings/settings-general.png").default} alt="Settings-general" width="400"/>
<img src={require("./img/settings/settings-general.png").default} alt="Settings-general" width="400"/>

### Advanced Settings

Expand All @@ -33,24 +33,26 @@ You can customize OpenCloud Desktop settings by following these steps:
- Edit the ignored files list
- Enable a debug log file for troubleshooting

<img src={require("./img/settings/settings-advanced.png").default} alt="Settings advanced" width="400"/>
<img src={require("./img/settings/settings-advanced.png").default} alt="Settings advanced" width="400"/>

### Network Settings

- Select how the client handles proxy settings:
- **No proxy**
- **Use system proxy** (default)
- **Manually enter a proxy**
- No proxy
- Use system proxy (default)
- Manually enter a proxy

<img src={require("./img/settings/settings-network.png").default} alt="Settings network" width="400"/>
<img src={require("./img/settings/settings-network.png").default} alt="Settings network" width="400"/>

### Download and Upload Bandwidth

- Set bandwidth limits:
- **No limit** (default)
- **Automatically adjust limit**
- **Set a specific limit manually**
- No limit (default)
- Automatically adjust limit
- Set a specific limit manually

<img src={require("./img/settings/settings-bandwidth.png").default} alt="Settings bandwidth" width="400"/>
<img src={require("./img/settings/settings-bandwidth.png").default} alt="Settings bandwidth" width="400"/>

:::note
By adjusting these settings, you can optimize OpenCloud Desktop according to your needs!
:::
34 changes: 17 additions & 17 deletions docs/user/desktop-client/sync-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,53 +10,53 @@ draft: false

## Synchronization Settings

1. Open the **OpenCloud Desktop**
2. Go to the **Account View**
3. Click on the **Three-Dot Menu (...)** next to the Space you want to configure
- Open the OpenCloud Desktop
- Go to the Account View
- Click on the Three-Dot Menu (...) next to the Space you want to configure

<img src={require("./img/sync-settings/sync-settings-three-dot.png").default} alt="Admin spaces" width="400"/>
<img src={require("./img/sync-settings/sync-settings-three-dot.png").default} alt="Admin spaces" width="400"/>

4. Choose from the following options:
- Choose from the following options:

### Synchronization Options

<img src={require("./img/sync-settings/sync-settings-menu.png").default} alt="Synchronization options menu" width="400"/>

### Show in Explorer or Finder

- Opens the selected Space directly in your **File Explorer (Windows)** or **Finder (Mac)**
- Opens the selected Space directly in your File Explorer (Windows) or Finder (Mac)

### Show in Web Browser

- Opens the Space in your **web browser**
- If you're not logged in, you may need to **sign in first**
- Opens the Space in your web browser
- If you're not logged in, you may need to sign in first

### Force Sync Now

- Manually forces an **immediate synchronization** of the Space
- Manually forces an immediate synchronization of the Space
- Useful if you want to ensure all changes are uploaded/downloaded right away

### Pause Sync

- Temporarily **stops synchronization** for the Space
- Can be resumed anytime by selecting **Resume Sync**
- Temporarily stops synchronization for the Space
- Can be resumed anytime by selecting Resume Sync

### Remove Sync Folder Connection

- Stops syncing the Space, but **does not delete local files**
- Stops syncing the Space, but does not delete local files
- The Space remains on the server, and you can add it again later

### Choose What to Sync

- Opens a window where you can **select specific folders** from the Space to sync
- Helps **save storage space** by syncing only necessary files
- Opens a window where you can select specific folders from the Space to sync
- Helps save storage space by syncing only necessary files

<img src={require("./img/sync-settings/sync-settings-choose-what-to-sync.png").default} alt="Choose what to sync" width="400"/>
<img src={require("./img/sync-settings/sync-settings-choose-what-to-sync.png").default} alt="Choose what to sync" width="400"/>

:::note
Files and folders that are not synced will **no longer be available** on your local machine.
Files and folders that are not synced will no longer be available on your local machine.
:::

:::tip
Adjusting these settings allows you to **optimize storage space and network usage**, ensuring only the files you need are kept in sync.
Adjusting these settings allows you to optimize storage space and network usage, ensuring only the files you need are kept in sync.
:::
Loading