Skip to content

Commit 798f74e

Browse files
committed
docs: Update docs for rustfs instead of minio
Signed-off-by: Julius Knorr <jus@bitgrid.net>
1 parent 563864a commit 798f74e

File tree

2 files changed

+58
-10
lines changed

2 files changed

+58
-10
lines changed

docker-compose.yml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ services:
4444
- mail${DOMAIN_SUFFIX}
4545
- sso${DOMAIN_SUFFIX}
4646
- minio${DOMAIN_SUFFIX}
47+
- rustfs${DOMAIN_SUFFIX}
4748
- imap${DOMAIN_SUFFIX}
4849
- collabora${DOMAIN_SUFFIX}
4950
- codedev${DOMAIN_SUFFIX}
@@ -916,13 +917,10 @@ services:
916917
image: rustfs/rustfs:latest
917918
environment:
918919
VIRTUAL_HOST: rustfs${DOMAIN_SUFFIX}
919-
VIRTUAL_PORT: 9000
920+
VIRTUAL_PORT: 9001
920921
RUSTFS_ACCESS_KEY: nextcloud
921922
RUSTFS_SECRET_KEY: nextcloud
922923
RUSTFS_CONSOLE_ENABLE: "true"
923-
ports:
924-
- "9010:9000"
925-
- "9011:9001"
926924
volumes:
927925
- objectstorage_rustfs:/data
928926

docs/services/s3.md

Lines changed: 56 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,72 @@
11
# S3 / Object storage
22

3-
S3 can be easily tested with the included container running Minio. This is a self-hosted S3-compatible object storage server.
3+
S3-compatible object storage can be easily tested with the included containers. Two options are available:
4+
5+
- **rustfs** (recommended) - A fast, lightweight S3-compatible object storage server written in Rust
6+
- **minio** - Abandoned S3-compatible object storage server (open-source version moved to maintenance-only mode with stripped-down UI)
7+
8+
## rustfs (Recommended)
9+
10+
rustfs is the preferred option for development and testing due to its performance and simplicity.
11+
12+
### Starting rustfs
13+
14+
Start the container using the following command:
15+
16+
```bash
17+
docker compose up -d rustfs
18+
```
19+
20+
### Primary object storage
21+
22+
Primary object storage can be enabled by setting the `PRIMARY=rustfs` environment variable either in your `.env` file or in `docker-compose.yml` for individual containers.
23+
24+
```bash
25+
PRIMARY=rustfs docker compose up nextcloud rustfs
26+
```
27+
28+
### External object storage
29+
30+
External storage can be configured in the Nextcloud admin settings. This is an example configuration for the `nc-external` bucket, buckets will be autocreated so you can name any bucket you like:
31+
32+
- Bucket: `nc-external`
33+
- Authentication: `Access Key`
34+
- Hostname: `rustfs`
35+
- Port: `9000`
36+
- Enable SSL: `No`
37+
- Enable Path Style: `Yes`
38+
- Legacy (v2) Authentication: `No`
39+
- Access Key: `nextcloud`
40+
- Secret Key: `nextcloud`
41+
42+
### Accessing rustfs console
43+
44+
rustfs can be accessed via the browser at <http://rustfs.local> with the following credentials:
45+
46+
- Username: `nextcloud`
47+
- Password: `nextcloud`
48+
49+
## Minio (Alternative)
50+
51+
Minio is a more feature-rich alternative with additional management capabilities. However, critics often point to recent controversial changes, including shifting to a maintenance-only mode for the open-source version and stripping down the UI. For these reasons, rustfs is now the recommended choice for most development workflows.
52+
53+
### Starting Minio
454

555
Start the container using the following command:
656

757
```bash
858
docker compose up -d minio
959
```
1060

11-
## Primary object storage
61+
### Primary object storage
1262

1363
Primary object storage can be enabled by setting the `PRIMARY=minio` environment variable either in your `.env` file or in `docker-compose.yml` for individual containers.
1464

1565
```bash
16-
docker compose up nextcloud minio
66+
PRIMARY=minio docker compose up nextcloud minio
1767
```
1868

19-
## External object storage
69+
### External object storage
2070

2171
External storage can be configured in the Nextcloud admin settings. This is an example configuration for the `nc-external` bucket, buckets will be autocreated so you can name any bucket you like:
2272

@@ -30,14 +80,14 @@ External storage can be configured in the Nextcloud admin settings. This is an e
3080
- Access Key: `nextcloud`
3181
- Secret Key: `nextcloud`
3282

33-
## Accessing Minio
83+
### Accessing Minio
3484

3585
Minio can be accessed via the browser at <http://minio.local> with the following credentials:
3686

3787
- Username: `nextcloud`
3888
- Password: `nextcloud`
3989

40-
## Using mc command line
90+
### Using mc command line
4191

4292
This can be useful for admin operations like setting a bucket quota on the `nc-external` bucket name:
4393

0 commit comments

Comments
 (0)