Skip to content

docs: update quick start to RustFS and working package downloads - #505

Merged
thweetkomputer merged 1 commit into
mainfrom
docs/readme-rustfs-quickstart
Oct 8, 2026
Merged

thweetkomputer merged 1 commit into
mainfrom
docs/readme-rustfs-quickstart

Conversation

@thweetkomputer

@thweetkomputer thweetkomputer commented Oct 6, 2026 •

Copy link
Copy Markdown
Collaborator

The quick start still uses MinIO after CI switched to RustFS, and its 0.2.7 package download URLs return 404. Update the examples to use available nightly packages and a pinned RustFS 1.0.0 Docker container, with architecture detection for the cloud package, localhost-only S3 access, and explicit credentials that override the shipped placeholders.

Add Docker installation and permission guidance, retry connection resets while RustFS starts, and switch to the package directory before running the client in a new terminal.

Validation:

  • On Ubuntu 24.04 ARM64 with Docker Engine 29.8.2, ran the README container commands against a fresh named volume, started the nightly RocksDBCloud package, and verified the documented insert/query returned {k: 1}.
  • Also verified the same application flow with the RustFS 1.0.0 native binary.
  • Shell syntax checks and git diff --check passed.

Summary by CodeRabbit

  • Documentation
    • Updated the RocksDB quick start to use the nightly release.
    • Revised RocksDBCloud setup instructions to select the appropriate package for x86_64 and aarch64 systems, with unsupported architectures exiting.
    • Replaced the manual MinIO setup steps with a RustFS Docker container, including a readiness check and local-test credentials.
    • Updated the server command to pass credentials explicitly and the client instructions to run from the package directory.

@coderabbitai

coderabbitai Bot commented Oct 6, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: ca3605d8-3648-4dfc-8674-587cc0ca8b20
📥 Commits

Reviewing files that changed from the base of the PR and between eda6a6e and b7caf1c.

📒 Files selected for processing (1)
  • README.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.


Walkthrough

The README quick start now uses nightly RocksDB packages and selects RocksDBCloud packages by host architecture. It replaces the MinIO setup with RustFS Docker instructions, a readiness check, explicit credentials, and an updated client command.

Changes

RocksDB quick start

Layer / File(s) Summary
Package release and architecture
README.md
The RocksDB examples use the nightly release. The RocksDBCloud instructions select amd64 or arm64 based on the host architecture and exit for unsupported architectures.
RustFS setup and client commands
README.md
The RocksDBCloud instructions run RustFS in Docker and check its readiness. They provide local-test credentials, pass them to the server, and change to the package directory before running the client.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Suggested reviewers: zhangh43

Merge Risk: ⚪ Minimal · up to b7caf

The updated quick start has no evidenced merge-blocking issue. The reported Ubuntu ARM64 setup and insert/query validation support readiness to merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the README quick-start updates to RustFS and working package downloads.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

A rabbit reads the nightly guide
RustFS waits, then opens wide
Two architectures find their way
Credentials help the server play
The client hops in to start the day

Comment @coderabbitai help to get the list of available commands.

@thweetkomputer
thweetkomputer merged commit 49bd623 into main Oct 8, 2026
7 checks passed
@thweetkomputer
thweetkomputer deleted the docs/readme-rustfs-quickstart branch October 8, 2026 05:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant