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
17 changes: 17 additions & 0 deletions .github/workflows/docs-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: docs-check

on:
pull_request:
paths:
- "content/**"
- "scripts/docs-check.mjs"

jobs:
docs-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 22
- run: node scripts/docs-check.mjs
Binary file removed content/about/images/office-location.png
Binary file not shown.
206 changes: 104 additions & 102 deletions content/concepts/glossary.md

Large diffs are not rendered by default.

Binary file removed content/features/ai/images/cloud-operations.png
Binary file not shown.
Binary file removed content/features/ai/images/data-protection.png
Binary file not shown.
Binary file removed content/features/ai/images/edge-ai-storage.png
Binary file not shown.
Binary file not shown.
Binary file removed content/features/ai/images/lifecycle-management.png
Binary file not shown.
Binary file removed content/features/ai/images/llm-storage.png
Binary file not shown.
Binary file removed content/features/ai/images/object-retention.png
Binary file not shown.
Binary file removed content/features/ai/images/rag-storage.png
Binary file not shown.
Binary file removed content/features/ai/images/reliable-storage.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed content/features/commvault/images/commvault-logo.png
Binary file not shown.
Binary file not shown.
Binary file removed content/features/commvault/images/scalability.png
Binary file not shown.
Binary file not shown.
Binary file removed content/features/data-lake/images/decomposition.png
Binary file not shown.
Binary file removed content/features/data-lake/images/elt-etl.png
Binary file not shown.
Binary file removed content/features/data-lake/images/lightweight.png
Binary file not shown.
Binary file removed content/features/data-lake/images/open-source.png
Binary file not shown.
Binary file removed content/features/data-lake/images/rapid-growth.png
Binary file not shown.
Binary file removed content/features/data-lake/images/resilience.png
Binary file not shown.
Binary file removed content/features/data-lake/images/security.png
Binary file not shown.
Binary file removed content/features/data-lake/images/simplicity.png
Binary file not shown.
Binary file not shown.
Binary file removed content/features/domestic/images/arrow.png
Diff not rendered.
Binary file removed content/features/domestic/images/icon-1.png
Diff not rendered.
Binary file removed content/features/domestic/images/icon-2.png
Diff not rendered.
Binary file removed content/features/domestic/images/icon-3.png
Diff not rendered.
Binary file removed content/features/domestic/images/icon-4.png
Diff not rendered.
Binary file removed content/features/domestic/images/item-1.png
Diff not rendered.
Binary file removed content/features/domestic/images/item-2.png
Diff not rendered.
Binary file removed content/features/domestic/images/item-3.png
Diff not rendered.
13 changes: 0 additions & 13 deletions content/features/integration/images/integration-hero.svg
Diff not rendered.
Binary file removed content/features/lifecycle/images/s9-1.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed content/features/s3-compatibility/images/s1-1.png
Diff not rendered.
Binary file removed content/features/s3-compatibility/images/s1-2.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed content/features/veeam/images/backup-restore.png
Diff not rendered.
Binary file removed content/features/veeam/images/hardware-agnostic.png
Diff not rendered.
Binary file removed content/features/veeam/images/inline-consistency.png
Diff not rendered.
Binary file removed content/features/veeam/images/metadata-advantage.png
Diff not rendered.
Binary file removed content/features/veeam/images/veeam-logo.png
Diff not rendered.
Diff not rendered.
Binary file removed content/features/video/images/item-1.png
Diff not rendered.
Binary file removed content/features/video/images/item-2.png
Diff not rendered.
Binary file removed content/features/video/images/item-3.png
Diff not rendered.
Binary file removed content/features/video/images/item-4.png
Diff not rendered.
66 changes: 66 additions & 0 deletions content/installation/console-first-steps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
title: "Console: First Steps"
description: "Sign in to the RustFS Console for the first time, create a bucket, and upload your first object."
---

Once your RustFS server is running, the embedded web console is the fastest way to verify the installation and start working with your data. This short tutorial walks you through your first session.

## 1. Open the Console

The console listens on port `9001` by default. In your browser, open:

```text
http://<server-ip>:9001
```

For a local test install, that is `http://127.0.0.1:9001`.

## 2. Sign In

Sign in with the credentials configured at install time:

- If you used the [Linux quick-start script](./linux/quick-start.md), the access key and secret key were printed at the end of the installation output.
- If you started RustFS via Docker or a systemd unit, use the values of `RUSTFS_ACCESS_KEY` and `RUSTFS_SECRET_KEY` from your configuration (see the [Docker guide](./docker/index.md)).

