mirror of
https://github.com/rustfs/rustfs.git
synced 2026-08-05 12:57:42 +00:00
houseme
78 lines
3.1 KiB
Markdown
78 lines
3.1 KiB
Markdown
[](https://rustfs.com)
|
|
|
|
# RustFS Config - Configuration Management
|
|
|
|
<p align="center">
|
|
<strong>Configuration management and validation module for RustFS distributed object storage</strong>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/rustfs/rustfs/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/rustfs/rustfs/actions/workflows/ci.yml/badge.svg" /></a>
|
|
<a href="https://docs.rustfs.com/">📖 Documentation</a>
|
|
· <a href="https://github.com/rustfs/rustfs/issues">🐛 Bug Reports</a>
|
|
· <a href="https://github.com/rustfs/rustfs/discussions">💬 Discussions</a>
|
|
</p>
|
|
|
|
---
|
|
|
|
## 📖 Overview
|
|
|
|
**RustFS Config** provides configuration management and validation capabilities for the [RustFS](https://rustfs.com) distributed object storage system. For the complete RustFS experience, please visit the [main RustFS repository](https://github.com/rustfs/rustfs).
|
|
|
|
## ✨ 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](https://github.com/rustfs/rustfs).
|
|
|
|
## 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_SPEED` (canonical, also accepts `MINIO_SCANNER_SPEED`)
|
|
- `RUSTFS_SCANNER_CYCLE` (canonical, also accepts `MINIO_SCANNER_CYCLE`)
|
|
- `RUSTFS_SCANNER_START_DELAY_SECS` (canonical)
|
|
- `RUSTFS_DATA_SCANNER_START_DELAY_SECS` (deprecated alias for compatibility)
|
|
- `RUSTFS_SCANNER_IDLE_MODE` (canonical)
|
|
- `RUSTFS_SCANNER_CACHE_SAVE_TIMEOUT_SECS` (canonical)
|
|
|
|
## Drive timeout environment variables
|
|
|
|
- `RUSTFS_DRIVE_METADATA_TIMEOUT_SECS`
|
|
- `RUSTFS_DRIVE_DISK_INFO_TIMEOUT_SECS`
|
|
- `RUSTFS_DRIVE_LIST_DIR_TIMEOUT_SECS`
|
|
- `RUSTFS_DRIVE_WALKDIR_TIMEOUT_SECS`
|
|
- `RUSTFS_DRIVE_WALKDIR_STALL_TIMEOUT_SECS`
|
|
|
|
Legacy compatibility fallback:
|
|
- `RUSTFS_DRIVE_MAX_TIMEOUT_DURATION`
|
|
This legacy variable is treated as a deprecated fallback for the operation-specific drive timeout variables above when a canonical variable is unset.
|
|
|
|
## 📄 License
|
|
|
|
This project is licensed under the Apache License 2.0 - see the [LICENSE](../../LICENSE) file for details.
|