Files

79 lines
3.9 KiB
Markdown

# MirrorITS
爱特开源软件镜像站(MirrorITS)的前端与管理服务,由[中国海洋大学爱特工作室](https://www.itouc.cn/)开发部署。使用 Vue 3、TypeScript 和 Go,支持镜像展示、公告、使用帮助与管理后台,同步任务由 [tunasync](https://github.com/tuna/tunasync) 执行。
## 部署
### 使用 Release
从 [Releases](https://git.itouc.cn/ITStudio_OUC/OUCMirror-WebUI/releases) 下载与服务器系统、CPU 架构匹配的预编译包并解压。没有预编译部署包时,按下一节自行编译。
部署目录只需包含:
```text
mirrorouc/
|-- mirrorouc # 后端程序
`-- dist/ # 前端构建产物
```
### 自行编译
需要 Node.js 22.18+ 和 Go 1.27+。在目标服务器或相同系统与架构的构建环境中,从项目根目录执行:
```bash
npm ci
npm run build
mkdir -p .local
go -C backend build -o ../.local/mirrorouc .
```
将 `.local/mirrorouc` 与完整的 `dist/` 放到同一个部署目录,按下面的步骤启动。
## 对接 tunasync
先启动 tunasync Manager 和 Worker,确认 Manager API 可访问,并取得 Worker 配置中 `[global].name` 对应的 ID。
在部署目录中,首次运行以下命令创建管理员,随机密码会输出到终端:
```bash
./mirrorouc -data ./data -init-admin admin
```
然后启动服务,将 Manager 地址和 `YOUR_WORKER_ID` 替换为实际值:
```bash
./mirrorouc -static ./dist -data ./data -manager http://127.0.0.1:12345 -worker YOUR_WORKER_ID
```
默认监听 `127.0.0.1:8081`,可通过 `-listen` 修改。首页为 `/`,公告页为 `/announcements`,管理后台为 `/admin`,同步状态页为 `/status`。数据库与上传文件保存在 `data/`,更新时保留该目录。
镜像使用帮助位于 `/help/<源名>/`,在后台“镜像与任务”的“展示信息”中使用 Markdown 编辑。所有界面语言使用同一份中文帮助文章;未填写文章的镜像不显示帮助按钮。
常用镜像的帮助原稿见 [docs/help/](docs/help/README.md),可复制到后台发布;线上编辑的文章保存在数据库中,部署不会自动覆盖。
帮助正文可插入交互式配置块,例如 Ubuntu:
```mirror-config
{"type":"ubuntu"}
```
后台的“插入配置生成器”可直接选择软件源并插入对应标记。支持 Debian、Ubuntu、Debian Security、Arch 系列、Conda、Kubernetes、Tailscale、Proxmox VE、OpenWrt 和 ELRepo;控件按软件源提供版本、格式、频道等选项。
可用 `format` 固定配置格式,`options` 设置默认选项。已有 Debian 标记保持兼容:
```mirror-config
{"type":"debian","format":"list"}
```
新增软件源的控件规则在 `src/mirror-config.ts` 中注册,共用界面、复制和 Markdown 解析;APT 格式生成逻辑位于 `src/apt-sources.ts`。
已有生成器的版本在后台“配置生成器”中维护,支持添加、排序、移除和设置默认版本。Ubuntu 等发行新版本时,填写官方代号与显示名称即可,无需修改代码或重新部署;Debian 的更新组件、Proxmox 的密钥环路径也在此设置。请先确认镜像已同步对应版本,生成器设置不会创建同步任务。
版本目录保存在数据库中,由 `/api/v1/generators` 提供给帮助页。`backend/generator-defaults.json` 只用于首次初始化,升级不会覆盖后台保存的选项。
镜像目录与下载由已有的 Web 服务器提供,路径为 `/mirrors/<源名>/`。自定义目录页的 Fancyindex 模板随前端构建生成在 `dist/fancy-index/` 中。
构建还会生成 `dist/errors/` 下的独立错误页。后端自动使用这些页面;使用 Nginx 时,可将其错误页指向对应文件,并保留 API 错误的 JSON 响应。
需要本机监控采集或受限配置写入时,可按需对接 `backend/tools/` 中的工具。更多启动参数可通过 `./mirrorouc -help` 查看。