Sinan 司南

Appearance

部署 Sinan 站点 ​

先决条件 ​

在开始之前，请确保您已满足以下先决条件：

  • Docker
  • Docker Compose
  • CPU 1核心 内存 2GB

部署步骤 ​

  1. 克隆项目到本地
bash
git clone https://github.com/PeixyJ/sinan-quick-start
cd sinan-quick-start
  1. 创建必需的配置文件 确保项目根目录下包含以下文件：
  • sinan_dev.sql - 数据库初始化脚本
  • application.yaml - Spring Boot 配置文件
  • nginx.conf - Nginx 配置文件
  1. 启动所有服务

中国大陆用户（推荐）:

bash
docker-compose -f docker-compose-cn.yaml up -d

海外用户或网络环境良好:

bash
docker-compose up -d
  1. 查看服务状态
bash
docker-compose ps

服务访问 ​

  • 前端应用: http://localhost
  • 后端API: http://localhost:8080
  • MySQL数据库: localhost:3306
  • Redis: localhost:6379

环境变量配置 ​

以下是 docker-compose.yml 中所有服务的环境变量配置说明：

sinan-server 服务环境变量 ​

变量名默认值描述是否必须
SPRING_PROFILES_ACTIVEprodSpring 运行环境配置是
TZAsia/Shanghai时区设置否
DB_HOSTmysqlMySQL 数据库主机地址是
DB_PORT3306MySQL 数据库端口是
DB_NAMEsinanMySQL 数据库名称是
DB_USERNAMEsinanMySQL 数据库用户名是
DB_PASSWORDsinan123MySQL 数据库密码是
REDIS_HOSTredisRedis 主机地址是
REDIS_PORT6379Redis 端口是
REDIS_PASSWORD(空)Redis 密码否
REDIS_DATABASE0Redis 数据库索引否
LOG_LEVELINFO日志级别否
APP_LOG_LEVELINFO应用日志级别否
LOG_FILE_PATH/app/logs/sinan-server.log日志文件路径否
GITHUB_CLIENT_ID<GITHUB_CLIENT_ID>GitHub OAuth 客户端 ID是
GITHUB_CLIENT_SECRET<GITHUB_CLIENT_SECRET>GitHub OAuth 客户端密钥是
GITHUB_REDIRECT_URI<GITHUB_REDIRECT_URI>GitHub OAuth 回调 URL是

sinan-web 服务环境变量 ​

变量名默认值描述是否必须
SINAN_BASE_URLhttps://sinan.hostSinan 基础 URL是
UPLOAD_BASE_PATH./upload文件上传基础路径否
UPLOAD_ICON_PATHicons图标上传路径否
UPLOAD_URL_PREFIX/api/bookmark上传 URL 前缀否

Passkey 相关环境变量（可选） ​

变量名默认值描述是否必须
PASSKEY_IDsinan.hostPasskey 标识符否
PASSKEY_NAMEsinanPasskey 名称否
PASSKEY_ORIGINhttps://sinan.hostPasskey 来源地址否

sinan-website 服务环境变量 ​

变量名默认值描述是否必须
TZAsia/Shanghai时区设置否
API_BASE_URLapiAPI 基础 URL是
NODE_ENVproductionNode.js 运行环境是

mysql 服务环境变量 ​

变量名默认值描述是否必须
MYSQL_ROOT_PASSWORDroot123MySQL root 用户密码是
MYSQL_DATABASEsinan初始化创建的数据库名是
MYSQL_USERsinanMySQL 普通用户名是
MYSQL_PASSWORDsinan123MySQL 普通用户密码是
TZAsia/Shanghai时区设置否

重要提示

  • 标记为是的变量（特别是 GitHub OAuth 相关配置）必须在部署前进行配置
  • <GITHUB_CLIENT_ID>、<GITHUB_CLIENT_SECRET> 和 <GITHUB_REDIRECT_URI> 需要替换为实际的 GitHub OAuth 应用配置
  • 数据库密码建议在生产环境中修改为更安全的密码

GitHub OAuth 配置说明 ​

要获取 GitHub OAuth 配置，请按以下步骤操作：

  1. 访问 GitHub Developer Settings
  2. 点击 "New OAuth App"
  3. 填写以下信息：
    • Application name: Sinan
    • Homepage URL: https://your-domain.com
    • Authorization callback URL: https://your-domain.com/api/oauth/callback/github
  4. 创建后获取 Client ID 和 Client Secret
  5. 将这些值填入对应的环境变量中