SFTPWarden Documentation

SFTPWarden is a CLI-first, container-native SFTP management tool. It keeps the OpenSSH runtime small, stores operational state outside the image, and lets operators manage local, remote, and Kubernetes deployments through explicit commands and declarative providers.

Start Here

  • Getting Started: install the CLI, create a first project, add a user, deploy, and choose the right next guide.

  • Operations: understand deploy, refresh, watcher sync, backup/restore, health checks, remote cleanup, Kubernetes, and Helm workflows.

  • Configuration: configure sftpwarden.yaml, contexts, deployment targets, runtime settings, and provider storage.

Core Topics

  • Providers: choose YAML, CSV, SQLite, MySQL, MariaDB, PostgreSQL, or MongoDB, and understand schema v1 versus schema v2.

  • Named Keys: manage schema v2 SSH keys with names, metadata, rotation, expiry, disable/enable, import, and migration from schema v1.

  • Security: review chroot, passwords, host keys, secrets, backups, remote access, watcher behavior, and runtime boundaries.

Reference

  • CLI Reference: command-by-command behavior and examples from the real Typer command surface.

  • Contributing: development setup, validation, release checks, documentation build, and GitHub Pages publication.