AsterDrive Developer Documentation
This is the source-level documentation library for AsterDrive contributors, integration developers, and maintainers. It covers repository architecture, domain design, APIs, protocol contracts, test infrastructure, and diagnostic workflows. End users, deployers, and administrators should start with the user documentation.
Where to start
Section titled “Where to start”| Goal | Start here |
|---|---|
| Build a mental model of the repository | Architecture overview → Core module design notes |
| Decide which backend layer owns a change | Backend service ownership boundaries |
| Find REST, WebDAV, WOPI, or internal protocol behavior | API overview |
| Change storage, upload, authentication, or remote-node behavior | Domain design and contracts |
| Run database, WebDAV, or diagnostic checks | Testing and diagnostics |
| Read draft discussions or historical design context | Draft and historical records |
Documentation library
Section titled “Documentation library”Architecture and boundaries
Section titled “Architecture and boundaries”- Architecture overview: node modes, layering, startup, configuration, and data flow.
- Core module design notes: internal shapes of file, upload, task, storage, and protocol modules.
- Backend service ownership boundaries: responsibilities of routes, services, domain modules, repositories, storage, and protocols.
Domain design and contracts
Section titled “Domain design and contracts”- Domain design and contract index
- External authentication module
- Storage descriptor and field normalization
- Object naming and OneDrive direct downloads
- Upload finalization contracts
- Remote storage target and policy ownership — translation pending
APIs and protocols
Section titled “APIs and protocols”The API overview links every endpoint page across authentication, file workflows, teams and sharing, background tasks, administration, WebDAV, WOPI, health checks, and the follower internal storage protocol. The generated OpenAPI document remains the machine-readable contract.
Testing and diagnostics
Section titled “Testing and diagnostics”Draft and historical records
Section titled “Draft and historical records”- Draft and historical record index
- Static configuration secret-handling memo — draft, translation pending
- Service modularization refactor plan — historical snapshot, translation pending
Document status
Section titled “Document status”| Status | Meaning |
|---|---|
| Current implementation | Default; expected to match current code, routes, and tests |
| Draft | A discussion direction that has not been accepted or completed |
| Historical snapshot | Decision context only; old names and paths are not current implementation guidance |
| Translation pending | The Chinese source is available and the English site may show Starlight fallback content |
Verify claims against the current code and focused tests before updating implementation. An old document path is not a reason to resurrect an obsolete compatibility layer.