Skip to content

docs: explain SigV4-safe root access keys - #121

Merged
overtrue merged 1 commit into
mainfrom
codex/docs-sigv4-access-key-guidance
Jul 30, 2026
Merged

docs: explain SigV4-safe root access keys#121
overtrue merged 1 commit into
mainfrom
codex/docs-sigv4-access-key-guidance

Conversation

@overtrue

Copy link
Copy Markdown
Collaborator

Summary

  • explain why root access keys containing / break the AWS Signature Version 4 credential scope
  • recommend the uppercase alphanumeric format generated by RustFS and warn against using raw Base64 output as an access key
  • add concise preventive guidance to the English and Chinese Linux quick-start pages

Why

A root access key containing / adds an unexpected delimiter to the SigV4 Credential field. RustFS currently accepts the configured value at startup, but signed requests can then fail with an invalid authorization header.

Closes rustfs/rustfs#3959

Validation

  • npm run docs:check
  • npm run types:check
  • npm run build

@vercel

vercel Bot commented Jul 30, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs-rustfs-com Error Error Jul 30, 2026 10:29am

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Updated (UTC)
❌ Deployment failed
View logs
rustfs-docs 28fd5d5 Jul 30 2026, 10:28 AM

@overtrue
overtrue marked this pull request as ready for review July 30, 2026 10:29
Copilot AI review requested due to automatic review settings July 30, 2026 10:29
@overtrue
overtrue merged commit e71e92d into main Jul 30, 2026
2 of 4 checks passed

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@overtrue
overtrue deleted the codex/docs-sigv4-access-key-guidance branch July 30, 2026 10:29
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.

[Documentation] Need explanation for the admin username/password format validations

2 participants