Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 0 additions & 13 deletions content/concepts/index.md

This file was deleted.

12 changes: 0 additions & 12 deletions content/concepts/principle/index.md

This file was deleted.

2 changes: 1 addition & 1 deletion content/developer/mc.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Prerequisites:
First, configure an alias for RustFS using the `mc alias` command:

```bash
mc alias set rustfs http://12.34.56.78:9000 ACCESS_KEY SECRET_KEY
mc alias set rustfs http://192.168.1.100:9000 <your-access-key> <your-secret-key>
```

Output:
Expand Down
6 changes: 3 additions & 3 deletions content/developer/mcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ Currently, mainstream AI IDEs such as Cursor, Windsurf, Trae, etc. all support M
"env": {
"AWS_ACCESS_KEY_ID": "rustfs_access_key",
"AWS_SECRET_ACCESS_KEY": "rustfs_secret_key",
"AWS_REGION": "cn-east-1",
"AWS_REGION": "us-east-1",
"AWS_ENDPOINT_URL": "rustfs_instance_url"
}
}
Expand All @@ -182,7 +182,7 @@ If added successfully, you can list the [available tools](#️-available-tools)

In Trae, you can use the corresponding tools by entering the corresponding prompts. For example, in Trae's chat dialog, enter:

```
```text
Please help me list the buckets in the current rustfs instance, thank you!
```

Expand Down Expand Up @@ -257,7 +257,7 @@ Deletes the specified RustFS bucket.

The MCP server is built with a modular architecture:

```
```text
rustfs-mcp/
├── src/
│ ├── main.rs # Entry point, CLI parsing and server initialization
Expand Down
6 changes: 3 additions & 3 deletions content/installation/docker/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ git clone https://github.com/rustfs/rustfs.git

Running the command under root directory,

```
```bash
docker compose --profile observability up -d
```

Expand Down Expand Up @@ -200,7 +200,7 @@ Providing the necessary permissions. An initialization container is necessary to

Started containers is as below,

```
```text
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
c13c23fe3d9d rustfs/rustfs:latest "/entrypoint.sh rust…" 6 seconds ago Up 5 seconds (health: starting) 0.0.0.0:9000-9001->9000-9001/tcp, :::9000-9001->9000-9001/tcp rustfs-server
e3f4fc4a83a2 grafana/grafana:latest "/run.sh" 7 seconds ago Up 5 seconds 0.0.0.0:3000->3000/tcp, :::3000->3000/tcp grafana
Expand All @@ -217,7 +217,7 @@ docker compose -f docker-compose.yml up -d rustfs

This way will only install and start `rustfs-server` service, namely rustfs container,

```
```text
docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
e07121ecdd39 rustfs/rustfs:latest "/entrypoint.sh rust…" 2 seconds ago Up 1 second (health: starting) 0.0.0.0:9000-9001->9000-9001/tcp, :::9000-9001->9000-9001/tcp rustfs-server
Expand Down
6 changes: 3 additions & 3 deletions content/integration/virtual.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Path Style is the default. In Path Style, the bucket name follows the endpoint.

Example (Bucket: `test`, Host: `rustfs.yourdomain.com`):

```
```text
http://rustfs.yourdomain.com/test
```

Expand All @@ -28,7 +28,7 @@ In Virtual Host Style, the bucket name is part of the domain.

Example (Bucket: `test`, Host: `rustfs.yourdomain.com`):

```
```text
http://test.rustfs.yourdomain.com/
```

Expand All @@ -51,7 +51,7 @@ RUSTFS_SERVER_DOMAINS = "rustfs.yourdomain.com:8000"

This ensures that requests like:

```
```text
http://my-bucket.rustfs.yourdomain.com:8000/
```

Expand Down
2 changes: 1 addition & 1 deletion content/management/bucket/creation.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ mc ls rustfs/bucket-creation-by-mc

Create a bucket via API:

```
```http
PUT /{bucketName} HTTP/1.1
```

Expand Down
2 changes: 1 addition & 1 deletion content/management/bucket/deletion.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ mc: <ERROR> Unable to list folder. Bucket `bucket-creation-by-mc` does not exist

Delete a bucket via API:

```
```http
DELETE /{bucketName} HTTP/1.1
```

Expand Down
4 changes: 2 additions & 2 deletions content/management/object/creation.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Verify the upload in the RustFS Console.

Upload a file via API:

```
```http
PUT /{bucketName}/{objectName} HTTP/1.1
```

Expand All @@ -72,7 +72,7 @@ See [Object Deletion](./deletion.md).

Use the following API for file deletion:

```
```http
DELETE /{bucketName}/{objectName} HTTP/1.1
```

Expand Down
2 changes: 1 addition & 1 deletion content/management/object/deletion.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Verify the deletion in the RustFS Console.

Delete a file via API:

```
```http
DELETE /{bucketName}/{objectName} HTTP/1.1
```

Expand Down
9 changes: 7 additions & 2 deletions scripts/docs-check.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -127,12 +127,17 @@ for (const file of mdFiles) {
}
});

// relative .md links: [text](path.md) — skip http(s), absolute, and anchors
// relative .md links: [text](path.md) — skip http(s), absolute, and anchors.
// A `.md` link also resolves if the sibling `.mdx` exists (FumaPress maps
// links by URL, not by on-disk extension), and vice versa.
for (const m of text.matchAll(/\]\(([^)\s]+?\.mdx?)(?:#[^)]*)?\)/g)) {
const target = m[1];
if (/^(https?:)?\/\//.test(target) || target.startsWith('/')) continue;
const resolved = path.resolve(dir, decodeURIComponent(target));
if (!fs.existsSync(resolved)) brokenLinks.push(`${rel(file)} -> ${target}`);
const alt = resolved.replace(/\.mdx$/, '.md').replace(/\.md$/, '.mdx');
if (!fs.existsSync(resolved) && !fs.existsSync(alt)) {
brokenLinks.push(`${rel(file)} -> ${target}`);
}
}

// referenced images
Expand Down
Loading