使用文档

从零开始部署与配置 AuroraDesk。

快速开始

1. 在服务端所在目录启动程序(务必先将工作目录切换到程序目录):

# Windows
cd C:\AuroraDesk
.\AuroraDesk.exe

# Linux
cd /opt/auroradesk
./auroradesk

2. 浏览器访问 http://localhost:8080,注册第一个账号。

首个注册的账号会自动成为管理员,请在部署后第一时间完成注册。

⚠️
数据库路径取决于进程的工作目录。请始终在程序所在目录启动, 否则会在错误位置创建空数据库,导致数据看起来「不见了」。

环境变量配置

全部配置通过环境变量注入(统一前缀 AURORA_), 也可在程序目录放置 .env 文件。环境变量优先级最高。

变量默认值说明
AURORA_SERVER_PORT8080Web 服务端口
AURORA_SFTP_PORT2222SFTP 服务端口
AURORA_DATA_PATH./data数据目录(SQLite 数据库等)
AURORA_MINIAPP_PLATFORM_URL小程序平台地址
AURORA_MINIAPP_PLATFORM_KEY小程序平台 X-API-Key
AURORA_TMDB_API_KEY影视元数据(可选)

SFTP 接入

服务启动后,SFTP 服务端默认监听 2222 端口, 使用与 Web 端相同的账号密码即可连接:

sftp -P 2222 yourname@your-server

SFTP 与 Web 端共享同一套虚拟文件系统、权限与回收站策略,行为保持一致。

常见问题

启动后浏览器打不开页面?
先确认服务进程已启动且端口未被占用(默认 8080)。若部署在服务器上, 需确认防火墙已放行该端口;建议通过反向代理启用 HTTPS 后再对外提供服务。
数据存放在哪里?可以备份吗?
默认存放在程序目录下的 data/ 子目录(SQLite 数据库 AuroraDesk.db 与文件数据)。备份时先停止服务,再整体复制该目录即可。
忘记管理员密码怎么办?
目前需通过数据库重置。建议管理员账号启用后妥善保管密码,并定期备份 data/ 目录。后续版本将提供密码找回功能。
可以放在公网访问吗?
可以,但强烈建议通过 Nginx 等反向代理配置 HTTPS 后再暴露到公网, 不要直接把 HTTP 端口暴露在外网。
支持 Docker 部署吗?
当前版本提供单文件原生部署,Docker 镜像在规划中。