使用指南
这一组文档按“你现在要做什么”来分,不按功能名硬背。
如果你是第一次来,先走 快速开始。如果服务已经跑起来,按自己的角色直接跳到对应入口。
第一次部署
你只想先把服务跑起来,看这几篇:
- 快速开始:用最少步骤跑通登录、上传、分享和 WebDAV
- 部署概览:正式上线前先选 Docker、systemd 还是直接运行二进制
- 首次启动检查:确认默认配置、存储策略、健康检查和后台任务是否正常
- 反向代理:准备挂 HTTPS、域名、WebDAV 或 WOPI 时看这一篇
日常使用
服务已经能打开后,普通用户优先看这里:
- 用户手册:文件、工作空间、回收站、分享、WebDAV 和个人设置
- 常用流程:按真实场景串起常见操作
- 团队与权限:个人空间、团队空间、团队角色和管理员边界
- 分享与公开访问:分享链接、密码、过期时间、下载次数
- 文件编辑:浏览器内编辑、历史版本、WOPI 打开方式
- 在线预览与 WOPI:OnlyOffice、Collabora 和 WOPI 打开方式接入
- 上传与大文件:断点续传、对象存储直传和失败排查
管理员
管理员要先分清三类入口:后台页面、运行时系统设置、启动配置文件。
- 管理后台:后台每个页面负责什么
- 配置总览:
config.toml、系统设置、存储策略和外部代理分别管什么 - 系统设置:站点、注册、Cookie、邮件、调度、回收站、WOPI、审计日志
- 存储策略:本地、S3 / MinIO、远程节点和策略组
- 存储策略后端:按后端类型配置 S3 / MinIO / R2 等真实落点
- 远程节点:把另一台 AsterDrive 接成远程存储后端
- 自定义前端:替换前端资源、注入自定义配置和处理 CSP
运维维护
上线后,稳定运行比“能打开页面”更重要。建议提前把检查、备份、升级和排障路径准备好。
- 运维 CLI:
doctor、离线系统设置、跨数据库迁移、节点接入 - 生产上线检查:上线前最后一轮 HTTPS、数据、备份、存储和真实功能验收
- 升级与版本迁移:升级前备份、升级后验证、失败回滚
- 备份与恢复:数据库、配置、本地上传目录和恢复顺序
- 故障排查:服务启动、上传、下载、分享、WebDAV、WOPI 和后台任务
- 性能基准与压测:建立本地基线和复跑 smoke
项目本身
想知道 AsterDrive 为什么这么设计、适合谁、不适合谁,看 关于 AsterDrive。
概念看不懂先看 术语表。碰到问题先看 常见问题速查,有错误码再看 错误码处理。如果错误发生在部署、反向代理、WebDAV 或 WOPI 场景里,再配合 故障排查 一起看。