diff --git a/docs/admin/configuration/storage/decomposeds3.md b/docs/admin/configuration/storage/decomposeds3.md index b87fd161..c9222fbf 100644 --- a/docs/admin/configuration/storage/decomposeds3.md +++ b/docs/admin/configuration/storage/decomposeds3.md @@ -8,49 +8,44 @@ draft: false # 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. +Decomposeds3 is a storage driver for OpenCloud that uses MinIO — an S3-compatible object storage — to store files efficiently. This setup combines the scalability of S3 with seamless integration into OpenCloud. -## Prerequisites +## Setup -- 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/) +Navigate to the folder containing the Docker Compose configuration: -## Download +```bash +cd opencloud-compose +``` -Download the `opencloud_full` folder (this folder contains a multi-file Docker Compose configuration): +Open the `.env` file and enable the required configuration files: ```bash -git clone https://github.com/opencloud-eu/opencloud.git +nano .env ``` -## Start - -Navigate to the Docker Compose configuration folder: +Uncomment the following line to enable MinIO in the S3 Storage configuration block: -```bash -cd opencloud/deployments/examples/opencloud_full +```env +#DECOMPOSEDS3_MINIO=:minio.yml ``` -Enable `decomposeds3.yml` and `minio.yml` in the `.env` file: +Add `storage/decomposeds3.yml` to the `COMPOSE_FILE` variable +or include it directly in the startup command: ```bash -nano opencloud/deployments/examples/opencloud_full/.env +docker compose -f docker-compose.yml -f storage/decomposeds3.yml up ``` -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: +Start all containers in the background: ```bash docker compose up -d ``` -This starts all necessary containers in the background. - -## Add local domains to /etc/hosts +## Add Local Domains to /etc/hosts -Edit the /etc/hosts file and add the following entries for local access: +To enable local access, add the following lines to your `/etc/hosts` file: ```bash 127.0.0.1 cloud.opencloud.test @@ -59,20 +54,18 @@ Edit the /etc/hosts file and add the following entries for local access: ## Login -Login with your browser: +Open your browser and visit: - [https://cloud.opencloud.test](https://cloud.opencloud.test) -- user: admin -- password: admin -Congratulations! You’ve successfully set up and launched OpenCloud! Happy hacking!🚀 +After logging in, you should see the OpenCloud interface: -Admin general +Login Page -Admin general +OpenCloud with decomposeds3 and MinIO ## Troubleshooting -If you encounter any issues or errors, try finding a solution here: +If you run into any issues or errors, check the following resource: - [Common Issues & Help](../../resources/common-issues.md)