diff --git a/docs/user/desktop-client/installation.md b/docs/user/desktop-client/installation.md index b9ca6270..b18c7836 100644 --- a/docs/user/desktop-client/installation.md +++ b/docs/user/desktop-client/installation.md @@ -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 + + Download from Microsoft Store + -Open the **Microsoft Store** and search for **OpenCloud Desktop** or click on the image below - -Download from Microsoft Store - +- 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) +::: diff --git a/docs/user/desktop-client/logging.md b/docs/user/desktop-client/logging.md index 2c2cc3bd..fc008348 100644 --- a/docs/user/desktop-client/logging.md +++ b/docs/user/desktop-client/logging.md @@ -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 -Logging access + Logging access ## 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 -Enable logging + Enable logging ## Find the Log Files -- Click **Open folder** to access the logs. +- Click Open folder to access the logs. -Open logfile folder + Open logfile folder - Select the log files for the time frame when the issue occurred. -Logfiles overview + Logfiles overview +:::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. +::: diff --git a/docs/user/desktop-client/multiple-accounts.md b/docs/user/desktop-client/multiple-accounts.md index b49618a9..10a49008 100644 --- a/docs/user/desktop-client/multiple-accounts.md +++ b/docs/user/desktop-client/multiple-accounts.md @@ -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 Add accounts @@ -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 Switch accounts ## 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 Multiple accounts in explorer or finder -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. +::: diff --git a/docs/user/desktop-client/set-up.md b/docs/user/desktop-client/set-up.md index 2ab5acef..05f50cee 100644 --- a/docs/user/desktop-client/set-up.md +++ b/docs/user/desktop-client/set-up.md @@ -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" -Enter URL + Enter URL ## 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 -Open browser to login + Open browser to login ## Enter Your Credentials -- Enter your **username** and **password** -- Click **"Login"** +- Enter your username and password +- Click "Login" -Enter credentials + Enter credentials ## Grant Access - Accept the access request to link your account with OpenCloud Desktop. -Grand access + Grand access ## 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. -Finalize setup + Finalize setup -Once you're ready, click **Done** to complete the setup. +Once you're ready, click Done to complete the setup. All set -## 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! diff --git a/docs/user/desktop-client/settings.md b/docs/user/desktop-client/settings.md index 0724e333..b7187d98 100644 --- a/docs/user/desktop-client/settings.md +++ b/docs/user/desktop-client/settings.md @@ -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 -Settings overview + Settings overview ## Overview of Settings Sections @@ -24,7 +24,7 @@ You can customize OpenCloud Desktop settings by following these steps: - Choose whether to show desktop notifications - Set your preferred language -Settings-general + Settings-general ### Advanced Settings @@ -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 -Settings advanced + Settings advanced ### 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 -Settings network + Settings network ### 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 -Settings bandwidth + Settings bandwidth +:::note By adjusting these settings, you can optimize OpenCloud Desktop according to your needs! +::: diff --git a/docs/user/desktop-client/sync-settings.md b/docs/user/desktop-client/sync-settings.md index 0bec5af3..221605fe 100644 --- a/docs/user/desktop-client/sync-settings.md +++ b/docs/user/desktop-client/sync-settings.md @@ -10,13 +10,13 @@ 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 -Admin spaces + Admin spaces -4. Choose from the following options: +- Choose from the following options: ### Synchronization Options @@ -24,39 +24,39 @@ draft: false ### 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 -Choose what to sync + Choose what to sync :::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. ::: diff --git a/docs/user/desktop-client/uninstall.md b/docs/user/desktop-client/uninstall.md index 8134051e..687d146a 100644 --- a/docs/user/desktop-client/uninstall.md +++ b/docs/user/desktop-client/uninstall.md @@ -8,22 +8,20 @@ draft: false # Removing the OpenCloud Desktop -If you no longer need **OpenCloud Desktop**, follow these steps to completely remove it from your system. +If you no longer need OpenCloud Desktop, follow these steps to completely remove it from your system. -## Remove your Accounts +## Remove your accounts to have a clean system -### Remove your accounts to have a clean system - -- click on the right side of the OpenCloud Desktop on **Manage Account** +- click on the right side of the OpenCloud Desktop on Manage Account Click on Manage Account -- then select **Remove** +- then select Remove Select remove ## Remove the OpenCloud Desktop -### The process depends on your operating system +The process depends on your operating system -- **Windows:** Uninstall the app through **Control Panel > Programs & Features** -- **Mac:** Move the app to the **Trash** and empty it -- **Linux:** Use your **package manager** or remove the **AppImage** file manually +- Windows: Uninstall the app through Control Panel > Programs & Features +- Mac: Move the app to the Trash and empty it +- Linux: Use your package manager or remove the AppImage file manually