Skip to content

Commit 1d4a060

Browse files
Heiko-PohlSvanvith
andauthored
rework decomposeds3 (#412)
* rework decomposed s3 * rework wording decomposed s3 doku * remove prerequisites and default login --------- Co-authored-by: Anja Barz <a.barz@opencloud.eu>
1 parent adcc40f commit 1d4a060

1 file changed

Lines changed: 22 additions & 29 deletions

File tree

docs/admin/configuration/storage/decomposeds3.md

Lines changed: 22 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,49 +8,44 @@ draft: false
88

99
# Decomposeds3 Storage Driver
1010

11-
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.
11+
Decomposeds3 is a storage driver for OpenCloud that uses MinIOan S3-compatible object storage — to store files efficiently. This setup combines the scalability of S3 with seamless integration into OpenCloud.
1212

13-
## Prerequisites
13+
## Setup
1414

15-
- Linux, Mac or Windows Subsystem for Linux [(WSL)](https://learn.microsoft.com/en-us/windows/wsl/install)
16-
- [Docker](https://docs.docker.com/compose/install/)
17-
- [Docker Compose](https://docs.docker.com/compose/install/)
15+
Navigate to the folder containing the Docker Compose configuration:
1816

19-
## Download
17+
```bash
18+
cd opencloud-compose
19+
```
2020

21-
Download the `opencloud_full` folder (this folder contains a multi-file Docker Compose configuration):
21+
Open the `.env` file and enable the required configuration files:
2222

2323
```bash
24-
git clone https://github.com/opencloud-eu/opencloud.git
24+
nano .env
2525
```
2626

27-
## Start
28-
29-
Navigate to the Docker Compose configuration folder:
27+
Uncomment the following line to enable MinIO in the S3 Storage configuration block:
3028

31-
```bash
32-
cd opencloud/deployments/examples/opencloud_full
29+
```env
30+
#DECOMPOSEDS3_MINIO=:minio.yml
3331
```
3432

35-
Enable `decomposeds3.yml` and `minio.yml` in the `.env` file:
33+
Add `storage/decomposeds3.yml` to the `COMPOSE_FILE` variable
34+
or include it directly in the startup command:
3635

3736
```bash
38-
nano opencloud/deployments/examples/opencloud_full/.env
37+
docker compose -f docker-compose.yml -f storage/decomposeds3.yml up
3938
```
4039

41-
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)
42-
43-
Start the deployment with Docker Compose:
40+
Start all containers in the background:
4441

4542
```bash
4643
docker compose up -d
4744
```
4845

49-
This starts all necessary containers in the background.
50-
51-
## Add local domains to /etc/hosts
46+
## Add Local Domains to /etc/hosts
5247

53-
Edit the /etc/hosts file and add the following entries for local access:
48+
To enable local access, add the following lines to your `/etc/hosts` file:
5449

5550
```bash
5651
127.0.0.1 cloud.opencloud.test
@@ -59,20 +54,18 @@ Edit the /etc/hosts file and add the following entries for local access:
5954

6055
## Login
6156

62-
Login with your browser:
57+
Open your browser and visit:
6358

6459
- [https://cloud.opencloud.test](https://cloud.opencloud.test)
65-
- user: admin
66-
- password: admin
6760

68-
Congratulations! You’ve successfully set up and launched OpenCloud! Happy hacking!🚀
61+
After logging in, you should see the OpenCloud interface:
6962

70-
<img src={require("./../img/login-page.png").default} alt="Admin general" width="1920"/>
63+
<img src={require("./../img/login-page.png").default} alt="Login Page" width="1920"/>
7164

72-
<img src={require("./../img/decomposeds3-with-minio.png").default} alt="Admin general" width="1920"/>
65+
<img src={require("./../img/decomposeds3-with-minio.png").default} alt="OpenCloud with decomposeds3 and MinIO" width="1920"/>
7366

7467
## Troubleshooting
7568

76-
If you encounter any issues or errors, try finding a solution here:
69+
If you run into any issues or errors, check the following resource:
7770

7871
- [Common Issues & Help](../../resources/common-issues.md)

0 commit comments

Comments
 (0)