1.  > 
  2. Documentation
s3-orchestrator

Documentation

Comprehensive documentation for deploying, configuring, and operating the S3 Orchestrator.
Quickstart

Get running locally in under a minute.

README

Project overview, features, configuration reference, and metrics.

User Guide

Connect with AWS CLI, rclone, SDKs, and other S3 clients.

Admin Guide

Deploy, configure, and operate in production.

API Reference

JSON APIs for programmatic access.

Security Hardening

TLS, credentials, network isolation, and encryption best practices.

Performance Tuning

Connection pools, timeouts, caching, and resource sizing.

Disaster Recovery

Failure scenarios and recovery procedures.

Version Migration

Upgrade paths, breaking changes, and database migrations.

Benchmarking

Micro-benchmarks for hot-path performance regression testing.

Changelog

Release history and notable changes by version.

s3-orchestrator s3-orchestrator

  • Home


    • Documentation
      • Quickstart
      • README
      • User Guide
      • Admin Guide
      • API Reference
      • Security Hardening
      • Performance Tuning
      • Disaster Recovery
      • Version Migration
      • Changelog
      • Benchmarking
      • Performance envelope
    • Guides
      • Nomad/k8s Full Stack Demo
      • Encrypting Existing Data
      • Key Rotation
      • Maximizing Free Tiers
      • Understanding Replication
      • Event Notifications
      • Local to Cloud Replication
      • Simple Multi-Cloud Redundancy
      • Deploying on Nomad with Vault
      • Deploying with systemd
    • Diagrams
      • Architecture
      • Admission Control
      • Write Path
      • Read Path
      • Circuit Breaker
      • Encryption Flow
      • Background Services
      • Database Schema
    • Go API Reference
      • accounting
      • admin
      • adminctl
      • audit
      • auth
      • backend
      • breaker
      • bufpool
      • cache
      • chunkframing
      • config
      • core
      • counter
      • dashboard
      • di
      • drain
      • encryption
      • event
      • httpserver
      • httputil
      • infra
      • initcmd
      • instanceid
      • internalkey
      • ioutilx
      • lifecycle
      • logfmt
      • metrics
      • multipart
      • must
      • notify
      • object
      • observe
      • postgres
      • proxy
      • proxytest
      • readpath
      • reconcile
      • reload
      • runtime
      • s3api
      • serve
      • sqlite
      • store
      • storetest
      • synccmd
      • syncutil
      • telemetry
      • tickrunner
      • ui
      • worker
      • workerpool
      • writepath

        Built by Alex Freidah

        MIT License