AsterDrive

First, Know What It Is

AsterDrive is a lightweight self-hosted cloud drive built with Rust and React. You can start with the default single-node deployment using SQLite and local storage, then connect PostgreSQL / MySQL, S3-compatible object storage, Azure Blob Storage, Tencent COS, Microsoft Graph-backed OneDrive / SharePoint drives, SFTP file servers, team spaces, WebDAV, WOPI online preview and editing, and follower node storage as needed.

It is not a full collaboration suite. The current focus is making file management, sharing, uploads, previews, storage policies, and routine operations clear for individuals and small teams. Multi-instance deployments can already run multiple Primaries over shared PostgreSQL / MySQL, Redis, and shared storage, but it is still not a complete cluster orchestration system that manages the database, Redis, object storage, and cross-region replication for you. See About AsterDrive for the exact boundary.

Follow Your Goal

I Just Want to Get It Running First

Start with Quick Start. It walks you through starting the service, creating the first administrator, uploading a file, trying sharing, checking WebDAV, and running a basic acceptance pass.

If you have already decided to deploy formally, go straight to Deployment Overview. That documentation set explains Docker, systemd, reverse proxy, launch checks, upgrades, and backup along one path.

I Have Logged In and Want to Know How to Use It

Start from User Guides. Regular users should first read the User Manual and Common Workflows, then jump to team permissions, sharing, editing, online preview, uploads, or WebDAV for specific questions.

I Need to Manage an Instance

Read Admin Console first, then Configuration Overview. AsterDrive configuration is split into startup configuration, admin-console runtime settings, storage policies, policy groups, storage policy backends, and the external network environment. It is much clearer when viewed by layer.

If you are connecting S3 / MinIO / R2 / Azure Blob Storage / Tencent COS / OneDrive / SFTP, see Storage Policy Backends.

I Want to Find Documentation by Backend Module

The user documentation is organized by reader task, not by backend module. To find “which module owns this capability”, see the developer documentation’s architecture overview and backend service ownership.

I Need to Go Live or Troubleshoot

Before going live, choose a deployment method from Deployment Overview, then add Reverse Proxy, First-Start Checklist, Production Launch Checklist, and Backup and Restore. If something is already broken, go directly to Troubleshooting, then combine it with Error Code Handling when you see an error code.

I Do Not Understand a Term, or I Do Not Know Where to Look

Start with the Glossary and FAQ Quick Reference. These two pages are not meant to be read from beginning to end; they are there to keep you from taking unnecessary detours.

---

In one sentence

Do not add mental burden to your own data - that is why we build AsterDrive.

---

First DeploymentFrom quick start to production, first get the service running, then handle HTTPS, data directories, health checks, and the first validation pass.

Daily UseFiles, workspaces, uploads, sharing, trash, WebDAV, and online editing, organized around real usage paths.

Developer DocumentationArchitecture, service ownership, and design contracts organized by backend module; read before locating modules or extending the code.

Administrator ConfigurationSeparate the responsibilities of config.toml, admin-console system settings, storage policies, policy groups, storage backends, mail, and follower nodes.

Operations and MaintenanceFirst-start checks, launch acceptance, monitoring, backup, upgrades, troubleshooting, and the operations CLI are grouped into one maintenance path.