> For production deployments, change any default credentials before exposing the console. See the [Security Checklist](./checklists/security-checklists.md).

## 3. A Quick Tour

After signing in you land on the console home page, which shows:

- **Buckets** — a list of your buckets, with a **Create Bucket** button in the top left.
- **Usage overview** — object count and storage consumption at a glance.
- **Access Keys** — management of programmatic credentials (see step 6).

## 4. Create Your First Bucket

1. On the home page, in the top left corner, select **Create Bucket**.
2. Enter a bucket name (for example `my-first-bucket`) and click **Create**.

![bucket creation](../management/bucket/images/bucket-creation-by-ui.png)

Full details, including `mc` and API alternatives, are in [Bucket Creation](../management/bucket/creation.md).

## 5. Upload Your First Object

1. Click the bucket you just created.
2. In the top right corner, select **Upload File/Folder**.
3. Choose one or more local files and click **Start Upload**.

![object creation from ui](../management/object/images/upload_file_from_ui.png)

Click the uploaded object to view its details — size, ETag, content type, and a shareable link.

![object details info](../management/object/images/object_details_info.png)

More options are covered in [Object Creation](../management/object/creation.md).

## 6. Create Access Keys for Applications

The console sign-in credentials are administrator credentials — applications should use their own keys instead. Go to **Access Keys** in the console to create a scoped access key / secret key pair for your S3 clients and SDKs. See [Access Key Management](../administration/iam/access-token.md) for the full walkthrough.

## Next Steps

- Point any S3-compatible client at `http://<server-ip>:9000` (the S3 API port) with your new access keys.
- Explore [IAM management](../administration/iam/index.md) to add users and policies.
- Review the [production checklists](./checklists/index.md) before going live.
Binary file modified content/installation/linux/images/console.jpg
Diff not rendered.
Diff not rendered.
Diff not rendered.
2 changes: 1 addition & 1 deletion content/installation/macos/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ On macOS, you can use three methods for installation:

## 2. Download

