rclone-replication-ui

Web interface for managing file replication powered by rclone.

Full documentation : sixmon.github.io/rclone-replication-webui

Version française : README.fr.md

Tasks list	Task detail & logs

Remote storages	New remote form

• Remote storage — Manage rclone remotes with guided forms for the most common types (S3, SFTP, FTP, SMB, Azure Blob Storage, SharePoint, local), and key/value editor for advanced types
• Replication tasks — Cron scheduling (5 or 6 fields, macros like @daily), live cron parser with next-run preview, manual trigger, restore mode (decrypt + write to a chosen target)
• End-to-end encryption — Optional asymmetric encryption of the destination (age / X25519). The server only holds the public key (it encrypts, even on cron); the private key is never stored and is entered only at restore time. Browser-side key generation, incremental encrypted backups
• Auto-retry — Automatic retry on failure with configurable linear backoff
• Real-time monitoring — SSE progress and live logs during execution, global SSE for cross-tab state updates
• History — Last 100 runs per task with rclone statistics (transfers, volume, checks, deletes, errors), expandable inline logs
• Notifications — Markdown-formatted alerts via apprise-go (Slack, Mattermost, email, webhooks) on error, success, or skipped tasks
• Overlap protection — A running task cannot be started again; cron triggers during a running task are logged as "skipped"
• Secret Manager — Optional integration with multiple providers to store sensitive credentials outside the database: Scaleway, AWS, Azure Key Vault, Google Cloud, HashiCorp Vault, Infisical, Doppler

┌─────────────────────────────────────┐
│  Frontend container                 │
│  nginx → static files               │
│  → proxy /api/* to backend          │
└─────────────────────────────────────┘
         ↕ HTTP/REST + SSE
┌─────────────────────────────────────┐
│  Backend container (FROM scratch)   │
│  Rust (Axum) + rclone + apprise-go  │
└─────────────────────────────────────┘
         ↕ SQL              ↕ HTTPS (optional)
┌──────────────────┐    ┌────────────────────────────┐
│  PostgreSQL      │    │  Secret Manager (pluggable)│
│                  │    │  Scaleway / AWS / Azure /  │
│                  │    │  GCP / Vault / Infisical / │
│                  │    │  Doppler                   │
└──────────────────┘    └────────────────────────────┘

• Docker + Docker Compose
• PostgreSQL (or use the bundled compose file)

• Rust 1.75+
• Node.js 24+ (see frontend/.node-version)
• PostgreSQL 14+
• rclone
• apprise-go (optional, for notifications)

No external database needed — everything runs in Docker:

docker compose -f docker-compose.postgres.yml up --build

Open the interface: http://localhost

1. Create a .env file at the project root:

DATABASE_URL=postgresql://user:password@host.docker.internal:5432/rclone_ui

2. Start the containers:

docker compose up --build

3. Open the interface: http://localhost

cd backend
export DATABASE_URL="postgresql://user:password@localhost:5432/rclone_ui"
cargo run

The server starts on http://localhost:3000. Migrations run automatically on startup.

cd frontend
npm install
npm run dev

The Vite dev server starts on http://localhost:5173 and proxies /api/* to the backend.

When enabled, sensitive credentials (passwords, API secrets, keys) are stored in an external Secret Manager instead of the database. Existing credentials are migrated automatically on startup.

The provider is selected via SECRET_MANAGER_PROVIDER. Supported values:

Set SECRET_MANAGER_PROVIDER=none (default) to keep credentials in the database.

Uses the standard AWS credentials provider chain (AWS_ACCESS_KEY_ID / AWS_SECRET_ACCESS_KEY, IAM roles on EC2/ECS/EKS, IRSA, etc.).

Requires a Service Principal with Get, Set, Delete permissions on the vault.

Uses Application Default Credentials. Set GOOGLE_APPLICATION_CREDENTIALS to a service account JSON file, or rely on the GCE/GKE metadata server.

Uses the KV v2 secrets engine.

Uses Universal Auth (machine identity).

rclone-replication-ui/
├── backend/
│   ├── src/
│   │   ├── entities/       # SeaORM entities
│   │   ├── migration/      # Database migrations
│   │   ├── models/         # Request/response DTOs
│   │   ├── routes/         # API handlers
│   │   ├── services/       # Business logic
│   │   │   └── secrets/    # SecretStore abstraction (Scaleway / no-op)
│   │   └── sse/            # Server-Sent Events
│   ├── Cargo.toml
│   └── Dockerfile          # FROM scratch image
├── frontend/
│   ├── src/
│   │   ├── pages/          # React pages
│   │   ├── components/     # UI components
│   │   ├── hooks/          # React hooks
│   │   ├── api/            # API calls
│   │   ├── types/          # TypeScript types
│   │   └── config/         # Configuration schemas
│   ├── nginx.conf
│   ├── package.json
│   └── Dockerfile
├── docker-compose.yml             # External PostgreSQL
└── docker-compose.postgres.yml    # Bundled PostgreSQL 18

# Backend
cd backend && cargo build          # Build
cd backend && cargo clippy         # Lint
cd backend && cargo fmt            # Format

# Frontend
cd frontend && npm run build       # Production build
cd frontend && npm run dev         # Dev server
cd frontend && npm run lint        # Lint

# Docker
docker compose up --build                              # External PostgreSQL
docker compose -f docker-compose.postgres.yml up --build  # Bundled PostgreSQL
docker compose down                                    # Stop
docker compose logs -f backend                         # Backend logs

MIT