Official documentation for AeroFTP — the open-source, multi-protocol file manager.
Comprehensive documentation for AeroFTP covering:
- Getting Started — Installation on Linux (.deb, .rpm, .AppImage, .snap, AUR), macOS (.dmg), and Windows (.msi)
- 23 Protocols — FTP, FTPS, SFTP, WebDAV, S3-compatible (10+ presets), Google Drive, Dropbox, OneDrive, MEGA, Box, pCloud, Azure Blob, 4shared, Filen, Zoho WorkDrive, Internxt, kDrive, Koofr, Jottacloud, FileLu, Yandex Disk, OpenDrive, GitHub
- AeroSync — Bidirectional sync with profiles, conflict resolution, bandwidth control, scheduler
- AeroVault — Military-grade AES-256-GCM-SIV encrypted containers with Argon2id KDF
- AeroAgent — AI-powered file management with 47 tools, multi-step autonomous execution, 19 AI providers
- AeroPlayer — Integrated media player with 10-band EQ, 14 visualizer modes, 6 WebGL shaders
- AeroTools — Security toolkit (Hash Forge, CryptoLab, Password Forge) in Cyber theme
- AeroFile — Local file manager with tabs, tags, and Finder-style color labels
- CLI — 14 commands, batch scripting (.aeroftp), glob patterns, JSON output, exit codes
- Security — Universal Vault (AES-256-GCM + Argon2id), TOTP 2FA, SFTP TOFU, credential isolation for AI agents
- GitHub Integration — File browsing, commits, branches, PRs, releases with CHANGELOG import, GitHub Pages monitoring, App co-authoring with dual avatars
- Advanced — Provider reference, AI provider marketplace, plugin development
Built with VitePress and deployed via GitHub Pages.
| Component | Technology |
|---|---|
| Framework | VitePress 1.x |
| Theme | Custom dark/light with AeroFTP branding |
| Deployment | GitHub Actions + GitHub Pages |
| Domain | Custom domain via CNAME (docs.aeroftp.app) |
| Search | VitePress built-in local search |
npm install
npm run docs:devThe dev server starts at http://localhost:5173.
npm run docs:build
npm run docs:previewdocs.aeroftp.app/
├── getting-started/ # Installation & quick start guides
├── features/ # AeroSync, AeroVault, AeroAgent, AeroPlayer, etc.
├── cli/ # CLI installation, commands, batch scripting, examples
├── advanced/ # Provider reference, AI providers, plugins
├── contributing/ # Build instructions & architecture
├── security/ # Encryption, credentials, TOTP (redirects to main repo)
├── public/ # Static assets (logos, icons, screenshots)
├── .vitepress/ # VitePress config, sidebar, custom theme
└── .github/workflows/ # GitHub Actions deploy pipeline
- Fork the repository
- Create a feature branch
- Make your changes (VitePress markdown)
- Run
npm run docs:devto preview locally - Submit a Pull Request
Documentation changes are automatically deployed to docs.aeroftp.app when merged to main.
GPL-3.0 - see the main AeroFTP repository for details.
