diff --git a/docs/admin/installation/common-issues.md b/docs/admin/common-issues.md similarity index 59% rename from docs/admin/installation/common-issues.md rename to docs/admin/common-issues.md index 777e12b4..8417c288 100644 --- a/docs/admin/installation/common-issues.md +++ b/docs/admin/common-issues.md @@ -13,7 +13,7 @@ title: Common Issues & Help docker ps ``` -Admin general +Admin general Several containers should be listed here, e.g., for opencloud, traefik, etc.

@@ -28,8 +28,9 @@ For Firefox: You need to klick on **Advanced** -Admin general +Admin general Confirm the risk with **Accept the risk and Contiune** -Admin general \ No newline at end of file +Admin general + diff --git a/docs/admin/installation/img/quick-guide/quick-accept-security-risk.png b/docs/admin/img/common-issues/quick-accept-security-risk.png similarity index 100% rename from docs/admin/installation/img/quick-guide/quick-accept-security-risk.png rename to docs/admin/img/common-issues/quick-accept-security-risk.png diff --git a/docs/admin/installation/img/quick-guide/quick-advanced.png b/docs/admin/img/common-issues/quick-advanced.png similarity index 100% rename from docs/admin/installation/img/quick-guide/quick-advanced.png rename to docs/admin/img/common-issues/quick-advanced.png diff --git a/docs/admin/installation/img/quick-guide/quick-docker-running.png b/docs/admin/img/common-issues/quick-docker-running.png similarity index 100% rename from docs/admin/installation/img/quick-guide/quick-docker-running.png rename to docs/admin/img/common-issues/quick-docker-running.png diff --git a/docs/admin/img/quick-guide/docker-opencloud-init.png b/docs/admin/img/quick-guide/docker-opencloud-init.png deleted file mode 100644 index 61e5b83e..00000000 Binary files a/docs/admin/img/quick-guide/docker-opencloud-init.png and /dev/null differ diff --git a/docs/admin/img/quick-guide/docker-running.png b/docs/admin/img/quick-guide/docker-running.png deleted file mode 100644 index adcd42f1..00000000 Binary files a/docs/admin/img/quick-guide/docker-running.png and /dev/null differ diff --git a/docs/admin/installation/bare-metal.md b/docs/admin/installation/bare-metal.md index 555f5b69..f72a4594 100644 --- a/docs/admin/installation/bare-metal.md +++ b/docs/admin/installation/bare-metal.md @@ -106,4 +106,4 @@ Your OpenCloud server is now running and ready to use 🚀 --- ### If you encounter any issues or errors, try finding a solution here: -- [Common Issues & Help](./common-issues.md) \ No newline at end of file +- [Common Issues & Help](./../common-issues.md) \ No newline at end of file diff --git a/docs/admin/installation/docker-compose.md b/docs/admin/installation/docker-compose.md index 65ef10e8..08f0599f 100644 --- a/docs/admin/installation/docker-compose.md +++ b/docs/admin/installation/docker-compose.md @@ -39,7 +39,7 @@ cd into the Docker Compose configuration folder: cd opencloud/deployments/examples/opencloud_full ``` -Start the depoyment with Docker Compose: +Start the deployment with Docker Compose: ```Shell docker compose up -d @@ -54,11 +54,12 @@ This starts all necessary containers in the background. ### 3. Add local domains to /etc/hosts +Edit the /etc/hosts file and add the following entries for local access: + ``` 127.0.0.1 cloud.opencloud.test 127.0.0.1 collabora.opencloud.test 127.0.0.1 wopiserver.opencloud.test -127.0.0.1 mail.opencloud.test 127.0.0.1 onlyoffice.opencloud.test ```

@@ -81,5 +82,8 @@ Your OpenCloud server is now running and ready to use 🚀 --- -### If you encounter any issues or errors, try finding a solution here: -- [Common Issues & Help](./common-issues.md) \ No newline at end of file +### Troubleshooting + +If you encounter any issues or errors, try finding a solution here: + +- [Common Issues & Help](./../common-issues.md) diff --git a/docs/admin/installation/docker.md b/docs/admin/installation/docker.md index e52a7a98..fbbc718e 100644 --- a/docs/admin/installation/docker.md +++ b/docs/admin/installation/docker.md @@ -93,5 +93,8 @@ Your OpenCloud server is now running and ready to use 🚀 --- -### If you encounter any issues or errors, try finding a solution here: -- [Common Issues & Help](./common-issues.md) \ No newline at end of file +### Troubleshooting + +If you encounter any issues or errors, try finding a solution here: + +- [Common Issues & Help](./../common-issues.md) diff --git a/docs/admin/storage/_category_.json b/docs/admin/storage/_category_.json new file mode 100644 index 00000000..67b63c39 --- /dev/null +++ b/docs/admin/storage/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Storage Integration", + "position": 2, + "link": { + "type": "generated-index", + "description": "OpenCloud Storage Integration." + } +} diff --git a/docs/admin/storage/decomposeds3.md b/docs/admin/storage/decomposeds3.md new file mode 100644 index 00000000..66036c58 --- /dev/null +++ b/docs/admin/storage/decomposeds3.md @@ -0,0 +1,80 @@ +--- +sidebar_position: 1 +id: decomposeds3 +title: Decomposeds3 +--- + +# Decomposeds3 Storage Driver + +Decomposeds3 is a storage driver for OpenCloud that uses MinIO, an S3-compatible object storage, for handling file storage efficiently. This setup leverages S3’s scalability while integrating seamlessly with OpenCloud. + +--- + +**Prerequisites:** +- **Linux**, **Mac** or **Windows** Subsystem for Linux [(WSL)](https://learn.microsoft.com/en-us/windows/wsl/install) +- [**Docker**](https://docs.docker.com/compose/install/) +- [**Docker Compose**](https://docs.docker.com/compose/install/) + +--- + +## 1. Download + +Download the `opencloud_full` folder (this folder contains a multi-file Docker Compose configuration): + +```Shell +git clone https://github.com/opencloud-eu/opencloud.git +``` + +## 2. Start + +Navigate to the Docker Compose configuration folder: + +```Shell +cd opencloud/deployments/examples/opencloud_full +``` + +Enable `decomposeds3.yml` and `minio.yml` in the `.env` file: + +```Shell +nano opencloud/deployments/examples/opencloud_full/.env +``` + +Find all required environment variables `env` here: [decomposeds3-envs](https://github.com/opencloud-eu/opencloud/blob/main/services/storage-users/pkg/config/config.go#L143-L176) + +Start the deployment with Docker Compose: + +```Shell +docker compose up -d +``` + +This starts all necessary containers in the background. + +## 3. Add local domains to /etc/hosts + +Edit the /etc/hosts file and add the following entries for local access: + +``` +127.0.0.1 cloud.opencloud.test +127.0.0.1 minio.opencloud.test +``` + +## 4. Login + +Login with your browser: +- [https://cloud.opencloud.test](https://cloud.opencloud.test) +- user: **admin** +- password: **admin** + +🎉 Congratulations! You’ve successfully set up and launched OpenCloud! Happy hacking!🚀 + +Admin general + +Admin general + +--- + +### Troubleshooting + +If you encounter any issues or errors, try finding a solution here: + +- [Common Issues & Help](./../common-issues.md) diff --git a/docs/admin/storage/img/decomposeds3-with-minio.png b/docs/admin/storage/img/decomposeds3-with-minio.png new file mode 100644 index 00000000..d53e7ff0 Binary files /dev/null and b/docs/admin/storage/img/decomposeds3-with-minio.png differ diff --git a/docs/admin/storage/img/login-page.png b/docs/admin/storage/img/login-page.png new file mode 100644 index 00000000..0a8306f2 Binary files /dev/null and b/docs/admin/storage/img/login-page.png differ