MyFSIO

MyFSIO is an S3-compatible object storage server with a Rust runtime and a filesystem-backed storage engine. The repository root is the Cargo workspace; the server serves both the S3 API and the built-in web UI from a single process.

Features

• S3-compatible REST API with Signature Version 4 authentication
• Browser UI for buckets, objects, IAM users, policies, replication, metrics, and site administration
• Filesystem-backed storage rooted at data/
• Bucket versioning, multipart uploads, presigned URLs, CORS, object and bucket tagging
• Server-side encryption and built-in KMS support
• Optional background services for lifecycle, garbage collection, integrity scanning, operation metrics, and system metrics history
• Replication, site sync, and static website hosting support

Runtime Model

MyFSIO now runs as one Rust process:

• API listener on HOST + PORT (default 127.0.0.1:5000)
• UI listener on HOST + UI_PORT (default 127.0.0.1:5100)
• Shared state for storage, IAM, policies, sessions, metrics, and background workers

If you want API-only mode, set UI_ENABLED=false. There is no separate "UI-only" runtime anymore.

Quick Start

From the repository root:

cargo run -p myfsio-server --

Useful URLs:

• UI: http://127.0.0.1:5100/ui
• API: http://127.0.0.1:5000/
• Health: http://127.0.0.1:5000/myfsio/health

On first boot, MyFSIO creates data/.myfsio.sys/config/iam.json and prints the generated admin access key and secret key to the console.

Common CLI commands

# Show resolved configuration
cargo run -p myfsio-server -- --show-config

# Validate configuration and exit non-zero on critical issues
cargo run -p myfsio-server -- --check-config

# Reset admin credentials
cargo run -p myfsio-server -- --reset-cred

# API only
UI_ENABLED=false cargo run -p myfsio-server --

Building a Binary

cargo build --release -p myfsio-server

Binary locations:

• Linux/macOS: target/release/myfsio-server
• Windows: target/release/myfsio-server.exe

Run the built binary directly:

./target/release/myfsio-server

Configuration

The server reads environment variables from the process environment and also loads, when present:

• /opt/myfsio/myfsio.env
• .env
• myfsio.env

Core settings:

Variable	Default	Description
HOST	127.0.0.1	Bind address for API and UI listeners
PORT	5000	API port
UI_PORT	5100	UI port
UI_ENABLED	true	Disable to run API-only
STORAGE_ROOT	./data	Root directory for buckets and system metadata
IAM_CONFIG	<STORAGE_ROOT>/.myfsio.sys/config/iam.json	IAM config path
API_BASE_URL	unset	Public API base used by the UI and presigned URL generation
AWS_REGION	us-east-1	Region used in SigV4 scope
SIGV4_TIMESTAMP_TOLERANCE_SECONDS	900	Allowed request time skew
PRESIGNED_URL_MIN_EXPIRY_SECONDS	1	Minimum presigned URL expiry
PRESIGNED_URL_MAX_EXPIRY_SECONDS	604800	Maximum presigned URL expiry
SECRET_KEY	loaded from .myfsio.sys/config/.secret if present	Session signing key and IAM-at-rest encryption key
ADMIN_ACCESS_KEY	unset	Optional first-run or reset access key
ADMIN_SECRET_KEY	unset	Optional first-run or reset secret key

Feature toggles:

Variable	Default
ENCRYPTION_ENABLED	false
KMS_ENABLED	false
GC_ENABLED	false
INTEGRITY_ENABLED	false
LIFECYCLE_ENABLED	false
METRICS_HISTORY_ENABLED	false
OPERATION_METRICS_ENABLED	false
WEBSITE_HOSTING_ENABLED	false
SITE_SYNC_ENABLED	false

Metrics and replication tuning:

Variable	Default
OPERATION_METRICS_INTERVAL_MINUTES	5
OPERATION_METRICS_RETENTION_HOURS	24
METRICS_HISTORY_INTERVAL_MINUTES	5
METRICS_HISTORY_RETENTION_HOURS	24
REPLICATION_CONNECT_TIMEOUT_SECONDS	5
REPLICATION_READ_TIMEOUT_SECONDS	30
REPLICATION_MAX_RETRIES	2
REPLICATION_STREAMING_THRESHOLD_BYTES	10485760
REPLICATION_MAX_FAILURES_PER_BUCKET	50
SITE_SYNC_INTERVAL_SECONDS	60
SITE_SYNC_BATCH_SIZE	100
SITE_SYNC_CONNECT_TIMEOUT_SECONDS	10
SITE_SYNC_READ_TIMEOUT_SECONDS	120
SITE_SYNC_MAX_RETRIES	2
SITE_SYNC_CLOCK_SKEW_TOLERANCE_SECONDS	1.0

UI asset overrides:

Variable	Default
TEMPLATES_DIR	built-in crate templates directory
STATIC_DIR	built-in crate static directory

See docs.md for the full Rust-side operations guide.

Data Layout

data/
  <bucket>/
  .myfsio.sys/
    config/
      iam.json
      bucket_policies.json
      connections.json
      operation_metrics.json
      metrics_history.json
    buckets/<bucket>/
      meta/
      versions/
    multipart/
    keys/

Docker

Build the Rust image from the repository root:

docker build -t myfsio .
docker run --rm -p 5000:5000 -p 5100:5100 -v "${PWD}/data:/app/data" myfsio

If the instance sits behind a reverse proxy, set API_BASE_URL to the public S3 endpoint.

Linux Installation

The repository includes scripts/install.sh for systemd-style Linux installs. Build the Rust binary first, then pass it to the installer:

cargo build --release -p myfsio-server

sudo ./scripts/install.sh --binary ./target/release/myfsio-server

The installer copies the binary into /opt/myfsio/myfsio, writes /opt/myfsio/myfsio.env, and can register a myfsio.service unit.

Testing

Run the Rust test suite from the workspace:

cargo test

Health Check

GET /myfsio/health returns:

{
  "status": "ok",
  "version": "0.5.0"
}

The version field comes from the Rust crate version in crates/myfsio-server/Cargo.toml.