轻阅读后端部署指南

概述

本文档将引导你完成“轻阅读”后端服务的完整部署流程。该服务基于 Java 环境运行，使用 MySQL 数据库，适用于具备基本服务器操作经验的用户。
请在开始前确保已拥有：

• 一台安装有服务器1panel面板的 Linux 服务器
• 可访问公网的 IP 地址
• 基本的文件上传与编辑能力

步骤一：下载源码

1. 访问项目发布页：Releases · autobcb/read
2. 找到最新版本，下载名称以 web 开头的压缩包（例如：web-xxx.zip 或 web-xxx.tar.gz）

步骤二：上传并解压源码

1. 登录服务器面板，进入 文件管理
2. 选择一个合适的存放路径，例如 /www/wwwroot/read
3. 点击 上传，选择刚才下载的压缩包
4. 上传完成后，选中该压缩包并点击 解压
5. 解压后，建议将文件夹内所有文件的权限设置为 755（目录）和 644（文件），如需执行权限可单独设置

安全提示：不建议直接设置为 777，以免引入安全风险。若必须开放写权限，可针对特定目录（如日志、缓存目录）单独设置。

步骤三：创建 MySQL 数据库

1. 在面板中找到 数据库 选项
2. 选择 MySQL，若未安装则根据提示安装
3. 点击 创建数据库，填写以下信息：
   • 数据库名（自定义，如 read_db）
   • 用户名（自定义）
   • 密码（建议使用强密码）
4. 创建完成后，建议将数据库权限设置为 本地服务器可访问，并为该用户授予对应数据库的全部权限
5. 记录下数据库的连接信息（主机地址、数据库名、用户名、密码），后续配置将使用

步骤四：编辑配置文件

1. 进入源码解压后的目录，找到 conf.yml 文件
2. 用文本编辑器打开，将其内容替换为以下配置，并根据实际情况修改标注的部分：

solon.dataSources:
  db:
    class: "com.zaxxer.hikari.HikariDataSource"
    driverClassName: com.mysql.cj.jdbc.Driver
    jdbcUrl: "jdbc:mysql://数据库地址?characterEncoding=UTF-8&allowMultiQueries=true&serverTimezone=UTC"
    username: "数据库用户名"
    password: "数据库密码"

admin:
  gonggao: ""           # 公告内容，留空则不显示
  username: "管理员账号"  # 自定义后台管理账号
  password: "管理员密码"  # 自定义后台管理密码
  update: false         # 是否开启定时更新任务，共享环境建议关闭
  code: ""              # 预留字段，如需使用请从APP管理后台获取密钥

user:
  allowchange: true     # 是否允许用户自助修改权限
  allowuptxt: true      # 是否允许上传txt文件
  allowimg: false       # 是否启用图片解密功能
  allowcheck: true      # 是否允许校验书源
  source: 1             # 0=不可修改书源，1=可修改后台书源，2=独立书源
  maxsource: 0          # 最大书源数量，0表示无限制
  timeout: 0            # 限制频繁操作，0表示不限制
  proxypng: false       # 是否代理封面图片
  index: 0              # 0=开启Web界面，1=仅允许注册/找回密码，2=关闭Web界面

1. 修改完成后保存文件

步骤五：配置 Java 运行环境

1. 在面板中找到 网站 或 运行环境 选项
2. 选择 Java，点击 创建运行环境
3. 根据系统架构选择合适的 JDK 版本（推荐 Java 22 或与项目兼容的版本）
4. 设置以下参数：
   • 运行路径：选择源码所在目录（如 /www/wwwroot/read）
   • 启动命令：java -jar app/read.jar
   • 端口：选择一个未被占用的端口（如 8080）
5. 确认配置并启动环境

提示：如果启动失败，请检查 Java 环境是否安装正确、端口是否被占用、配置文件是否填写错误。

步骤六：验证部署

1. 等待运行环境启动完成，通常需要 30-60 秒
2. 在浏览器中访问：
   • 后端地址：http://你的服务器IP:你设置的端口
   • 管理后台：http://你的服务器IP:你设置的端口/admin
3. 若能看到登录页面或默认界面，说明部署成功
4. 使用配置文件中设置的 管理员账号和密码 登录管理后台，进行进一步设置

常见问题

• 端口无法访问：检查服务器防火墙和安全组是否放行对应端口
• 数据库连接失败：确认数据库地址、用户名、密码是否正确，并确保数据库允许当前服务器IP连接
• Java 环境启动报错：查看运行日志，通常位于 logs/ 目录下，根据错误信息调整配置或环境

完成

恭喜你，轻阅读后端服务已部署完成！
接下来你可以在管理后台中添加书源、管理用户，并通过前端APP或Web界面使用阅读服务。