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"></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 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
• RUSTFS_LICENSE_PUBLIC_KEY

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

License environment variables

• RUSTFS_LICENSE contains the signed license token.
• RUSTFS_LICENSE_PUBLIC_KEY contains the RSA public key used to verify signed license tokens.

CORS environment variables

• RUSTFS_CORS_ALLOWED_ORIGINS defaults to empty, so the S3 endpoint emits no generic CORS headers unless configured. Set * for wildcard origins without credentials, or a comma-separated allow-list for credentialed explicit origins.
• RUSTFS_CONSOLE_CORS_ALLOWED_ORIGINS defaults to * for the console service.

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.

Drive timeout health-action policy:

• RUSTFS_DRIVE_TIMEOUT_HEALTH_ACTION
  • mark_failure (default): timeout marks failure and may transition drive runtime state.
  • ignore_scanner: timeout does not mark failure for scanner-sensitive operations (walk_dir, read_metadata, list_dir, disk_info).

Drive timeout profile preset:

• RUSTFS_DRIVE_TIMEOUT_PROFILE
  • default (default): keep current timeout defaults.
  • high_latency: use 60s default timeout for scanner-sensitive operations when no per-operation timeout override is set (read_metadata, disk_info, list_dir, walk_dir, walk_dir_stall).
• Precedence:
  • Explicit per-operation timeout env (RUSTFS_DRIVE_*_TIMEOUT_SECS) takes highest precedence.
  • Then RUSTFS_DRIVE_MAX_TIMEOUT_DURATION legacy fallback.
  • Then the profile-derived default (default or high_latency).

Startup filesystem boundary policy

• RUSTFS_UNSUPPORTED_FS_POLICY controls startup behavior when RustFS detects local endpoint filesystems that are outside the supported production boundary.
  • warn (default): log warning and continue startup.
  • fail: abort startup with an error.

RustFS production guidance remains direct-attached local POSIX filesystems. Network-mounted filesystems (for example nfs, cifs, smb2, and fuse.*) are treated as unsupported by this startup guard.

📄 License

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