Go to the official website download page and download the latest RustFS installation package.
Download the latest release from [GitHub Releases](https://github.com/rustfs/rustfs/releases) or the [official download page](https://rustfs.com/download/).

## 3. Modify Permissions

Expand Down
2 changes: 1 addition & 1 deletion content/installation/windows/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Windows startup **mode** only supports single-node single-disk mode, more suitab

## 2. Download

Go to the official website download page and download the latest RustFS installation package.
Download the latest release from [GitHub Releases](https://github.com/rustfs/rustfs/releases) or the [official download page](https://rustfs.com/download/).

## 3. Modify Permissions

Expand Down
Binary file modified content/management/object/images/object_details_info.png
90 changes: 90 additions & 0 deletions docs-review/reports/07-image-hygiene-manifest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
# Image Hygiene Manifest

Date: 2026-07-15

## Deleted unreferenced images (59 files, 3,603,522 bytes / 3519 KB reclaimed)

Referenced set computed by scanning all `.md`/`.mdx` files under `content/` (plus `src/` and site config files) for `![](...)`, `src="..."`, plain image links, and any basename mention. Only files with zero references were deleted.

| File | Size (bytes) |
|---|---:|
| content/about/images/office-location.png | 818,374 |
| content/features/ai/images/cloud-operations.png | 31,844 |
| content/features/ai/images/data-protection.png | 49,848 |
| content/features/ai/images/edge-ai-storage.png | 34,468 |
| content/features/ai/images/fault-tolerant-storage.png | 47,904 |
| content/features/ai/images/lifecycle-management.png | 21,278 |
| content/features/ai/images/llm-storage.png | 30,549 |
| content/features/ai/images/object-retention.png | 24,897 |
| content/features/ai/images/rag-storage.png | 23,855 |
| content/features/ai/images/reliable-storage.png | 23,855 |
| content/features/ai/images/training-inference-scale.png | 23,855 |
| content/features/commvault/images/atomic-metadata.png | 13,713 |
| content/features/commvault/images/commvault-logo.png | 9,376 |
| content/features/commvault/images/fast-performance.png | 8,184 |
| content/features/commvault/images/scalability.png | 62,632 |
| content/features/commvault/images/simple-secure.png | 14,367 |
| content/features/data-lake/images/decomposition.png | 485,557 |
| content/features/data-lake/images/elt-etl.png | 21,263 |
| content/features/data-lake/images/lightweight.png | 24,897 |
| content/features/data-lake/images/open-source.png | 485,557 |
| content/features/data-lake/images/rapid-growth.png | 39,682 |
| content/features/data-lake/images/resilience.png | 17,268 |
| content/features/data-lake/images/security.png | 560,723 |
| content/features/data-lake/images/simplicity.png | 35,193 |
| content/features/data-lake/images/software-defined.png | 22,564 |
| content/features/domestic/images/arrow.png | 2,203 |
| content/features/domestic/images/icon-1.png | 2,236 |
| content/features/domestic/images/icon-2.png | 3,853 |
| content/features/domestic/images/icon-3.png | 3,222 |
| content/features/domestic/images/icon-4.png | 1,098 |
| content/features/domestic/images/item-1.png | 25,654 |
| content/features/domestic/images/item-2.png | 32,252 |
| content/features/domestic/images/item-3.png | 37,860 |
| content/features/integration/images/integration-hero.svg | 1,269 |
| content/features/lifecycle/images/s9-1.png | 31,844 |
| content/features/quantitative-trading/images/ai-factor-mining.png | 27,890 |
| content/features/quantitative-trading/images/files-icon.png | 1,083 |
| content/features/quantitative-trading/images/hft-strategy.png | 39,902 |
| content/features/quantitative-trading/images/regulatory-compliance.png | 26,356 |
| content/features/quantitative-trading/images/scaling-icon.png | 1,069 |
| content/features/quantitative-trading/images/security-icon.png | 3,222 |
| content/features/quantitative-trading/images/speed-icon.png | 2,661 |
| content/features/s3-compatibility/images/s1-1.png | 41,968 |
| content/features/s3-compatibility/images/s1-2.png | 37,201 |
| content/features/small-file/images/memory-optimization.png | 37,955 |
| content/features/veeam/images/backup-performance.png | 14,367 |
| content/features/veeam/images/backup-restore.png | 7,493 |
| content/features/veeam/images/hardware-agnostic.png | 13,713 |
| content/features/veeam/images/inline-consistency.png | 8,184 |
| content/features/veeam/images/metadata-advantage.png | 62,632 |
| content/features/veeam/images/veeam-logo.png | 8,557 |
| content/features/versioning/images/versioning-overview.png | 26,894 |
| content/features/video/images/item-1.png | 755 |
| content/features/video/images/item-2.png | 2,148 |
| content/features/video/images/item-3.png | 1,145 |
| content/features/video/images/item-4.png | 1,800 |
| content/installation/linux/images/multiple-node-multiple-disk.jpg | 111,502 |
| content/installation/linux/images/single-node-multiple-disk.jpg | 33,163 |
| content/installation/linux/images/single-node-single-disk.jpg | 18,668 |

## Resized referenced images (>300 KB, width >1600px, `sips --resampleWidth 1600`)

| File | Width before | Bytes before | Bytes after | Note |
|---|---:|---:|---:|---|
| content/installation/linux/images/console.jpg | 3782 | 325,340 | 324,678 | still >300 KB after resize (JPEG, dense screenshot) |
| content/management/object/images/object_details_info.png | 3004 | 350,027 | 181,391 | now under 300 KB |

## Referenced images still >300 KB but not resized (width <= 1600px, left untouched per policy)

| File | Width | Bytes |
|---|---:|---:|
| content/about/images/vision-values.png | 1282 | 1,408,094 |
| content/features/ai/images/ai-performance.png | 1040 | 799,170 |
| content/features/cloud-native/images/multi-cloud-architecture.png | 1416 | 987,713 |
| content/features/data-lake/images/data-lake-architecture.png | 1440 | 351,922 |
| content/features/industry/images/cold-backup-solution.png | 1008 | 307,914 |
| content/features/industry/images/multi-cloud-solution.png | 1008 | 323,330 |
| content/features/industry/images/ssd-hdd-solution.png | 1008 | 323,929 |
| content/features/video/images/solution.png | 1320 | 533,392 |
| content/installation/linux/images/console.jpg | 3782->1600 | 324,678 (after resize) |
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
"dev": "waku dev",
"build": "waku build",
"start": "waku start",
"types:check": "fumadocs-mdx && tsc --noEmit"
"types:check": "fumadocs-mdx && tsc --noEmit",
"docs:check": "node scripts/docs-check.mjs"
},
"dependencies": {
"@base-ui/react": "^1.6.0",
Expand Down
Loading
Loading