diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc index 422c6848..559a5921 100644 --- a/.markdownlint-cli2.jsonc +++ b/.markdownlint-cli2.jsonc @@ -4,6 +4,7 @@ "ignores": [ ".git", "node_modules", + "build", "static", "assets", "CHANGELOG.md", diff --git a/.markdownlint.json b/.markdownlint.json index ff4f1bc3..a49cb21f 100644 --- a/.markdownlint.json +++ b/.markdownlint.json @@ -1,7 +1,8 @@ { "default": true, - "MD003": false, // Disable MD003 to allow different heading styles "MD013": false, // Disable MD013 to allow long lines "MD033": false, // Disable MD033 to allow inline HTML - "MD029": { "style": "ordered" } // Ensure ordered lists are used + "MD024": false, // Disable MD024 to allow headings with the same text + "MD025": false, // Disable MD025 to allow frontmatter title with different content as heading ( e.g. Nav items should should be short) + "MD029": false // TODO: Too much false positives } \ No newline at end of file diff --git a/.woodpecker/build.yaml b/.woodpecker/build.yaml index 2da97b36..1d6f199c 100644 --- a/.woodpecker/build.yaml +++ b/.woodpecker/build.yaml @@ -9,6 +9,11 @@ steps: image: quay.io/thegeeklab/git-batch commands: - git batch -vv + - name: lint-md + image: owncloudci/nodejs:20 + commands: + - pnpm install + - pnpm lint:md - name: format-check image: owncloudci/nodejs:20 commands: diff --git a/README.md b/README.md index a7a66d45..ceba6a03 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati ### Installation -```Shell +```bash pnpm install ``` @@ -12,7 +12,7 @@ pnpm install clone this repository -```Shell +```bash pnpm start ``` @@ -22,7 +22,7 @@ This command starts a local development server and opens up a browser window. Mo To see the docs in German you need to start it with the following command -```Shell +```bash pnpm run start --locale de ``` @@ -30,7 +30,7 @@ It is not possible to switch between the languages via the language switcher ### Build -```Shell +```bash pnpm build ``` @@ -40,13 +40,13 @@ This command generates static content into the `build` directory and can be serv Using SSH: -```Shell +```bash USE_SSH=true pnpm deploy ``` Not using SSH: -```Shell +```bash GIT_USER= pnpm deploy ``` diff --git a/docs/admin/configuration/authentication-and-user-management/keycloak.md b/docs/admin/configuration/authentication-and-user-management/keycloak.md index 4ef1422b..e7cde01a 100644 --- a/docs/admin/configuration/authentication-and-user-management/keycloak.md +++ b/docs/admin/configuration/authentication-and-user-management/keycloak.md @@ -21,7 +21,7 @@ You can also use one of our predefined Docker Compose setups, which are located ### Server Configuration -``` +```env PROXY_AUTOPROVISION_ACCOUNTS=true|false # that depends on your setup PROXY_ROLE_ASSIGNMENT_DRIVER=oidc OC_OIDC_ISSUER=https://your-domain.example.com/realms/openCloud @@ -36,7 +36,7 @@ GRAPH_USERNAME_MATCH=none OC_EXCLUDE_RUN_SERVICES=idp,idm # it is not supported to run keycloak with the built-in idm ``` -Look [here](./external-idp.md#opencloud-configuration) for some more details about these settings. +Look [OpenCloud external IDP configuration](./external-idp.md#opencloud-configuration) for some more details about these settings. ### Client Configuration diff --git a/docs/admin/configuration/radicale-integration.md b/docs/admin/configuration/radicale-integration.md index 83c29d95..46dd1ed6 100644 --- a/docs/admin/configuration/radicale-integration.md +++ b/docs/admin/configuration/radicale-integration.md @@ -31,13 +31,13 @@ deployment based on the `opencloud_full` deployment example. In the root directory of the `opencloud_full` deployment example, usually `opencloud/deployments/examples/opencloud_full`, remove the `#` symbol from the line: -``` +```env #RADICALE=:radicale.yml ``` ### 2. Update the deployment -``` +```bash docker compose up -d ``` diff --git a/docs/admin/configuration/storage/decomposeds3.md b/docs/admin/configuration/storage/decomposeds3.md index 2248a69a..30f70bf8 100644 --- a/docs/admin/configuration/storage/decomposeds3.md +++ b/docs/admin/configuration/storage/decomposeds3.md @@ -22,7 +22,7 @@ Decomposeds3 is a storage driver for OpenCloud that uses MinIO, an S3-compatible Download the `opencloud_full` folder (this folder contains a multi-file Docker Compose configuration): -```Shell +```bash git clone https://github.com/opencloud-eu/opencloud.git ``` @@ -30,13 +30,13 @@ git clone https://github.com/opencloud-eu/opencloud.git Navigate to the Docker Compose configuration folder: -```Shell +```bash cd opencloud/deployments/examples/opencloud_full ``` Enable `decomposeds3.yml` and `minio.yml` in the `.env` file: -```Shell +```bash nano opencloud/deployments/examples/opencloud_full/.env ``` @@ -44,7 +44,7 @@ Find all required environment variables `env` here: [decomposeds3-envs](https:// Start the deployment with Docker Compose: -```Shell +```bash docker compose up -d ``` @@ -54,7 +54,7 @@ This starts all necessary containers in the background. Edit the /etc/hosts file and add the following entries for local access: -``` +```bash 127.0.0.1 cloud.opencloud.test 127.0.0.1 minio.opencloud.test ``` diff --git a/docs/admin/configuration/storage/posixfs.md b/docs/admin/configuration/storage/posixfs.md index e452aedc..4c1e5164 100644 --- a/docs/admin/configuration/storage/posixfs.md +++ b/docs/admin/configuration/storage/posixfs.md @@ -111,6 +111,6 @@ It is essential to maintain correct file ownership and permissions when modifyin In addition to the configuration required for non-collaborative mode, the following setting must be enabled for local file systems such as XFS, ext4, and others: -``` +```env STORAGE_USERS_POSIX_WATCH_FS=true ``` diff --git a/docs/admin/getting-started/container/docker-compose-local.md b/docs/admin/getting-started/container/docker-compose-local.md index a03fc1d1..34bf22fd 100644 --- a/docs/admin/getting-started/container/docker-compose-local.md +++ b/docs/admin/getting-started/container/docker-compose-local.md @@ -21,7 +21,7 @@ Spin up a temporary local instance of OpenCloud using **Docker Compose**. Clone the OpenCloud repository: -```Shell +```bash git clone https://github.com/opencloud-eu/opencloud-compose.git ``` @@ -31,13 +31,13 @@ git clone https://github.com/opencloud-eu/opencloud-compose.git ### cd into the Docker Compose configuration folder -```Shell +```bash cd opencloud-compose ``` ### Create environment file -```Shell +```bash cp .env.example .env ``` @@ -47,19 +47,19 @@ cp .env.example .env You can deploy using explicit -f flags: -```Shell +```bash docker compose -f docker-compose.yml -f weboffice/collabora.yml -f traefik/opencloud.yml -f traefik/collabora.yml up -d ``` Or by uncomment or adding the COMPOSE_FILE variable in .env: -```Shell +```bash COMPOSE_FILE=docker-compose.yml:weboffice/collabora.yml:traefik/opencloud.yml:traefik/collabora.yml ``` Set you initial admin password in the .env -```Shell +```bash INITIAL_ADMIN_PASSWORD=YOUR.SECRET.PASSWORD ``` @@ -67,7 +67,7 @@ This is mandatory for security reasons. Otherwise the OpenCloud container will n Start the deployment with Docker Compose: -```Shell +```bash docker compose up -d ``` @@ -81,7 +81,7 @@ This starts all necessary containers in the background. Edit the /etc/hosts file and add the following entries for local access: -``` +```bash 127.0.0.1 cloud.opencloud.test 127.0.0.1 collabora.opencloud.test 127.0.0.1 wopiserver.opencloud.test diff --git a/docs/admin/getting-started/container/docker-compose/docker-compose.md b/docs/admin/getting-started/container/docker-compose/docker-compose.md index c1fc1aef..0c5d4817 100644 --- a/docs/admin/getting-started/container/docker-compose/docker-compose.md +++ b/docs/admin/getting-started/container/docker-compose/docker-compose.md @@ -257,7 +257,7 @@ If you encounter any issues, check the [Common Issues & Help](./../../../resourc
-#### To enable Keycloak for identity and access management, **uncomment** the following lines in your `.env` file +### To enable Keycloak for identity and access management, **uncomment** the following lines in your `.env` file ```env LDAP=:ldap.yml @@ -271,7 +271,7 @@ KEYCLOAK_ADMIN_PASSWORD="your.save.password" This will include the LDAP and Keycloak service definitions in the Docker Compose setup. -#### After starting OpenCloud, Keycloak will be available at +### After starting OpenCloud, Keycloak will be available at ```bash https://keycloak.your.domain @@ -281,7 +281,7 @@ https://keycloak.your.domain ### Once Keycloak is running -**1. Open your browser and go to** +#### 1. Open your browser and go to ```bash https://keycloak.your.domain @@ -290,15 +290,18 @@ https://keycloak.your.domain Keyclosk dashboard

-**2. Log in with the admin credentials (default is admin / admin).** +#### 2. Log in with the admin credentials (default is admin / admin) + Keycloak login

-**3. In the top-left dropdown (labeled Keycloak), switch to the OpenCloud realm.** +#### 3. In the top-left dropdown (labeled Keycloak), switch to the OpenCloud realm + Top left dropdown menue

-**4. Navigate to the "Users" section and click "Add user":** +#### 4. Navigate to the "Users" section and click "Add user" + User section
@@ -308,7 +311,7 @@ https://keycloak.your.domain Fill in userdata

-**5. Go to the "Credentials" tab:** +#### 5. Go to the "Credentials" tab - Click "Set password" Credentials @@ -319,7 +322,8 @@ https://keycloak.your.domain Set password

-**6. Go to the "Role Mapping" tab:** +#### 6. Go to the "Role Mapping" tab + Role mapping
@@ -334,4 +338,4 @@ https://keycloak.your.domain Realm roles
-**The user can now log in via OpenCloud using the Keycloak credentials.** +The user can now log in via OpenCloud using the Keycloak credentials. diff --git a/docs/admin/getting-started/container/docker.md b/docs/admin/getting-started/container/docker.md index 1100315f..5f19ad2a 100644 --- a/docs/admin/getting-started/container/docker.md +++ b/docs/admin/getting-started/container/docker.md @@ -20,7 +20,7 @@ description: 'Classic docker setup.' ### 1. Create Required Directories for Bind Mounts -```Shell +```bash mkdir -p $HOME/opencloud/opencloud-config mkdir -p $HOME/opencloud/opencloud-data ``` @@ -29,7 +29,7 @@ mkdir -p $HOME/opencloud/opencloud-data ### 2. Pull OpenCloud Image -```Shell +```bash docker pull opencloudeu/opencloud-rolling:latest ``` @@ -37,7 +37,7 @@ docker pull opencloudeu/opencloud-rolling:latest ### 3. Initialize OpenCloud (First-time Setup) -```Shell +```bash docker run --rm -it \ -v $HOME/opencloud/opencloud-config:/etc/opencloud \ -v $HOME/opencloud/opencloud-data:/var/lib/opencloud \ @@ -53,7 +53,7 @@ You can set your own password using `IDM_ADMIN_PASSWORD=your_password`. If not s ### 4. Start OpenCloud -```Shell +```bash docker run \ --name opencloud \ --rm \ diff --git a/docs/admin/getting-started/other/raspberry-pi.md b/docs/admin/getting-started/other/raspberry-pi.md index f7b3bea1..f0405721 100644 --- a/docs/admin/getting-started/other/raspberry-pi.md +++ b/docs/admin/getting-started/other/raspberry-pi.md @@ -15,14 +15,15 @@ It is not recommended for enterprise or critical environments due to the hardwar - Minimum Raspberry Pi 4B with at least 4 GB RAM connected via LAN or WLAN - Micro SD card with at least 32 GB storage space -- External hard disk or USB-Stick (optional) for additional storage space +- External hard disk or USB stick (optional) for additional storage space ## 1.2 Install operating system -- Install Raspberry Pi OS +- Install Raspberry Pi OS A very detailed and understandable guide is available at: [Raspberry Pi Getting Started](https://pimylifeup.com/raspberry-pi-getting-started/) -- SSH must be activated + +- SSH must be activated activate ssh - If the Raspberry Pi is to be connected to WLAN, the login data for the WLAN must be entered. @@ -34,262 +35,236 @@ The IP for this can be viewed in your router. find ip from raspberry-pi in router -#### Establish connection via SSH +### Establish connection via SSH -```sh +```bash ssh pi@YOUR-IP ``` After the first login, you should change the password for security reasons: -```sh +```bash passwd ``` ## 1.4 Installing Docker and Docker Compose -Detailed installation instructions for docker can be found here: +Detailed installation instructions for Docker can be found here: [Install Docker on Raspberry Pi](https://pimylifeup.com/raspberry-pi-docker/) -- Perform update and upgrade +- Perform update and upgrade: -```sh +```bash sudo apt update && sudo apt upgrade -y ``` -- Install Docker via Script +- Install Docker via script: -```sh +```bash curl -fsSL test.docker.com -o get-docker.sh && sh get-docker.sh ``` -- Add current user to the Docker Group +- Add current user to the Docker group: -```sh +```bash sudo usermod -aG docker ${USER} ``` -- Check if it's running: +- Check if it's working: -```sh +```bash groups ${USER} ``` Check docker user -- Reboot the Raspberry Pi to let the changes take effect +- Reboot the Raspberry Pi: -```sh +```bash sudo shutdown -r now ``` ## 1.5 Clone OpenCloud repository -```sh +```bash git clone https://github.com/opencloud-eu/opencloud-compose.git ``` -## 1.6 Start the docker compose setup +## 1.6 Start the Docker Compose setup -```sh +```bash cd opencloud-compose ``` -Copy the .env.example +Copy the `.env.example` file: -```sh +```bash cp .env.example .env ``` -Adjust the .env +Edit the `.env` file: -```sh +```bash nano .env ``` -Add for the minimal OpenCloud setup: +Add the minimal OpenCloud setup: -```sh +```env COMPOSE_FILE=docker-compose.yml:traefik/opencloud.yml ``` -in the .env and then start the docker with +Then start Docker: -```sh +```bash docker compose up ``` -Now you have running OpenCloud locally on your RaspberryPi and you can adjust it to your needs. -We will describe how you can mount an external disk or USB-Stick and make your OpenCloud available outside of the local network with No-IP +Now OpenCloud is running locally on your Raspberry Pi, and you can adjust it to your needs. + +We will describe how to mount an external disk or USB stick and make OpenCloud available outside the local network using No-IP. -## 1.7 Mount external hard disk or USB-Stick +## 1.7 Mount external hard disk or USB stick -#### 1. Find your external hard disk or USB-Stick on your Raspberry-Pi +### 1. Find your external drive -```sh +```bash lsblk ``` find the external hd -#### 2. Format the drive to ext4 filesystem - -```sh -sudo mkfs.ext4 PATH-TO-DRIVE -L DATA -``` - -PATH-TO-DRIVE is in this example `/dev/sda1` so the command would be +### 2. Format the drive to ext4 -```sh +```bash sudo mkfs.ext4 /dev/sda1 -L DATA ``` format drive -#### 3. Add entry in fstab for automatic mounting when restarting +### 3. Add fstab entry for auto-mounting -- open fstab with sudo +Open `fstab`: -```sh - sudo nano /etc/fstab +```bash +sudo nano /etc/fstab ``` -- add the following line in the fstab file +Add this line: -```sh +```bash LABEL=DATA /mnt/data ext4 auto,defaults 0 0 ``` -#### 4. Create the `/mnt/data` directory and give the user 1000 access +### 4. Create the mount point and set permissions -```sh +```bash sudo mkdir -p /mnt/data -``` - -```sh sudo chown -R 1000:1000 /mnt/data ``` -#### 5. mount the drive automatically +### 5. Mount the drive -```sh +```bash sudo mount -a ``` -Maybe you get following error +If an error occurs: error mounting -then please perform the recommended command +Run: -```sh +```bash systemctl daemon-reload ``` -and try to mount again. +And try mounting again. -## 1.8 Mount external storage +## 1.8 Mount external storage in Docker -Stop the running docker +Stop Docker: -```sh +```bash docker compose down ``` -Go to the opencloud-compose folder and open the `.env` file with e.g. nano +Open the `.env` file: -```sh +```bash cd opencloud-compose -``` - -```sh nano .env ``` -When you added an external hard disk or USB-Stick for the storage, you need to set the `OC_DATA_DIR` variable and adjust the path to your storage +Set the `OC_DATA_DIR` variable to your mounted storage path, e.g.: -change env for storage +```env +OC_DATA_DIR=/mnt/data +``` -Here it is `/mnt/data` +change env for storage -Start the docker again +Restart Docker: -```sh +```bash docker compose up ``` -## 1.9 Make your OpenCloud available from outside - -#### 1. Create a DynDNS account and the hostname +## 1.9 Make OpenCloud externally available -To make your Raspberry Pi accessible from the outside, you need a DynDNS entry (dynamic DNS). This is necessary because Let's Encrypt only creates SSL certificates for domain names, not for IP addresses. A DynDNS service ensures that your Pi always remains accessible under a fixed domain, even if the IP address changes. +### 1. Create DynDNS hostname -You can create a free DynDNS account at [No-IP](https://www.noip.com/), for example. After registering, log in to the No-IP web interface and create a new host name under “Create Hostname”. In this example, we use `opencloud.webhop.me` as the address for the Raspberry Pi. +Register at [No-IP](https://www.noip.com/) and create a hostname, e.g. `opencloud.webhop.me`. noip hostname input -#### 2. Configure DynDNS in your router - -If your router supports integrated Dynamic DNS (DynDNS), you can update your IP address directly via the router. This eliminates the need to install the Dynamic Update Client (DUC) from No-IP on your Raspberry Pi. -How to set up DDNS in the router: +### 2. Configure DynDNS in your router -- Log into your router's web interface (usually via 192.168.1.1 or a similar address). -- Search for the DDNS settings - these are usually located under Network, Internet or Dynamic DNS. -- Select No-IP as your provider from the list of supported DDNS services. -- Enter your No-IP credentials (username & password). -- Enter the hostname you previously created with No-IP (e.g. opencloud-at-home.ddns.net). -- Save the settings and test the connection. +Use your router’s web interface to: -The router will now automatically update your public IP address at No-IP so that your Raspberry Pi always remains accessible under the selected subdomain. +- Locate the Dynamic DNS settings +- Select **No-IP** as provider +- Enter your No-IP credentials +- Use the created hostname (e.g. `opencloud.webhop.me`) +- Save and test the settings -You can also look in the documentation from [No-IP](https://www.noip.com/support/knowledgebase/how-to-configure-ddns-in-router) +More help: [No-IP Support](https://www.noip.com/support/knowledgebase/how-to-configure-ddns-in-router) -#### 3. Configure port forwarding in your router +### 3. Configure port forwarding -To make your Raspberry Pi accessible from the Internet, you must set up port forwarding in your router. This means that requests from outside to certain ports are automatically forwarded to your Raspberry Pi in the local network. +1. Ensure your Raspberry Pi always has the same IP address: + - Either via static IP or DHCP assignment in the router -1. Make sure that your Raspberry Pi always has the same IP address: +2. In your router settings, look for **Port Forwarding**, **NAT**, or **Port Sharing** -- By making a fixed DHCP assignment in the router settings -- Or via a static IP address in the network settings of your Pi +3. Forward the following ports to your Raspberry Pi: -2. In the router menu, search for “Port forwarding”, “NAT” or “Port sharing” (the name may vary depending on the router model) +- TCP Port 80 (HTTP) +- TCP Port 443 (HTTPS) -3. Create a new portforwarding with TCP for 80 and 443 - -Example from a Speedport 4 portforwarding in router -#### 4. Change the OpenCloud domain in the configuration - -Now you need to change the environment variable `OC_DOMAIN` in the `.env` file - -1. Connect via ssh on your Raspberry-Pi +### 4. Update OC_DOMAIN -2. Navigate to the correct folder +SSH into your Pi and update the domain: -```sh +```bash cd opencloud-compose -``` - -3. Stop running OpenCloud docker - -```sh docker compose down +nano .env ``` -4. open the `.env` file with e.g. nano +Edit the `OC_DOMAIN` value: -```sh -nano .env +```env +OC_DOMAIN=opencloud.webhop.me ``` -5. Look for the `OC_DOMAIN` variable and enter your URL, here we used `opencloud.webhop.me` - change the OC_DOMAIN variable +change the OC_DOMAIN variable -6. Start the docker again +Restart Docker: -```sh +```bash docker compose up ``` diff --git a/docs/admin/maintenance/dataexport.md b/docs/admin/maintenance/dataexport.md index ad1fb175..5d81df01 100644 --- a/docs/admin/maintenance/dataexport.md +++ b/docs/admin/maintenance/dataexport.md @@ -2,7 +2,7 @@ sidebar_position: 5 id: dataexport title: 'Data Export' -description:: 'Information about data export.' +description: 'Information about data export.' --- # Data Export diff --git a/docs/admin/maintenance/migrate.md b/docs/admin/maintenance/migrate.md index c62f7c9e..64dfe175 100644 --- a/docs/admin/maintenance/migrate.md +++ b/docs/admin/maintenance/migrate.md @@ -2,7 +2,7 @@ sidebar_position: 3 id: migrate title: 'Migrate' -description:: 'Guide to migrating data using rclone.' +description: 'Guide to migrating data using rclone.' --- import Tabs from '@theme/Tabs' @@ -16,94 +16,108 @@ This guide will help you migrate personal space data from `NextCloud` and `oCIS` - ### Run `OpenCloud` with following configuration: - Modify `.env` file: - ```sh - START_ADDITIONAL_SERVICES="auth-app" - ``` +### Run OpenCloud with the following configuration - Enable `auth-app` service: - ```sh - PROXY_ENABLE_APP_AUTH: "true" - ``` +Modify `.env` file: - ### Generate user token using CLI: +```bash +START_ADDITIONAL_SERVICES="auth-app" +``` + +Enable `auth-app` service: + +```bash +PROXY_ENABLE_APP_AUTH="true" +``` - Enter the OpenCloud container: - ```sh - docker exec -it opencloud_full-opencloud-1 sh - ``` +### Generate user token using CLI - Generate an authentication token for a user (e.g, `Alan`) with expiration (`h, m, s`): - ```sh - opencloud auth-app create --user-name=alan --expiration=72h - ``` +Access the OpenCloud container: - --- +```bash +docker exec -it opencloud_full-opencloud-1 sh +``` + +Generate an authentication token for a user (e.g., `alan`) with expiration (`h`, `m`, `s`): - ### Generate user token using API: +```bash +opencloud auth-app create --user-name=alan --expiration=72h +``` - Requires additional configuration! Start the server with: - ```sh - AUTH_APP_ENABLE_IMPERSONATION=true - ``` +--- - Then generate a token via API: - ```sh - curl -vk -XPOST 'https://opencloud_url/auth-app/tokens?expiry=72h&userName=alan' -uadmin:admin - ``` +### Generate user token using API + +Requires additional configuration! Start the server with: + +```bash +AUTH_APP_ENABLE_IMPERSONATION=true +``` + +Then generate a token via API: + +```bash +curl -vk -XPOST 'https://opencloud_url/auth-app/tokens?expiry=72h&userName=alan' -uadmin:admin +``` - ### Run `oCIS` with following configuration: - Modify `.env` file: - ```sh - START_ADDITIONAL_SERVICES="auth-app" - ``` +### Run oCIS with the following configuration + +Modify `.env` file: - Enable `auth-app` service: - ```sh - PROXY_ENABLE_APP_AUTH: "true" - ``` +```bash +START_ADDITIONAL_SERVICES="auth-app" +``` + +Enable `auth-app` service: + +```bash +PROXY_ENABLE_APP_AUTH="true" +``` - ### Generate user token using CLI: +### Generate user token using CLI - Enter the oCIS container: - ```sh - docker exec -it ocis_full-ocis-1 sh - ``` +Access the oCIS container: - Generate an authentication token for a user (e.g, `Einstein`) with expiration (`h, m, s`): - ```sh - ocis auth-app create --user-name=einstein --expiration=72h - ``` +```bash +docker exec -it ocis_full-ocis-1 sh +``` + +Generate an authentication token for a user (e.g., `einstein`) with expiration (`h`, `m`, `s`): - --- +```bash +ocis auth-app create --user-name=einstein --expiration=72h +``` - ### Generate user token using API: +--- - Requires Additional Configuration. Need to run server with additional configuration - ```sh - AUTH_APP_ENABLE_IMPERSONATION=true - ``` +### Generate user token using API - Then generate a token via API: - ```sh - curl -vk -XPOST 'https://ocis_url/auth-app/tokens?expiry=72h&userName=einstein' -uadmin:admin - ``` +Requires additional configuration! Start the server with: + +```bash +AUTH_APP_ENABLE_IMPERSONATION=true +``` + +Then generate a token via API: + +```bash +curl -vk -XPOST 'https://ocis_url/auth-app/tokens?expiry=72h&userName=einstein' -uadmin:admin +``` + - ### - Go to `Settings` → `Security` - Create a new `App Password` +### Go to `Settings` → `Security` + +Create a new App Password - 🖼 Example: - init -diff +![Generate App Password](./img/generate-pass-nc.png) @@ -118,7 +132,7 @@ Download and install rclone by following the official guide: 🔗[**rclone.org/i ### 3. Encrypt Authentication Tokens 🔒 -```sh +```bash rclone obscure ``` @@ -128,13 +142,13 @@ rclone obscure Edit the rclone configuration file: -```sh +```bash nano ~/.config/rclone/rclone.conf ``` 📌 Example Configuration: -```sh +```bash [opencloud-admin] type = webdav url = https://opencloud_url/remote.php/webdav @@ -197,7 +211,7 @@ description = nc-bob Use `rclone copy` to transfer data from `oCIS` and `Nextcloud` to `OpenCloud`: -```sh +```bash rclone copy ocis-admin:/ opencloud-admin:/ --no-check-certificate -P # Copy oCIS admin personal space to OpenCloud admin space rclone copy ocis-einstein:/ opencloud-alan:/ --no-check-certificate -P # Copy oCIS bob's personal space to OpenCloud admin space rclone copy nc-bob:/ opencloud-alan:/ --no-check-certificate -P # Copy Nextcloud admin personal space to OpenCloud admin space diff --git a/docs/admin/maintenance/uninstall.md b/docs/admin/maintenance/uninstall.md index 26320ce1..bb665ee4 100644 --- a/docs/admin/maintenance/uninstall.md +++ b/docs/admin/maintenance/uninstall.md @@ -2,7 +2,7 @@ sidebar_position: 4 id: uninstall title: 'Uninstall' -description:: 'Guide to uninstall OpenCloud.' +description: 'Guide to uninstall OpenCloud.' --- # Uninstall OpenCloud with Docker Compose diff --git a/docs/admin/maintenance/upgrade/release-notes.md b/docs/admin/maintenance/upgrade/release-notes.md index de834f21..c9b21bfd 100644 --- a/docs/admin/maintenance/upgrade/release-notes.md +++ b/docs/admin/maintenance/upgrade/release-notes.md @@ -26,7 +26,7 @@ If you're using any other software that utilizes the GraphAPI, that software mig The following endpoints of the GraphAPI were changed in a way that is not backwards compatible with the previous releases: -``` +```http GET /v1.0/me/drives/ GET /v1.0/drives/ GET /v1beta1/drives/ diff --git a/docs/admin/maintenance/upgrade/upgrade.md b/docs/admin/maintenance/upgrade/upgrade.md index a194421c..19fe0ec9 100644 --- a/docs/admin/maintenance/upgrade/upgrade.md +++ b/docs/admin/maintenance/upgrade/upgrade.md @@ -37,7 +37,7 @@ It is recommended to create a [backup](../backup.md) before proceeding with the ### 3. Pull the new Opencloud version -```Shell +```bash docker pull opencloudeu/opencloud:{tag} ``` @@ -49,11 +49,11 @@ If upgrading from an older release, check for required configuration changes: Go inside the container: -```Shell +```bash docker run --rm -it --entrypoint /bin/sh -v $HOME/opencloud/opencloud-config:/etc/opencloud opencloudeu/opencloud:{tag} ``` -```Shell +```bash opencloud init --diff ``` diff --git a/docs/admin/resources/common-issues.md b/docs/admin/resources/common-issues.md index 1f12c550..b1b9fcfa 100644 --- a/docs/admin/resources/common-issues.md +++ b/docs/admin/resources/common-issues.md @@ -8,7 +8,7 @@ title: Common Issues & Help ### Check whether the containers are running -```Shell +```bash docker ps ``` @@ -40,7 +40,7 @@ If your Docker Compose setup fails to start and the logs contain messages such a **Example log output:** -``` +```bash 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"} ``` @@ -48,13 +48,13 @@ This error typically occurs when the mounted directories are owned by the wrong **Incorrect directory ownership:** -``` +```bash drwxr-xr-x 3 root root 4096 Apr 8 09:59 opencloud-data ``` **Correct ownership should be:** -``` +```bash drwxr-xr-x 9 1000 1000 4096 Apr 7 07:57 opencloud-data ``` diff --git a/docs/admin/resources/demo-user.md b/docs/admin/resources/demo-user.md index 0ba62a4f..87d18a40 100644 --- a/docs/admin/resources/demo-user.md +++ b/docs/admin/resources/demo-user.md @@ -22,9 +22,9 @@ Below, you’ll find details about each user, including their roles and login cr ## Dennis Ritchie -#### OpenCloud Username: dennis +OpenCloud Username: **dennis** -#### Role: Admin +Role: **Admin** 📌 **Co-developer of UNIX & inventor of the C programming language** @@ -38,9 +38,9 @@ Below, you’ll find details about each user, including their roles and login cr ## Margaret Hamilton -#### OpenCloud Username: margaret +OpenCloud Username: **margaret** -#### Role: Space Admin +Role: **Space Admin** 📌 **Software pioneer & NASA developer** @@ -55,9 +55,9 @@ Below, you’ll find details about each user, including their roles and login cr ## Alan Turing -#### OpenCloud Username: alan +OpenCloud Username: **alan** -#### Role: User +Role: **User** 📌 **Father of modern computer science & codebreaker in the Second World War** @@ -72,9 +72,9 @@ Below, you’ll find details about each user, including their roles and login cr ## Lynn Conway -#### OpenCloud Username: lynn +OpenCloud Username: **lynn** -#### Role: User +Role: **User** 📌 Computer scientist & microchip design pioneer @@ -90,9 +90,9 @@ Below, you’ll find details about each user, including their roles and login cr ## Mary Kenneth Keller -#### OpenCloud Username: mary +OpenCloud Username: **mary** -#### Role: User +Role: **User** 📌 **First woman with a PhD in computer science** diff --git a/docs/admin/resources/whats-new.md b/docs/admin/resources/whats-new.md index 71bab943..91a992e3 100644 --- a/docs/admin/resources/whats-new.md +++ b/docs/admin/resources/whats-new.md @@ -6,179 +6,179 @@ title: "What's New" # 2025 March 26 -**Release notes OpenCloud 2.0.0 (Production release)** +Release notes OpenCloud 2.0.0 (Production release) -- **🌲 File Native Backups with PosixFS**: OpenCloud introduces PosixFS to allow for easy file native backups. As all files and metadata information is stored directly on the storage (no database needed), you can create standard file-level snapshots or copies.
+- 🌲 File Native Backups with PosixFS: OpenCloud introduces PosixFS to allow for easy file native backups. As all files and metadata information is stored directly on the storage (no database needed), you can create standard file-level snapshots or copies.
Previously, files and folders were stored in a hash-based structure, making the layout unreadable for humans. With PosixFS, the full file tree is directly visible on the storage, providing transparency and confidence that all data is being backed up correctly. Admins benefit from easier maintenance, fewer moving parts, and improved fault tolerance in backup and disaster recovery scenarios.
- **Note:** Before adding, writing, or restoring files directly into the OpenCloud storage, make sure to stop OpenCloud. Once the changes are made, start it again. This ensures that all changes are properly recognized. A future feature, currently in development, called “collaborative storage” will allow external file changes (e.g., via CLI) to be detected in real time by OpenCloud and its clients. + Note: Before adding, writing, or restoring files directly into the OpenCloud storage, make sure to stop OpenCloud. Once the changes are made, start it again. This ensures that all changes are properly recognized. A future feature, currently in development, called “collaborative storage” will allow external file changes (e.g., via CLI) to be detected in real time by OpenCloud and its clients. :::warning[Breaking Change] -**No migration path** – There is no programmatic migration from earlier versions (using decomposedFS) to version 2.0.0. If you need assistance, please reach out in our [Matrix channel](https://matrix.to/#/#opencloud:matrix.org) or open an issue on [GitHub](https://github.com/opencloud-eu/opencloud/issues). This helps us gauge how impactful this change is and respond accordingly. +No migration path – There is no programmatic migration from earlier versions (using decomposedFS) to version 2.0.0. If you need assistance, please reach out in our [Matrix channel](https://matrix.to/#/#opencloud:matrix.org) or open an issue on [GitHub](https://github.com/opencloud-eu/opencloud/issues). This helps us gauge how impactful this change is and respond accordingly. ::: # 2025 March 18 -**Release notes OpenCloud 1.1.0** +Release notes OpenCloud 1.1.0 -- **🎨 Material Design Color Roles**: The custom color framework has been replaced with Material Design color roles. This change standardizes theming by using a small set of base colors to generate a consistent, accessible color palette across the UI. It lays the groundwork for improved visual coherence and better support for dark mode, accessibility, and future theming options. +- 🎨 Material Design Color Roles: The custom color framework has been replaced with Material Design color roles. This change standardizes theming by using a small set of base colors to generate a consistent, accessible color palette across the UI. It lays the groundwork for improved visual coherence and better support for dark mode, accessibility, and future theming options. # 2025 February 25 -**Release notes OpenCloud 1.0.0** +Release notes OpenCloud 1.0.0 Say hello to OpenCloud 1.0.0! A fresh take on secure file sharing & collaboration! Built as a fork of ocis, OpenCloud is all about doing things right. No unnecessary fluff, no distractions—just rock-solid data management, great user experience, secure and convenient administration and an awesome service by our support team. We believe in keeping things simple but powerful. -## **🚀 Key Features at a Glance** +## 🚀 Key Features at a Glance -- **Seamless File Synchronization**: Access your files across all devices. -- **Secure & Flexible File Sharing**: Share files with granular roles, expiration dates, and password protection. -- **Spaces - Collaborative Team Folders**: Ensure continuity even if team members leave. -- **Real-Time Collaboration**: Work on documents simultaneously with Collabora Web Office. -- **Advanced Search & Organization**: Use full-text search, tags, and filters for quick access. -- **Unlimited Storage & Uploads**: No file size restrictions. -- **Privacy-First Design**: Zero-Knowledge principle ensures admins can't access user content. -- **Cross-Client Availability**: Works on Windows, Mac, Linux, Android (soon), iOS (soon), and Web. +- Seamless File Synchronization: Access your files across all devices. +- Secure & Flexible File Sharing: Share files with granular roles, expiration dates, and password protection. +- Spaces - Collaborative Team Folders: Ensure continuity even if team members leave. +- Real-Time Collaboration: Work on documents simultaneously with Collabora Web Office. +- Advanced Search & Organization: Use full-text search, tags, and filters for quick access. +- Unlimited Storage & Uploads: No file size restrictions. +- Privacy-First Design: Zero-Knowledge principle ensures admins can't access user content. +- Cross-Client Availability: Works on Windows, Mac, Linux, Android (soon), iOS (soon), and Web. --- -## **🔄 Cross-Device Synchronization** +## 🔄 Cross-Device Synchronization -- **Automatic Sync**: Keep files up to date across all devices. -- **File Manager Integration**: OpenCloud appears as a native drive in your file explorer. -- **Offline Access**: Work without an internet connection; sync updates when back online. +- Automatic Sync: Keep files up to date across all devices. +- File Manager Integration: OpenCloud appears as a native drive in your file explorer. +- Offline Access: Work without an internet connection; sync updates when back online. --- -## **🔐 Secure File & Link Sharing** +## 🔐 Secure File & Link Sharing -### **File Sharing** +### File Sharing -- **Granular Access Roles**: Assign users as Viewers, Editors, or Uploaders. -- **One-Click Sharing**: Generate share links instantly. -- **Expiration Dates**: Set automatic revocation of shared access. -- **Transparency**: Keep track of who made changes to files and when. -- **Unlimited Sharing**: Share with as many users or groups as needed. +- Granular Access Roles: Assign users as Viewers, Editors, or Uploaders. +- One-Click Sharing: Generate share links instantly. +- Expiration Dates: Set automatic revocation of shared access. +- Transparency: Keep track of who made changes to files and when. +- Unlimited Sharing: Share with as many users or groups as needed. -### **Link Sharing** +### Link Sharing -- **Public Links**: Secure external sharing - no login or account needed. -- **Enforced Password Protection**: Custom rules for password strength. -- **Link Expiry**: Auto-disable links after a set period. -- **Multiple Links per File**: Unique links for different recipients; revoke links individually. -- **Anonymous File Drop**: Secure uploads without access to other files. -- **Built-in Password Generator**: Creates strong passwords automatically. +- Public Links: Secure external sharing - no login or account needed. +- Enforced Password Protection: Custom rules for password strength. +- Link Expiry: Auto-disable links after a set period. +- Multiple Links per File: Unique links for different recipients; revoke links individually. +- Anonymous File Drop: Secure uploads without access to other files. +- Built-in Password Generator: Creates strong passwords automatically. --- -## **📂 Spaces - Collaborative Team Folders** +## 📂 Spaces - Collaborative Team Folders -- **Project-Based Team Folders**: Designed for teams to store, access, and manage files collectively. Files in Spaces belong to **multiple** users, ensuring continuity even if team members leave. -- **Self-Service Admin Transfer**: Easily reassign space owners and assign multiple owners for shared responsibility. -- **Easy Permission Control**: Manage user access based on the roles Viewers, Editors, Managers. +- Project-Based Team Folders: Designed for teams to store, access, and manage files collectively. Files in Spaces belong to multiple users, ensuring continuity even if team members leave. +- Self-Service Admin Transfer: Easily reassign space owners and assign multiple owners for shared responsibility. +- Easy Permission Control: Manage user access based on the roles Viewers, Editors, Managers. --- -## **📝 Real-Time Collaboration – Web Office (Collabora)** +## 📝 Real-Time Collaboration – Web Office (Collabora) -- **Real-Time Editing**: Multiple users can work on documents at the same time. -- **No File Transfers**: Edit directly in the browser always on the latest version. -- **No Software Installation**: Works entirely online, reducing costs and complexity. +- Real-Time Editing: Multiple users can work on documents at the same time. +- No File Transfers: Edit directly in the browser always on the latest version. +- No Software Installation: Works entirely online, reducing costs and complexity. --- -## **🔎 Smart Search & Organization** +## 🔎 Smart Search & Organization -- **Full-Text Search**: Find files quickly, even in scanned documents. -- **Live Search**: Instant results as you type. -- **Image-to-Text Recognition**: Extract text from images and scanned files (OCR - Optical Character Recognition). -- **Advanced Filters**: Search by document type, tags, date, or storage location. +- Full-Text Search: Find files quickly, even in scanned documents. +- Live Search: Instant results as you type. +- Image-to-Text Recognition: Extract text from images and scanned files (OCR - Optical Character Recognition). +- Advanced Filters: Search by document type, tags, date, or storage location. -### **Tags** +### Tags -- **Flexible Organization**: Categorize files beyond folder structures. -- **Quick Search**: Find files faster using keywords. -- **Audit & Compliance**: Ensure traceability of important documents. +- Flexible Organization: Categorize files beyond folder structures. +- Quick Search: Find files faster using keywords. +- Audit & Compliance: Ensure traceability of important documents. --- -## **📜 File Versioning & Recovery** +## 📜 File Versioning & Recovery -- **Easy Recovery**: Roll back to previous file versions. -- **Accidental Change Protection**: Recover files in case of unintended edits. -- **Deleted File Recovery**: Restore files from the trash bin. +- Easy Recovery: Roll back to previous file versions. +- Accidental Change Protection: Recover files in case of unintended edits. +- Deleted File Recovery: Restore files from the trash bin. --- -## **⚡ High-Performance, User-Friendly Interface** +## ⚡ High-Performance, User-Friendly Interface -- **Familiar Desktop Features**: - - **Right-click** context menus. - - **Drag & Drop** support between web and desktop. - - **Keyboard Shortcuts**: (Ctrl + C, Ctrl + X, Ctrl + V). - - **Multi-Selection**: (Ctrl + Click, Shift + Click). -- **Instant UI Updates**: No need to refresh when a file is modified. +- Familiar Desktop Features: + - Right-click context menus. + - Drag & Drop support between web and desktop. + - Keyboard Shortcuts: (Ctrl + C, Ctrl + X, Ctrl + V). + - Multi-Selection: (Ctrl + Click, Shift + Click). +- Instant UI Updates: No need to refresh when a file is modified. --- -## **🛡️ Security & Compliance** +## 🛡️ Security & Compliance -### **File Firewall** +### File Firewall -- **Block Malicious Uploads**: Prevent unwanted file types like **.exe or macro files**. -- **Allowlist & Denylist Support**: Define permitted and blocked file types. +- Block Malicious Uploads: Prevent unwanted file types like .exe or macro files. +- Allowlist & Denylist Support: Define permitted and blocked file types. -### **ICAP Antivirus Interface** +### ICAP Antivirus Interface -- **Automated Malware Scanning**: Scan all uploaded files before they reach user devices. -- **Early Threat Detection**: Prevent infections before they spread. -- **Compliance Assurance**: Meets security standards for home and enterprise storage. +- Automated Malware Scanning: Scan all uploaded files before they reach user devices. +- Early Threat Detection: Prevent infections before they spread. +- Compliance Assurance: Meets security standards for home and enterprise storage. -### **Zero-Knowledge Principle** +### Zero-Knowledge Principle -- **Admin Privacy Controls**: Admins manage spaces without accessing file content. -- **User-Owned Data**: Only designated users can access stored files. +- Admin Privacy Controls: Admins manage spaces without accessing file content. +- User-Owned Data: Only designated users can access stored files. -### **Access Control** +### Access Control -- **Granular Permission Management**: Role-Based Access Control. +- Granular Permission Management: Role-Based Access Control. -### **GDPR & Accessibility Compliance** +### GDPR & Accessibility Compliance -- **GDPR Compliant**: Fully meets **EU data protection regulations**. -- **BITV 2.0 / WCAG 2.1 Compliance**: Ensures **accessible** web usage for all users. +- GDPR Compliant: Fully meets EU data protection regulations. +- BITV 2.0 / WCAG 2.1 Compliance: Ensures accessible web usage for all users. --- -## **📦 Unlimited File Size** +## 📦 Unlimited File Size -- **No File Size Limits**: Upload large files without restrictions. +- No File Size Limits: Upload large files without restrictions. --- -## **🛠️ Web Extension System** +## 🛠️ Web Extension System -- **Extension System**: Add new features and third-party integrations. -- **Custom UI Adjustments**: Modify the interface based on specific needs. -- **Simple Installation & Management**: Easily install and manage extensions. +- Extension System: Add new features and third-party integrations. +- Custom UI Adjustments: Modify the interface based on specific needs. +- Simple Installation & Management: Easily install and manage extensions. --- -## **🏗️ On-Premise** +## 🏗️ On-Premise -- **On-Premise**: Fully self-hosted deployment for maximum control. +- On-Premise: Fully self-hosted deployment for maximum control. --- -## **🖼️ Built-in File Preview** +## 🖼️ Built-in File Preview -- **Supports Common Formats**: Preview images and browser-compatible videos directly in OpenCloud. +- Supports Common Formats: Preview images and browser-compatible videos directly in OpenCloud. --- -## **🌐 Multi-Platform Availability** +## 🌐 Multi-Platform Availability -- **Compatible with**: Windows, Mac, Linux, **Android (soon), iOS (soon),** and Web. +- Compatible with: Windows, Mac, Linux, Android (soon), iOS (soon), and Web. diff --git a/docs/dev/web/testing/running-tests.md b/docs/dev/web/testing/running-tests.md index d439adbf..540ac86f 100644 --- a/docs/dev/web/testing/running-tests.md +++ b/docs/dev/web/testing/running-tests.md @@ -14,7 +14,7 @@ This section assumes you have the Web development stack up and running. Please c We have a steadily growing coverage of unit tests. You can run them locally via -```shell +```bash pnpm test:unit ``` @@ -41,7 +41,7 @@ which makes it easy to write tests, debug them and have them run cross-browser w Make sure the Web frontend has been bundled with the following command since the dev server won't work: -```shell +```bash pnpm build:w ``` @@ -49,7 +49,7 @@ pnpm build:w The following command will run all available e2e tests: -```shell +```bash pnpm test:e2e:cucumber 'tests/e2e/cucumber/**/*.feature' ``` @@ -79,7 +79,7 @@ Again, you can use the following ENV variables in your command: To then open e.g. the tracing from the `REPORT_DIR`, run -```shell +```bash npx playwright show-trace path/to/file.zip ``` @@ -87,13 +87,13 @@ npx playwright show-trace path/to/file.zip Run the following command to find out the lint issues early in the test codes: -```shell +```bash pnpm lint ``` And to fix the lint problems run the following command: -```shell +```bash pnpm lint --fix ``` diff --git a/docs/user/android-app/shares/invite.md b/docs/user/android-app/shares/invite.md index a33df2b5..decc20ad 100644 --- a/docs/user/android-app/shares/invite.md +++ b/docs/user/android-app/shares/invite.md @@ -9,33 +9,33 @@ draft: true

-## Here we explain how to share files and folders via invitation with other people and groups within your OpenCloud in the OpenCloud Android app +Here we explain how to share files and folders via invitation with other people and groups within your OpenCloud in the OpenCloud Android app --- -#### 1. Click the "three-dot menue" next to the file or folder +## 1. Click the "three-dot menue" next to the file or folder
-#### 2. Now select the menue item "Share" +## 2. Now select the menue item "Share"
-#### 3. In the following selection, click on the Plus at "Users and Groups" +## 3. In the following selection, click on the Plus at "Users and Groups"
-#### 4. The Share menue opens, where you can use the search bar to search for people or groups you want to invite +## 4. The Share menue opens, where you can use the search bar to search for people or groups you want to invite
-#### 5. Here you can select which permissions people and groups should have:
+## 5. Here you can select which permissions people and groups should have:
@@ -48,11 +48,11 @@ draft: true
-#### 6. To create the link you must click on "Invite" +## 6. To create the link you must click on "Invite"
-#### 7. Once the invitation is created, you will see it in the file or folder overview +## 7. Once the invitation is created, you will see it in the file or folder overview diff --git a/docs/user/android-app/shares/links.md b/docs/user/android-app/shares/links.md index 7ef7ac02..3ba92211 100644 --- a/docs/user/android-app/shares/links.md +++ b/docs/user/android-app/shares/links.md @@ -13,32 +13,32 @@ draft: true --- -#### 1. Click the three-dot menue next to the file or folder +### 1. Click the three-dot menue next to the file or folder
-#### 2. Now select the menue item “Share” +### 2. Now select the menue item “Share”
-#### 3. In the following selection, click on "Public link" +### 3. In the following selection, click on "Public link"
-#### 4. Here you can select and specify several options for the link to be created +### 4. Here you can select and specify several options for the link to be created
-#### 5. Enter a name for your link here +### 5. Enter a name for your link here
-#### 6. Here you can select which function your link should have:
+### 6. Here you can select which function your link should have:
@@ -55,21 +55,21 @@ draft: true
-#### 7. You must enter a password here. You can choose your own or have one generated for you +### 7. You must enter a password here. You can choose your own or have one generated for you
-#### 8. Here you can specify a period of time for which the link should be available +### 8. Here you can specify a period of time for which the link should be available
-#### 9. To create the link you must now click on "Share" +### 9. To create the link you must now click on "Share"
-#### 10. Once the link is created, you will see it with the assigned name in the file or folder overview +### 10. Once the link is created, you will see it with the assigned name in the file or folder overview diff --git a/docs/user/android-app/shortcuts.md b/docs/user/android-app/shortcuts.md index ede33037..3e6a42f8 100644 --- a/docs/user/android-app/shortcuts.md +++ b/docs/user/android-app/shortcuts.md @@ -11,42 +11,42 @@ draft: true --- -#### 1. Click on the "Plus symbol" +### 1. Click on the "Plus symbol"
-#### 2. A drop-down menue opens +### 2. A drop-down menue opens
-#### 3. Select "New shortcut" +### 3. Select "New shortcut"
-#### 4. A menue opens with options for shortcuts +### 4. A menue opens with options for shortcuts
-#### 5. To create a shortcut to a website, enter the address of the website under "URL" +### 5. To create a shortcut to a website, enter the address of the website under "URL"
-#### 6. Here you enter a name for the shortcut with which it will be displayed +### 6. Here you enter a name for the shortcut with which it will be displayed
-#### 7. To create the shortcut, click on "Create" +### 7. To create the shortcut, click on "Create"
-#### 8. Your created shortcut is now displayed and can be used +### 8. Your created shortcut is now displayed and can be used
diff --git a/docs/user/android-app/spaces.md b/docs/user/android-app/spaces.md index 11802d95..46005122 100644 --- a/docs/user/android-app/spaces.md +++ b/docs/user/android-app/spaces.md @@ -9,11 +9,11 @@ draft: true
-#### The **"Spaces" section** provides a central place for collaboration in groups or teams. In a Space, multiple users can access files and folders together, organize content, and track changes +The **"Spaces" section** provides a central place for collaboration in groups or teams. In a Space, multiple users can access files and folders together, organize content, and track changes --- -### Spaces Overview +## Spaces Overview To open the **Spaces Overview**, tap the **"Spaces button"** in the bottom line of the the screen. @@ -27,7 +27,7 @@ Afterwards, the **Spaces Overview** appears, listing all Spaces you are a member --- -### Search Function +## Search Function By tapping the **search icon**, the searchbar and the search menue for Spaces will open. @@ -39,7 +39,7 @@ By tapping the **search icon**, the searchbar and the search menue for Spaces wi --- -### Functions within a Space +## Functions within a Space By tapping the **plus icon**, the available functions within a Space appear. diff --git a/docs/user/desktop-client/installation.md b/docs/user/desktop-client/installation.md index fd22ba2f..a43b4a5c 100644 --- a/docs/user/desktop-client/installation.md +++ b/docs/user/desktop-client/installation.md @@ -14,7 +14,7 @@ The OpenCloud Desktop client is available for **Windows**, **macOS**, and **Linu 1. Open the **Microsoft Store** and search for **OpenCloud Desktop** or click on the image below - + Download from Microsoft Store 2. Click **Install** 3. Once installed, launch the app from your Start Menu diff --git a/docs/user/files-and-folders/upload-download-unzip.md b/docs/user/files-and-folders/upload-download-unzip.md index afeccc63..f5b761de 100644 --- a/docs/user/files-and-folders/upload-download-unzip.md +++ b/docs/user/files-and-folders/upload-download-unzip.md @@ -8,7 +8,7 @@ title: Upload - Download - Unzip

-### Upload: Upload files or folders +## Upload: Upload files or folders - **Start uploading:** - Click on **“Upload”** in the **action bar**. upload button @@ -28,7 +28,7 @@ title: Upload - Download - Unzip --- -### Download: Download files or folders +## Download: Download files or folders - **Select the desired files or folders by either:** - Clicking in the **file line** @@ -41,7 +41,7 @@ title: Upload - Download - Unzip - Select **“Download”** from the **menu**.

-#### ZIP files +### ZIP files - If you **download several** files or folders, these are **saved as a ZIP file**. download several files in zip file diff --git a/docs/user/intro.md b/docs/user/intro.md index 9cb14954..a1fc22a8 100644 --- a/docs/user/intro.md +++ b/docs/user/intro.md @@ -2,9 +2,13 @@ sidebar_position: 1 --- + + import OcLogoPetrol from '/static/img/oc-logo-petrol.svg'; import OcLogoLilac from '/static/img/oc-logo-lilac.svg'; + + # Welcome @@ -12,7 +16,8 @@ import OcLogoLilac from '/static/img/oc-logo-lilac.svg'; ## Welcome to the OpenCloud knowledge base -Here you will find all the important information to successfully take the first steps in OpenCloud, to be able to solve technical problems flexibly yourself and to be able to answer frequently asked questions. +Here you will find all the important information to successfully take the first steps in OpenCloud, to be able to solve +technical problems flexibly yourself and to be able to answer frequently asked questions.

### Table of contents @@ -54,9 +59,12 @@ Here you will find information on what options admins have and how you can use t OpenCloud is the file sharing and collaboration solution of the Heinlein Group. -Through intelligent file management and a strong open source community, files become valuable resources, effectively structured and usable in the long term. With flexible data rooms and intelligent access rights, teams can access and work together on data anytime, anywhere without barriers, but with a lot of productivity. +Through intelligent file management and a strong open source community, files become valuable resources, effectively +structured and usable in the long term. With flexible data rooms and intelligent access rights, teams can access and +work together on data anytime, anywhere without barriers, but with a lot of productivity.

### How can I use OpenCloud? -Instructions on how to install and set up your own OpenCloud can be found in the "Admin Documentation" under "Quick Start". +Instructions on how to install and set up your own OpenCloud can be found in the "Admin Documentation" under "Quick +Start". diff --git a/docs/user/ios-app/shares/invite.md b/docs/user/ios-app/shares/invite.md index c1cd08e2..1dc20c52 100644 --- a/docs/user/ios-app/shares/invite.md +++ b/docs/user/ios-app/shares/invite.md @@ -12,29 +12,29 @@ title: Invite to share --- -#### 1. Click the "three-dot menue" next to the file or folder +### 1. Click the "three-dot menue" next to the file or folder Three-dot menue
-#### 2. Now select the menue item "Share" +### 2. Now select the menue item "Share" Teilen
-#### 3. In the following selection, click on "Share with" +### 3. In the following selection, click on "Share with" Teilen mit
-#### 4. The Share menue opens, where you can use the search bar to search for people or groups you want to invite +### 4. The Share menue opens, where you can use the search bar to search for people or groups you want to invite Share with menue Search bar Selection of people and/or groups
-#### 5. Here you can select which permissions people and groups should have:
+### 5. Here you can select which permissions people and groups should have:
permissions @@ -47,11 +47,11 @@ title: Invite to share
-#### 6. To create the link you must click on "Invite" +### 6. To create the link you must click on "Invite" invite
-#### 7. Once the invitation is created, you will see it in the file or folder overview +### 7. Once the invitation is created, you will see it in the file or folder overview shared with diff --git a/docs/user/ios-app/shares/links.md b/docs/user/ios-app/shares/links.md index dddc207f..4d8350bc 100644 --- a/docs/user/ios-app/shares/links.md +++ b/docs/user/ios-app/shares/links.md @@ -8,36 +8,36 @@ title: Share via link

-## Here we explain how to share files and folders with others via link in the OpenCloud iOS app +Here we explain how to share files and folders with others via link in the OpenCloud iOS app --- -#### 1. Click the three-dot menue next to the file or folder +## 1. Click the three-dot menue next to the file or folder three-dot menue
-#### 2. Now select the menue item “Share” +## 2. Now select the menue item “Share” share
-#### 3. In the following selection, click on "Create link" +## 3. In the following selection, click on "Create link" Create link
-#### 4. Here you can select and specify several options for the link to be created +## 4. Here you can select and specify several options for the link to be created Overview link menue
-#### 5. Enter a name for your link here +## 5. Enter a name for your link here Linkname
-#### 6. Here you can select which function your link should have:
+## 6. Here you can select which function your link should have:
Share options @@ -54,21 +54,21 @@ title: Share via link
-#### 7. You must enter a password here. You can choose your own or have one generated for you +## 7. You must enter a password here. You can choose your own or have one generated for you Password
-#### 8. Here you can specify a period of time for which the link should be available +## 8. Here you can specify a period of time for which the link should be available Link expiration date
-#### 9. To create the link you must now click on "Share" +## 9. To create the link you must now click on "Share" Share
-#### 10. Once the link is created, you will see it with the assigned name in the file or folder overview +## 10. Once the link is created, you will see it with the assigned name in the file or folder overview created link diff --git a/docs/user/ios-app/shortcuts.md b/docs/user/ios-app/shortcuts.md index a6bb73f1..1234c7c2 100644 --- a/docs/user/ios-app/shortcuts.md +++ b/docs/user/ios-app/shortcuts.md @@ -6,53 +6,53 @@ title: Shortcut in the OpenCloud iOS app # Shortcut in the OpenCloud iOS app -## Here we show you how to create shortcuts in the iOS app +Here we show you how to create shortcuts in the iOS app --- -#### 1. Click on the "Plus symbol" +## 1. Click on the "Plus symbol" Plus symbol
-#### 2. A drop-down menue opens +## 2. A drop-down menue opens drop-down menue
-#### 3. Select "Create shortcut" +## 3. Select "Create shortcut" Select create shortcut
-#### 4. A menue opens with options for shortcuts +## 4. A menue opens with options for shortcuts shortcut menue
-#### 5. To create a shortcut to a website, enter the address of the website under "URL" +## 5. To create a shortcut to a website, enter the address of the website under "URL" URL
-#### 6. To create a shortcut to a file or folder in OpenCloud, click the "Select file or folder" option +## 6. To create a shortcut to a file or folder in OpenCloud, click the "Select file or folder" option Select file or folder option Select file or folder Select
-#### 7. Here you enter a name for the shortcut with which it will be displayed +## 7. Here you enter a name for the shortcut with which it will be displayed Name of the shortcut
-#### 8. To create the shortcut, click on "Create shortcut" +## 8. To create the shortcut, click on "Create shortcut" Create shortcut
-#### 9. Your created shortcut is now displayed and can be used +## 9. Your created shortcut is now displayed and can be used Shortcut
diff --git a/docs/user/ios-app/spaces.md b/docs/user/ios-app/spaces.md index 9ded3ca4..ccb588ac 100644 --- a/docs/user/ios-app/spaces.md +++ b/docs/user/ios-app/spaces.md @@ -8,11 +8,11 @@ title: Spaces
-#### The **"Spaces" section** provides a central place for collaboration in groups or teams. In a Space, multiple users can access files and folders together, organize content, and track changes +The **"Spaces" section** provides a central place for collaboration in groups or teams. In a Space, multiple users can access files and folders together, organize content, and track changes --- -### Spaces Overview +## Spaces Overview To open the **Spaces Overview**, tap the **"Spaces button"** in the account menu. @@ -25,7 +25,7 @@ Afterwards, the **Spaces Overview** appears, listing all Spaces you are a member --- -### Search Function +## Search Function By tapping the **search icon**, the search menue for Spaces will open. @@ -37,7 +37,7 @@ By tapping the **search icon**, the search menue for Spaces will open. --- -### Functions within a Space +## Functions within a Space By tapping the **plus icon**, the available functions within a Space appear. @@ -77,7 +77,7 @@ By tapping the **plus icon**, the available functions within a Space appear. --- -### The "Three-Dot Menue" +## The "Three-Dot Menue" By tapping the **three-dot menue**, a pop-up menue opens where you can choose to make the Space available offline. diff --git a/docs/user/roles/share-roles.md b/docs/user/roles/share-roles.md index 51074cbc..b705f583 100644 --- a/docs/user/roles/share-roles.md +++ b/docs/user/roles/share-roles.md @@ -4,7 +4,7 @@ id: share-roles title: Share roles in OpenCloud --- -### Sharing Roles in OpenCloud +## Sharing Roles in OpenCloud | Role | view | download | upload | edit | add | delete | only view doc, img, pdf with watermark | | :---------------- | :--: | :------: | :----: | :--: | :-: | :----: | :------------------------------------: | @@ -13,7 +13,7 @@ title: Share roles in OpenCloud | can upload | x | x | x | - | - | - | - | | can edit | x | x | x | x | x | x | - | -# Space Member Roles and Permissions +## Space Member Roles and Permissions In a Space, members can have different roles that determine what they can do with shared files and folders. @@ -37,4 +37,4 @@ In a Space, members can have different roles that determine what they can do wit - You can edit, add, and delete files and folders. - Full access to modify shared content. -**Each role gives a different level of access, ensuring the right permissions for each user!** +Each role gives a different level of access, ensuring the right permissions for each user! diff --git a/docs/user/sharing/external.md b/docs/user/sharing/external.md index 761c2576..e5f8bb8f 100644 --- a/docs/user/sharing/external.md +++ b/docs/user/sharing/external.md @@ -8,37 +8,37 @@ title: External
-### Public links - external sharing of files and folders in OpenCloud +## Public links - external sharing of files and folders in OpenCloud With **public links**, you can share files and/or folders **across organizations**.

-### **Here are the steps to create a public link** +## **Here are the steps to create a public link** -##

+

-#### Open sharing options +### Open sharing options Click on the **“three dot menu”** next to the file or folder name you want to share. three dot menu -#### Select Share +### Select Share Select **“Share”** from the drop-down menu. select share -#### Open sidebar window +### Open sidebar window A sidebar window will open on the right side of the screen. sidebar window -#### Add public link +### Add public link Scroll down in the sidebar window and click on **“Add link”**. click on add link add link button -#### Set options for the public link +### Set options for the public link **A pop-up window** will open where you can configure the following options: pop up window @@ -46,9 +46,9 @@ Scroll down in the sidebar window and click on **“Add link”**. --- -### Options in the pop-up window +## Options in the pop-up window -#### Rights for the link +### Rights for the link - Select the desired **access rights** for the recipients: - **“Can view"**: The link recipient can view and download the file, but cannot edit or upload files. @@ -56,7 +56,7 @@ Scroll down in the sidebar window and click on **“Add link”**. - **“File Drop (secret)"**: The link recipient can only upload files, but cannot view or edit the content. Admin spaces -#### Set password for the link +### Set password for the link - Activate the password by entering it in the input field under **“Password”**. - The password requirements appear below the input field. @@ -69,7 +69,7 @@ Scroll down in the sidebar window and click on **“Add link”**. - The last icon generates a random password automatically. generate random password -#### Set expiration date for the link +### Set expiration date for the link - Enter a date under “Expiry date” to set a time limit for the link. Once the date has expired, the link is no longer accessible. - If you do not enter a date, the link will not expire. @@ -77,7 +77,7 @@ Scroll down in the sidebar window and click on **“Add link”**. --- -### Create link +## Create link - Once all options have been set, click on **“Copy link”** to generate the public link. copy link @@ -85,4 +85,4 @@ Scroll down in the sidebar window and click on **“Add link”**. --- -**Now you know how you can share files and folders securely and individually with external users.** +Now you know how you can share files and folders securely and individually with external users. diff --git a/docs/user/sharing/file-drop.md b/docs/user/sharing/file-drop.md index ab41e75b..e7fc3cec 100644 --- a/docs/user/sharing/file-drop.md +++ b/docs/user/sharing/file-drop.md @@ -34,7 +34,7 @@ The **“File Drop”** allows people who receive a specific link (the so-called select file drop

- Type a **password** and confirm the entries with click on **"copy link"**. -- You can also set an **"Expiry date"**, if you want the link to expire. [Click here](./external), if you want to know how to set the Expiry date. +- You can also set an **"Expiry date"**, if you want the link to expire. [External Sharing](./external), if you want to know how to set the Expiry date. enter password and copy link

- Now you send the **link** and the **password** to a **"link recipient"**. @@ -63,4 +63,4 @@ The **“link recipient”** does not have access to existing files - **they can --- -**Now you know how you can share a file drop link** +Now you know how you can share a file drop link diff --git a/docs/user/sharing/internal.md b/docs/user/sharing/internal.md index 1a59c066..2aebb605 100644 --- a/docs/user/sharing/internal.md +++ b/docs/user/sharing/internal.md @@ -11,22 +11,22 @@ title: Internal
--- -#### Open sharing options +## Open sharing options Click on the **“three dot menu”** next to the file or folder name you want to share. three dot menu -#### Select share +## Select share Select **“Share”** from the drop-down menu. drop down menu -#### Sidebar window appears +## Sidebar window appears A sidebar window will open on the right-hand side of the screen. sidebar window -#### Set up internal sharing +## Set up internal sharing - At the top of the sidebar window, you will find the area for **“Internal sharing”**. share with people @@ -34,7 +34,7 @@ A sidebar window will open on the right-hand side of the screen. enter name or group - Select the people or groups with whom you would like to share the folder or file. -#### Set access rights +## Set access rights - Select the rights for the selected members or groups: - **“Can view":** Members can only view and download the file, but cannot edit it or upload it to shared folders. - **“Can upload":** Members can view and download the file and upload their own files to the shared folder. - **“Can edit":** Members have the same rights as in **"can upload"**, but can also create new files, edit existing files and delete them. drop down rights @@ -42,7 +42,7 @@ A sidebar window will open on the right-hand side of the screen. --- -### Confirm sharing +## Confirm sharing - Click on **“Share”** to confirm the selection. share button diff --git a/docs/user/spaces/customize.md b/docs/user/spaces/customize.md index f64dfa26..0da932ff 100644 --- a/docs/user/spaces/customize.md +++ b/docs/user/spaces/customize.md @@ -12,7 +12,8 @@ You can customize your Space in two places: - In the Space overview - In the Space itself -

+ +

--- @@ -20,52 +21,57 @@ You can customize your Space in two places: #### Open “Context Menu” -- Click on the “Context menu” in the Space overview or directly in the Space. -

+Click on the “Context menu” in the Space overview or directly in the Space. + +

--- ### Make adjustments -#### Here you can change the following options +#### Edit description + +Write your description in the opened texteditor, save and close it. + +Description Texteditor +Description changed + +

-- **Edit description** +#### Edit subtitle - - Write your description in the opened texteditor, save and close it. - Description Texteditor - Description changed +In the pop-up window, write your subtitle and confirm. -

+Subtitle Pop-up +Subtitle changed -- **Edit subtitle** +

- - In the pop-up window, write your subtitle and confirm - Subtitle Pop-up - Subtitle changed +#### Edit image -

+Select the image you want for your Space from the pop-up window and confirm. -- **Edit image** +Select folder picture +Folder picture changed - - Select the image you want for your Space from the pop-up window and confirm - Select folder picture - Folder picture changed +

-

+#### Set an icon -- **Set an icon** +Select the icon you want for your Space from the pop-up window. - - Select the icon you want for your Space from the pop-up window - Select Icon - Icon changed +Select Icon +Icon changed -

+

#### Change description directly -- The description of the Space can also be changed directly in the Space by clicking on the **pen** next to the description. - Icon changed -

+The description of the Space can also be changed directly in the Space by clicking on the **pen** next to the description. + +Icon changed + +

--- diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/android-app/shares/invite.md b/i18n/de/docusaurus-plugin-content-docs/current/user/android-app/shares/invite.md index b4dfb0b1..d6433e65 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/user/android-app/shares/invite.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/user/android-app/shares/invite.md @@ -9,33 +9,33 @@ draft: true

-## Hier erklären wir, wie man in der OpenCloud Android-App, Dateien und Ordner per Einladung mit anderen Personen und Gruppen innerhalb der eigenen OpenCloud teilt +Hier erklären wir, wie man in der OpenCloud Android-App, Dateien und Ordner per Einladung mit anderen Personen und Gruppen innerhalb der eigenen OpenCloud teilt --- -#### 1. Klicken Sie auf das "Drei-Punkte-Menü" neben der Datei oder Ordner +## 1. Klicken Sie auf das "Drei-Punkte-Menü" neben der Datei oder Ordner Drei-Punkte-Menü
-#### 2. Wählen Sie nun den Menüpunkt "Teilen" aus +## 2. Wählen Sie nun den Menüpunkt "Teilen" aus Teilen
-#### 3. In der folgenden Auswahl klicken Sie auf "Teilen mit" +## 3. In der folgenden Auswahl klicken Sie auf "Teilen mit" Teilen mit
-#### 4. Es öffnet sich das Teilen Menü, in dem Sie über die Suchleiste nach Personen oder Gruppen suchen können, die Sie einladen möchten +## 4. Es öffnet sich das Teilen Menü, in dem Sie über die Suchleiste nach Personen oder Gruppen suchen können, die Sie einladen möchten Teilen mit Menü Suchleiste Auswahl Personen und/oder Gruppen
-#### 5. Hier können Sie auswählen welche Berechtiigungen Personen und Gruppen haben sollen:
+## 5. Hier können Sie auswählen welche Berechtiigungen Personen und Gruppen haben sollen:
Berechtigungen @@ -47,11 +47,11 @@ draft: true Hier können die Berechtigungen individuell gewählt werden.
-#### 6. Um den Link nun zu erstellen müssen Sie auf "Einladen" klicken +## 6. Um den Link nun zu erstellen müssen Sie auf "Einladen" klicken Einladen
-#### 7. Wenn die Einladung erstellt ist, sehen Sie diese in der Datei- oder Ordnerübersicht +## 7. Wenn die Einladung erstellt ist, sehen Sie diese in der Datei- oder Ordnerübersicht geteilt mit diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/android-app/shares/links.md b/i18n/de/docusaurus-plugin-content-docs/current/user/android-app/shares/links.md index ca8c4c76..31afe466 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/user/android-app/shares/links.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/user/android-app/shares/links.md @@ -9,36 +9,36 @@ draft: true

-## Hier erklären wir, wie man in der OpenCloud Android-App, Dateien und Ordner per Link mit anderen teilt +Hier erklären wir, wie man in der OpenCloud Android-App, Dateien und Ordner per Link mit anderen teilt --- -#### 1. Klicken Sie auf das "Drei-Punkte-Menü" neben der Datei oder Ordner +## 1. Klicken Sie auf das "Drei-Punkte-Menü" neben der Datei oder Ordner Drei-Punkte-Menü
-#### 2. Wählen Sie nun den Menüpunkt "Teilen" aus +## 2. Wählen Sie nun den Menüpunkt "Teilen" aus Teilen
-#### 3. In der folgenden Auswahl klicken Sie auf "Link erstellen" +## 3. In der folgenden Auswahl klicken Sie auf "Link erstellen" Link erstellen
-#### 4. Hier können Sie mehrere Optionen für den zu erstellenden Link auswählen und angeben +## 4. Hier können Sie mehrere Optionen für den zu erstellenden Link auswählen und angeben Übersicht Link Menü
-#### 5. Geben Sie hier einen Namen ein wie Ihr Link heißen soll +## 5. Geben Sie hier einen Namen ein wie Ihr Link heißen soll Linkname
-#### 6. Hier können Sie auswählen welche Funktion Ihr Link haben soll:
+## 6. Hier können Sie auswählen welche Funktion Ihr Link haben soll:
Teilen Optionen @@ -54,21 +54,21 @@ draft: true Personen können die Inhalte des Links anzeigen, herunterladen, Dateien hochladen, bearbeiten und erstellen.
-#### 7. Hier muss ein Passwort eingetragen werden. Sie können selbst eines vergeben oder sich eines generieren lassen +## 7. Hier muss ein Passwort eingetragen werden. Sie können selbst eines vergeben oder sich eines generieren lassen Passwort
-#### 8. Hier können Sie einen Zeitraum angeben, wie lange der Link verfügbar sein soll +## 8. Hier können Sie einen Zeitraum angeben, wie lange der Link verfügbar sein soll Link Verfallsdatum
-#### 9. Um den Link nun zu erstellen müssen Sie auf "Teilen" klicken +## 9. Um den Link nun zu erstellen müssen Sie auf "Teilen" klicken Teilen
-#### 10. Wenn der Link erstellt ist, sehen Sie diesen mit dem vergebenen Namen in der Datei- oder Ordnerübersicht +## 10. Wenn der Link erstellt ist, sehen Sie diesen mit dem vergebenen Namen in der Datei- oder Ordnerübersicht erstellter link diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/android-app/shortcuts.md b/i18n/de/docusaurus-plugin-content-docs/current/user/android-app/shortcuts.md index b8f6a34e..045563af 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/user/android-app/shortcuts.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/user/android-app/shortcuts.md @@ -7,53 +7,53 @@ draft: true # Verlinkungen in der OpenCloud Android App -## Hier zeigen wir, wie Sie Verlinkungen in der Android App erstellen können +Hier zeigen wir, wie Sie Verlinkungen in der Android App erstellen können --- -#### 1. Klicken Sie auf das "Plus-Symbol" +## 1. Klicken Sie auf das "Plus-Symbol" Plus Symbol
-#### 2. Es öffnet sich ein Drop-Down-Menü +## 2. Es öffnet sich ein Drop-Down-Menü Drop Down Menü
-#### 3. Wählen Sie dort "Verlinkung erstellen" aus +## 3. Wählen Sie dort "Verlinkung erstellen" aus Verlinkung erstellen auswählen
-#### 4. Es öffnet sich ein Menü mit Auswahlmöglichkeiten für die Verlinkung +## 4. Es öffnet sich ein Menü mit Auswahlmöglichkeiten für die Verlinkung Verlinkung Menü
-#### 5. Um eine Verlinkung zu einer Webseite zu erstellen, geben sie unter "URL" die Adresse der Webseite ein +## 5. Um eine Verlinkung zu einer Webseite zu erstellen, geben sie unter "URL" die Adresse der Webseite ein URL
-#### 6. Um eine Verlinkung zu einer Datei oder einem Ordner in der OpenCloud zu erstellen, muss die Option "Datei oder Ordner auswählen" geklickt werden +## 6. Um eine Verlinkung zu einer Datei oder einem Ordner in der OpenCloud zu erstellen, muss die Option "Datei oder Ordner auswählen" geklickt werden Datei oder Ordner auswählen Option Datei oder Ordner auswählen Auswählen
-#### 7. Hier geben Sie einen Namen für die Verlinkung ein, mit der diese dann dargestellt wird +## 7. Hier geben Sie einen Namen für die Verlinkung ein, mit der diese dann dargestellt wird Name der Verlinkung
-#### 8. Um die Verlinkung nun zu erstellen, klicken Sie auf "Verlinkung erstellen" +## 8. Um die Verlinkung nun zu erstellen, klicken Sie auf "Verlinkung erstellen" Verlinkung erstellen
-#### 9. Jetzt wird Ihre erstellte Verlinkung angezeigt und kann genutzt werden +## 9. Jetzt wird Ihre erstellte Verlinkung angezeigt und kann genutzt werden Verlinkung
diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/android-app/spaces.md b/i18n/de/docusaurus-plugin-content-docs/current/user/android-app/spaces.md index 26dbd916..09c30c59 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/user/android-app/spaces.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/user/android-app/spaces.md @@ -9,11 +9,11 @@ draft: true
-#### Der **„Spaces“-Bereich** (zu Deutsch: **„Bereiche“**) bietet einen zentralen Ort für die Zusammenarbeit in Gruppen oder Teams. In einem Space können mehrere Nutzer gemeinsam auf Dateien und Ordner zugreifen, Inhalte organisieren und Änderungen nachvollziehen +Der **„Spaces“-Bereich** (zu Deutsch: **„Bereiche“**) bietet einen zentralen Ort für die Zusammenarbeit in Gruppen oder Teams. In einem Space können mehrere Nutzer gemeinsam auf Dateien und Ordner zugreifen, Inhalte organisieren und Änderungen nachvollziehen --- -### Spaces Übersicht +## Spaces Übersicht Um zur **"Spaces Übersicht"** zu gelangen, klicken wir erst auf die **"Spaces-Schaltfläche"** im Account-Menü. Spaces-Schaltfläche @@ -24,7 +24,7 @@ Im Anschluss sehen wir die **"Spaces-Übersicht"**, in der alle Spaces aufgelist --- -### Such Funktion +## Such Funktion Durch klicken auf das **"Such-Symbol"**, öffnet sich das Menü für die Suche innerhalb der Spaces. @@ -36,7 +36,7 @@ Durch klicken auf das **"Such-Symbol"**, öffnet sich das Menü für die Suche i --- -### Funktionen innerhalb eines Spaces +## Funktionen innerhalb eines Spaces Durch klicken auf das **"Plus-Symbol"** öffnen wir die Funktionen innerhalb eines Spaces. Plus Symbol @@ -75,7 +75,7 @@ Durch klicken auf das **"Plus-Symbol"** öffnen wir die Funktionen innerhalb ein --- -### Das "Drei-Punkte-Menü" +## Das "Drei-Punkte-Menü" Durch klicken auf das **"Drei-Punkte-Menü"**, öffnet sich ein Pop-up Menü, in dem wir einstellen können, ob der Space offline verfügbar sein soll oder nicht. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/desktop-client/installation.md b/i18n/de/docusaurus-plugin-content-docs/current/user/desktop-client/installation.md index 33bb7677..88a30079 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/user/desktop-client/installation.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/user/desktop-client/installation.md @@ -14,7 +14,7 @@ Der OpenCloud Desktop-Client ist für **Windows**, **macOS** und **Linux** verf 1. Öffnen Sie den **Microsoft Store** und suchen Sie nach **OpenCloud Desktop** oder klicken Sie auf das Bild unten. - + Download from Microsoft Store 2. Klicken Sie auf **Installieren**. 3. Starten Sie die App nach der Installation über Ihr Startmenü. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/intro.md b/i18n/de/docusaurus-plugin-content-docs/current/user/intro.md index cfdecbcb..a8d60da7 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/user/intro.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/user/intro.md @@ -2,9 +2,13 @@ sidebar_position: 1 --- + + import OcLogoPetrol from '/static/img/oc-logo-petrol.svg'; import OcLogoLilac from '/static/img/oc-logo-lilac.svg'; + + # Willkommen @@ -12,7 +16,8 @@ import OcLogoLilac from '/static/img/oc-logo-lilac.svg'; ## Wilkommen zur OpenCloud Wissensdatenbank -Hier finden Sie alle wichtigen Informationen, um erfolgreich die ersten Schritte in OpenCloud zu gehen, technische Probleme flexibel selber zu beheben und häufig gestellte Fragen zu beantworten. +Hier finden Sie alle wichtigen Informationen, um erfolgreich die ersten Schritte in OpenCloud zu gehen, technische +Probleme flexibel selber zu beheben und häufig gestellte Fragen zu beantworten.

### Inhaltsverzeichnis @@ -54,10 +59,13 @@ Hier finden Sie Informationen zum Umgang und Optionen mit Admin-Rechten. OpenCloud ist die Filesharing & Kollaborations-Lösung der Heinlein Gruppe. -Durch intelligentes Datei-Management und eine starke Open Source-Community werden Dateien zu wertvollen Ressourcen – effektiv strukturiert und langfristig nutzbar.
-Mit flexiblen Datenräumen und intelligenten Zugriffs­rechten können Teams jederzeit und überall auf die Daten zugreifen und gemeinsam daran arbeiten – ohne Barrieren, sondern mit viel Produktivität. +Durch intelligentes Datei-Management und eine starke Open Source-Community werden Dateien zu wertvollen Ressourcen – +effektiv strukturiert und langfristig nutzbar.
+Mit flexiblen Datenräumen und intelligenten Zugriffs­rechten können Teams jederzeit und überall auf die Daten zugreifen +und gemeinsam daran arbeiten – ohne Barrieren, sondern mit viel Produktivität.

### Wie kann ich OpenCloud nutzen? -Eine Anleitung wie Sie sich eine eigene OpenCloud installieren und einrichten können, finden Sie in der "User-Dokumentation" unter "Quick-Guide". +Eine Anleitung wie Sie sich eine eigene OpenCloud installieren und einrichten können, finden Sie in der " +User-Dokumentation" unter "Quick-Guide". diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/ios-app/shares/invite.md b/i18n/de/docusaurus-plugin-content-docs/current/user/ios-app/shares/invite.md index 16a8bcf0..5d9bd638 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/user/ios-app/shares/invite.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/user/ios-app/shares/invite.md @@ -8,33 +8,33 @@ title: Einladen zum Teilen

-## Hier erklären wir, wie man in der OpenCloud iOS-App, Dateien und Ordner per Einladung mit anderen Personen und Gruppen innerhalb der eigenen OpenCloud teilt +Hier erklären wir, wie man in der OpenCloud iOS-App, Dateien und Ordner per Einladung mit anderen Personen und Gruppen innerhalb der eigenen OpenCloud teilt --- -#### 1. Klicken Sie auf das "Drei-Punkte-Menü" neben der Datei oder Ordner +## 1. Klicken Sie auf das "Drei-Punkte-Menü" neben der Datei oder Ordner Drei-Punkte-Menü
-#### 2. Wählen Sie nun den Menüpunkt "Teilen" aus +## 2. Wählen Sie nun den Menüpunkt "Teilen" aus Teilen
-#### 3. In der folgenden Auswahl klicken Sie auf "Teilen mit" +## 3. In der folgenden Auswahl klicken Sie auf "Teilen mit" Teilen mit
-#### 4. Es öffnet sich das Teilen Menü, in dem Sie über die Suchleiste nach Personen oder Gruppen suchen können, die Sie einladen möchten +## 4. Es öffnet sich das Teilen Menü, in dem Sie über die Suchleiste nach Personen oder Gruppen suchen können, die Sie einladen möchten Teilen mit Menü Suchleiste Auswahl Personen und/oder Gruppen
-#### 5. Hier können Sie auswählen welche Berechtiigungen Personen und Gruppen haben sollen:
+## 5. Hier können Sie auswählen welche Berechtiigungen Personen und Gruppen haben sollen:
Berechtigungen @@ -47,11 +47,11 @@ title: Einladen zum Teilen
-#### 6. Um den Link nun zu erstellen müssen Sie auf "Einladen" klicken +## 6. Um den Link nun zu erstellen müssen Sie auf "Einladen" klicken Einladen
-#### 7. Wenn die Einladung erstellt ist, sehen Sie diese in der Datei- oder Ordnerübersicht +## 7. Wenn die Einladung erstellt ist, sehen Sie diese in der Datei- oder Ordnerübersicht geteilt mit diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/ios-app/shares/links.md b/i18n/de/docusaurus-plugin-content-docs/current/user/ios-app/shares/links.md index 19e28fe2..7e2f153c 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/user/ios-app/shares/links.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/user/ios-app/shares/links.md @@ -8,36 +8,36 @@ title: Per Link teilen

-## Hier erklären wir, wie man in der OpenCloud iOS-App, Dateien und Ordner per Link mit anderen teilt +Hier erklären wir, wie man in der OpenCloud iOS-App, Dateien und Ordner per Link mit anderen teilt --- -#### 1. Klicken Sie auf das "Drei-Punkte-Menü" neben der Datei oder Ordner +## 1. Klicken Sie auf das "Drei-Punkte-Menü" neben der Datei oder Ordner Drei-Punkte-Menü
-#### 2. Wählen Sie nun den Menüpunkt "Teilen" aus +## 2. Wählen Sie nun den Menüpunkt "Teilen" aus Teilen
-#### 3. In der folgenden Auswahl klicken Sie auf "Link erstellen" +## 3. In der folgenden Auswahl klicken Sie auf "Link erstellen" Link erstellen
-#### 4. Hier können Sie mehrere Optionen für den zu erstellenden Link auswählen und angeben +## 4. Hier können Sie mehrere Optionen für den zu erstellenden Link auswählen und angeben Übersicht Link Menü
-#### 5. Geben Sie hier einen Namen ein wie Ihr Link heißen soll +## 5. Geben Sie hier einen Namen ein wie Ihr Link heißen soll Linkname
-#### 6. Hier können Sie auswählen welche Funktion Ihr Link haben soll:
+## 6. Hier können Sie auswählen welche Funktion Ihr Link haben soll:
Teilen Optionen @@ -54,21 +54,21 @@ title: Per Link teilen
-#### 7. Hier muss ein Passwort eingetragen werden. Sie können selbst eines vergeben oder sich eines generieren lassen +## 7. Hier muss ein Passwort eingetragen werden. Sie können selbst eines vergeben oder sich eines generieren lassen Passwort
-#### 8. Hier können Sie einen Zeitraum angeben, wie lange der Link verfügbar sein soll +## 8. Hier können Sie einen Zeitraum angeben, wie lange der Link verfügbar sein soll Link Verfallsdatum
-#### 9. Um den Link nun zu erstellen müssen Sie auf "Teilen" klicken +## 9. Um den Link nun zu erstellen müssen Sie auf "Teilen" klicken Teilen
-#### 10. Wenn der Link erstellt ist, sehen Sie diesen mit dem vergebenen Namen in der Datei- oder Ordnerübersicht +## 10. Wenn der Link erstellt ist, sehen Sie diesen mit dem vergebenen Namen in der Datei- oder Ordnerübersicht erstellter link diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/ios-app/shortcuts.md b/i18n/de/docusaurus-plugin-content-docs/current/user/ios-app/shortcuts.md index 8710e7f0..593eee66 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/user/ios-app/shortcuts.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/user/ios-app/shortcuts.md @@ -6,53 +6,53 @@ title: Verlinkungen in der OpenCloud iOS App # Verlinkungen in der OpenCloud iOS App -## Hier zeigen wir, wie Sie Verlinkungen in der iOS App erstellen können +Hier zeigen wir, wie Sie Verlinkungen in der iOS App erstellen können --- -#### 1. Klicken Sie auf das "Plus-Symbol" +## 1. Klicken Sie auf das "Plus-Symbol" Plus Symbol
-#### 2. Es öffnet sich ein Drop-Down-Menü +## 2. Es öffnet sich ein Drop-Down-Menü Drop Down Menü
-#### 3. Wählen Sie dort "Verlinkung erstellen" aus +## 3. Wählen Sie dort "Verlinkung erstellen" aus Verlinkung erstellen auswählen
-#### 4. Es öffnet sich ein Menü mit Auswahlmöglichkeiten für die Verlinkung +## 4. Es öffnet sich ein Menü mit Auswahlmöglichkeiten für die Verlinkung Verlinkung Menü
-#### 5. Um eine Verlinkung zu einer Webseite zu erstellen, geben sie unter "URL" die Adresse der Webseite ein +## 5. Um eine Verlinkung zu einer Webseite zu erstellen, geben sie unter "URL" die Adresse der Webseite ein URL
-#### 6. Um eine Verlinkung zu einer Datei oder einem Ordner in der OpenCloud zu erstellen, muss die Option "Datei oder Ordner auswählen" geklickt werden +## 6. Um eine Verlinkung zu einer Datei oder einem Ordner in der OpenCloud zu erstellen, muss die Option "Datei oder Ordner auswählen" geklickt werden Datei oder Ordner auswählen Option Datei oder Ordner auswählen Auswählen
-#### 7. Hier geben Sie einen Namen für die Verlinkung ein, mit der diese dann dargestellt wird +## 7. Hier geben Sie einen Namen für die Verlinkung ein, mit der diese dann dargestellt wird Name der Verlinkung
-#### 8. Um die Verlinkung nun zu erstellen, klicken Sie auf "Verlinkung erstellen" +## 8. Um die Verlinkung nun zu erstellen, klicken Sie auf "Verlinkung erstellen" Verlinkung erstellen
-#### 9. Jetzt wird Ihre erstellte Verlinkung angezeigt und kann genutzt werden +## 9. Jetzt wird Ihre erstellte Verlinkung angezeigt und kann genutzt werden Verlinkung
diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/ios-app/spaces.md b/i18n/de/docusaurus-plugin-content-docs/current/user/ios-app/spaces.md index db728b05..2ddefac0 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/user/ios-app/spaces.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/user/ios-app/spaces.md @@ -8,11 +8,11 @@ title: Spaces
-#### Der **„Spaces“-Bereich** (zu Deutsch: **„Bereiche“**) bietet einen zentralen Ort für die Zusammenarbeit in Gruppen oder Teams. In einem Space können mehrere Nutzer gemeinsam auf Dateien und Ordner zugreifen, Inhalte organisieren und Änderungen nachvollziehen +Der **„Spaces“-Bereich** (zu Deutsch: **„Bereiche“**) bietet einen zentralen Ort für die Zusammenarbeit in Gruppen oder Teams. In einem Space können mehrere Nutzer gemeinsam auf Dateien und Ordner zugreifen, Inhalte organisieren und Änderungen nachvollziehen --- -### Spaces Übersicht +## Spaces Übersicht Um zur **"Spaces Übersicht"** zu gelangen, klicken wir erst auf die **"Spaces-Schaltfläche"** im Account-Menü. Spaces-Schaltfläche @@ -23,7 +23,7 @@ Im Anschluss sehen wir die **"Spaces-Übersicht"**, in der alle Spaces aufgelist --- -### Such Funktion +## Such Funktion Durch klicken auf das **"Such-Symbol"**, öffnet sich das Menü für die Suche innerhalb der Spaces. @@ -35,7 +35,7 @@ Durch klicken auf das **"Such-Symbol"**, öffnet sich das Menü für die Suche i --- -### Funktionen innerhalb eines Spaces +## Funktionen innerhalb eines Spaces Durch klicken auf das **"Plus-Symbol"** öffnen wir die Funktionen innerhalb eines Spaces. Plus Symbol @@ -74,7 +74,7 @@ Durch klicken auf das **"Plus-Symbol"** öffnen wir die Funktionen innerhalb ein --- -### Das "Drei-Punkte-Menü" +## Das "Drei-Punkte-Menü" Durch klicken auf das **"Drei-Punkte-Menü"**, öffnet sich ein Pop-up Menü, in dem wir einstellen können, ob der Space offline verfügbar sein soll oder nicht. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/roles/share-roles.md b/i18n/de/docusaurus-plugin-content-docs/current/user/roles/share-roles.md index 812055cd..00e08492 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/user/roles/share-roles.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/user/roles/share-roles.md @@ -4,7 +4,7 @@ id: share-roles title: Rollen beim Teilen --- -### Rollen beim teilen in OpenCloud +## Rollen beim teilen in OpenCloud | Rolle | anzeigen | herunterladen | hochladen | bearbeiten | erstellen | löschen | nur doc, img, pdf mit Wasserzeichen anzeigen | | :--------------------- | :------: | :-----------: | :-------: | :--------: | :-------: | :-----: | :------------------------------------------: | @@ -13,7 +13,7 @@ title: Rollen beim Teilen | kann hochladen | x | x | x | - | - | - | - | | kann bearbeiten | x | x | x | x | x | x | - | -# Space-Mitglieder-Rollen und -Rechte +## Space-Mitglieder-Rollen und -Rechte In einem Space können Mitglieder verschiedene Rollen haben, die bestimmen, was sie mit gemeinsamen Dateien und Ordnern tun können. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/sharing/internal.md b/i18n/de/docusaurus-plugin-content-docs/current/user/sharing/internal.md index 818df312..c0d03bb2 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/user/sharing/internal.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/user/sharing/internal.md @@ -14,7 +14,7 @@ title: Intern Teilen ### Mit OpenCloud können Sie Dateien und Ordner intern innerhalb Ihrer Organisation teilen -**Hier sind die Schritte zum Teilen von Dateien oder Ordnern mit anderen Mitgliedern oder Gruppen** +Hier sind die Schritte zum Teilen von Dateien oder Ordnern mit anderen Mitgliedern oder Gruppen --- @@ -50,4 +50,4 @@ title: Intern Teilen - Die gemeinsam genutzten Mitglieder oder Gruppen werden im selben Fenster unter **"gemeinsam genutzt mit “** aufgeführt.

- **Mit diesen Schritten können Sie schnell und einfach Dateien und Ordner innerhalb Ihrer Organisation freigeben und den Zugriff entsprechend verwalten!** + Mit diesen Schritten können Sie schnell und einfach Dateien und Ordner innerhalb Ihrer Organisation freigeben und den Zugriff entsprechend verwalten! diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/spaces/rename.md b/i18n/de/docusaurus-plugin-content-docs/current/user/spaces/rename.md index 0bf3b127..4766ca1f 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/user/spaces/rename.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/user/spaces/rename.md @@ -14,18 +14,18 @@ title: Space umbenennen ##

-#### **Kontextmenü öffnen** +### **Kontextmenü öffnen** - Klicken Sie auf das **Drei-Punkte-Menü** oder machen Sie einen **Rechtsklick** auf den Raum in der Raumübersicht und wählen Sie **Umbenennen**. Rename

-#### **Neuen Namen eingeben** +### **Neuen Namen eingeben** - Geben Sie den neuen Namen für den Raum ein und bestätigen Sie. confirm

-#### Ihr Space ist nun umbenannt +### Ihr Space ist nun umbenannt Renamed Space diff --git a/static/env-vars/policies_readme.md b/static/env-vars/policies_readme.md index edb54e37..c14cdea4 100755 --- a/static/env-vars/policies_readme.md +++ b/static/env-vars/policies_readme.md @@ -138,7 +138,7 @@ proxy: The same can be achieved by setting the following environment variable: -```shell +```bash export PROXY_POLICIES_QUERY=data.proxy.granted ``` @@ -152,13 +152,13 @@ policies: The same can be achieved by setting the following environment variable: -```shell +```bash export POLICIES_POSTPROCESSING_QUERY=data.postprocessing.granted ``` As soon as that query is configured, the postprocessing service must be informed to use the policies step by setting the environment variable: -```shell +```bash export POSTPROCESSING_STEPS=policies ``` @@ -180,7 +180,7 @@ Note that existing mappings from the host are extended by the definitions from t The path to that file can be provided via a yaml configuration or an environment variable. Note to replace the `OC_CONFIG_DIR` string by an existing path. -```shell +```bash export POLICIES_ENGINE_MIMES=OC_CONFIG_DIR/mime.types ``` diff --git a/static/env-vars/search_readme.md b/static/env-vars/search_readme.md index d773a89a..35c64753 100755 --- a/static/env-vars/search_readme.md +++ b/static/env-vars/search_readme.md @@ -185,13 +185,13 @@ This is exactly the same as [File uploaded - synchronous](#file-uploaded---synch The service includes a command-line interface to trigger re-indexing a space: -```shell +```bash opencloud search index --space $SPACE_ID ``` It can also be used to re-index all spaces: -```shell +```bash opencloud search index --all-spaces ``` diff --git a/static/env-vars/thumbnails_readme.md b/static/env-vars/thumbnails_readme.md index caf39f8f..a16ee6c2 100755 --- a/static/env-vars/thumbnails_readme.md +++ b/static/env-vars/thumbnails_readme.md @@ -130,20 +130,20 @@ enabled at buildtime and has a couple of implications: Support of libvips is disabled by default. To enable it, make sure libvips and its buildtime dependencies are installed in your build environment. For macOS users, add the build time dependencies via: -```shell +```bash brew install vips pkg-config export PKG_CONFIG_PATH="/usr/local/opt/libffi/lib/pkgconfig" ``` Then you just need to set the `ENABLE_VIPS` variable on the `make` command: -```shell +```bash make -C opencloud build ENABLE_VIPS=1 ``` Or include the `enable_vips` build tag in the `go build` command: -```shell +```bash go build -tags enable_vips -o opencloud -o bin/opencloud ./cmd/opencloud ```