mirror of https://github.com/rustfs/rustfs.git synced 2026-03-17 14:24:08 +00:00

Files

houseme 94cdb89e29 feat(obs): add init_obs_with_config API and signature guard test (#2175 )

Signed-off-by: houseme <housemecn@gmail.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>

2026-03-16 18:17:55 +08:00

src

feat(obs): add init_obs_with_config API and signature guard test (#2175 )

2026-03-16 18:17:55 +08:00

AGENTS.md

docs: scope AGENTS instructions by directory (#2083 )

2026-03-05 17:25:37 +08:00

Cargo.toml

feat: Simple OPA support (#644 )

2025-10-16 10:35:26 +08:00

README.md

refactor(config): normalize scanner env naming (#2129 )

2026-03-11 22:41:41 +08:00

README.md

RustFS Config - Configuration Management

Configuration management and validation module for RustFS distributed object storage

📖 Documentation · 🐛 Bug Reports · 💬 Discussions

📖 Overview

RustFS Config provides configuration management and validation capabilities for the RustFS distributed object storage system. For the complete RustFS experience, please visit the main RustFS repository.

✨ Features

Multi-format configuration support (TOML, YAML, JSON, ENV)
Environment variable integration and override
Configuration validation and type safety
Hot-reload capabilities for dynamic updates
Default value management and fallbacks
Secure credential handling and encryption

📚 Documentation

For comprehensive documentation, examples, and usage guides, please visit the main RustFS repository.

Environment Variable Naming Conventions

RustFS uses a flat naming style for top-level configuration: environment variables are RUSTFS_* without nested module segments.

Examples:

RUSTFS_REGION
RUSTFS_ADDRESS
RUSTFS_VOLUMES
RUSTFS_LICENSE

Current guidance:

Prefer module-specific names only when they are not top-level product configuration.
Renamed variables must keep backward-compatible aliases until before beta.
Alias usage must emit deprecation warnings and be treated as transitional only.
Deprecated example:
- RUSTFS_ENABLE_SCANNER -> RUSTFS_SCANNER_ENABLED
- RUSTFS_ENABLE_HEAL -> RUSTFS_HEAL_ENABLED
- RUSTFS_DATA_SCANNER_START_DELAY_SECS -> RUSTFS_SCANNER_START_DELAY_SECS

Scanner environment aliases

RUSTFS_SCANNER_START_DELAY_SECS (canonical)
RUSTFS_DATA_SCANNER_START_DELAY_SECS (deprecated alias for compatibility)

📄 License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.