README
¶
TbSign➡️
只是一个签到程序，可以配合百度贴吧云签到使用，也可以独立运作
⚠ 注意
- 随缘维护，不保证不会封号，请不要用于主力账号！！！
- 不接受任何路线图以外的 PR，路线图内的 PR 不一定会接受
flags
| flag | default | description |
|---|---|---|
| username | 数据库账号 | |
| pwd | 数据库密码 | |
| endpoint | 127.0.0.1:3306 |
数据库端点 |
| db | tbsign |
数据库名称 |
| db_path | SQLite 文件目录 | |
| test | false |
测试模式，此模式下不会运行计划任务 |
| api | false |
是否启动 api |
| fe | false |
是否启动自带前端，仅当 api 为 true 时可为 true |
| address | :1323 |
后端运行地址 |
| setup | false |
强制安装程序（可能会覆盖现有配置） |
| auto_install | false |
自动安装（仅当数据库不存在时安装） |
| admin_name | 管理员账号，仅当 auto_install 为 true 时会用到 |
|
| admin_email | 管理员邮箱，仅当 auto_install 为 true 时会用到 |
|
| admin_password | 管理员密码，仅当 auto_install 为 true 时会用到 |
|
| no_proxy | false |
忽略环境变量中的代理配置 |
示例
go run main.go --username=<dbUsername> --pwd=<DBPassword>
# or
./tbsign_go --username=<dbUsername> --pwd=<DBPassword>
# or https://github.com/cosmtrek/air
air -- --db_path=tbsign.db --test=true --api=true
env
不支持 .env 文件，请直接设置环境变量，使用顺序是 flags > env > default
| flag | description |
|---|---|
| tc_username | 数据库账号 |
| tc_pwd | 数据库密码 |
| tc_endpoint | 数据库端点 |
| tc_db | 数据库名称 |
| tc_db_path | SQLite 文件目录 |
| tc_test | 测试模式，此模式下不会运行计划任务 |
| tc_api | 是否启动后端 api |
| tc_fe | 是否启动自带前端，仅当 tc_api 为 true 时可为 true |
| tc_address | 后端运行地址 |
| tc_auto_install | 自动安装（仅当数据库不存在时安装） |
| tc_admin_name | 管理员账号，仅当 tc_auto_install 为 true 时会用到 |
| tc_admin_email | 管理员邮箱，仅当 tc_auto_install 为 true 时会用到 |
| tc_admin_password | 管理员密码，仅当 tc_auto_install 为 true 时会用到 |
数据库
只要 db_path/tc_db_path 的值不为空字符串，就会使用 SQLite；否则使用 MySQL
- MySQL 要求版本在 MySQL 8.0 以上
安装
- 迁移法 (仅 MySQL)
- 直接安装 百度贴吧云签到
- 使用原数据库配置启动
- 全新安装 (MySQL, SQLite)
- 手动安装
-
启动程序，添加
flagsetup=true(示例:./tbsign_go --db_path=tbsign.db --api=true --address=:8080 --setup=true) -
根据文字提示完成自动安装流程（不同情况下文字提示可能会略有不同）
➜ tbsign_go git:(master) ✗ ./tbsign_go --db_path=tbsign1.db --api=true --setup=true 2024/06/29 18:18:47 tbsign: sqlite connected! 📌现在正在安装 TbSign➡️，如果数据库内含有数据，这样做会导致数据丢失，请提前做好备份。 如果已经完成备份，请输入以下随机数字并按下回车（显示为 "--> 1234 <--" 代表需要输入 "1234"） --> 428650691 <-- 请输入: 428650691 ⌛正在清理旧表 ⌛正在建立数据表和索引 ⌛正在导入数据... ⌛导入第1项... ⌛导入第2项... 🔒注册管理员账号... 管理员用户名: a 管理员邮箱: a@a.a 管理员密码 (注意空格): a ⌛正在注册管理员账号... 🎉安装成功！ -
*(选做) 登录管理员账号，打开 系统管理 即可手动开启自带插件
-
- 自动安装
-
启动程序，添加
flags或 环境变量 (示例:./tbsign_go --db=tbsign --username tcdb --pwd tcdb_password --api=true --address=:8080 --auto_install=true --admin_name=a --admin_email=a@a.a --admin_password=a)- 担心 log 泄露信息的此时可以设随机值，等到安装完成后再登录修改
- 除非数据库被删除，否则 用户名/邮箱/密码 仅在首次开启时会用到
-
*(选做) 登录后台修改信息，开启自带插件
-
- 手动安装
* 注：setup 和 auto_install 不可同时为 true
兼容性
- [⚠️] 通过 迁移法 启动的程序能够与 百度贴吧云签到 共存，但部分插件没有对应的 PHP 版本
- [❌] 通过 全新安装 启动的程序无法兼容 百度贴吧云签到，因为缺少部分数据表和设置选项
- [❌] 不支持 MySQL 5.x，使用了不支持的语法
- [⚠️] xgo 镜像使用的 tag 为
latest，可能会有操作系统不再受到支持（如 Windows 7）
前端
➡️ https://github.com/BANKA2017/tbsign_go_fe
嵌入式前端
此类部署需要用到其他仓库，并且需要手动或自动添加文件，如果不知道是怎么回事，请忽略本节，使用前后分离部署
-
使用嵌入式前端前，请设置环境变量
NUXT_BASE_PATH="/api" -
在前端仓库的目录执行
yarn run generate后将/dist目录整个拷贝到/assets内（即/assets/dist） -
照常
go build
嵌入式前端启用后，API 路径自动添加前缀 /api，同时 response header 不再含有 Access-Control-Allow-Origin
API (WIP)
仅供参考，未来可能还会修改，等到稳定后随缘出文档
插件
外链为对应 PHP 版插件
插件开发
⚠ 插件还无法做到开箱即用，使用前需要通过源码编译
目前插件开发至少需要分别准备一个前端(.vue)和后端的文件(.go)，配置方面可能会比较麻烦
-
插件目录
/plugins放下核心文件，这些前缀只是为了便于管理，golang 中同一层的非隐藏文件命名对编译无影响- 标准插件
- 文件命名应当使用前缀
s_(standard)，插件本身的命名建议使用<namespace>_<plugin_name>来避免冲突，但namespace为非强制项，实际命名请尽量贴近插件功能- 命名建议使用 英语单词/常用缩写，或者与 完整拼音 的组合。请不要用拼音首字母缩写
- 导出 API 接口的方式请参考现有的插件
- 导出路由的路径为
[/api]/plugins/<PluginInfo.Name>/<PluginInfo.Endpoints.Path>，有没有/api前缀取决于是否启用自带前端
- 导出路由的路径为
- 其他步骤请参考几个自带的标准插件，必要的函数和变量配置请参考 标准插件模板
- 文件命名应当使用前缀
- 升级插件
- 文件命名应当使用前缀
u_(upgrade)，用于不兼容更新，但目前还不存在需要用到的场景，所以暂时无需理会（甚至根本没有写调用逻辑）
- 文件命名应当使用前缀
- 核心插件
- 文件命名应当使用前缀
c_(core)
- 文件命名应当使用前缀
- 标准插件
-
前端
- 对应插件的页面
- 在目录
pages/添加对应插件的页面 vue 文件，文件名必须带有前缀plugin_
- 在目录
- *如果对变量设置表单有特殊要求，还需要修改
system_admin.vue的内容- 含有特殊后缀
_action_limit的变量将会在前端自动识别成不小于0的number类型 - 其他变量识别成
text
- 含有特殊后缀
- 对应插件的页面
-
*数据库 model
-
简单的信息可以直接存在表
tc_options（全局） 或tc_users_options（用户） 中 -
如果需要使用数据库存储插件信息
- 请准备好表模型并存放在
model/，包名为model - 或者生成好表模型后将相关内容拷贝到插件的 go 文件内，包名为
_plugin
参考 codegen 命令为
/root/go/bin/gentool -dsn "..." -modelPkgName "model" -onlyModel尽管 Gorm 可以手搓 raw SQL，但我们并不建议这样做
- 请准备好表模型并存放在
-
-
*protobuf
- 部分请求可能需要用到 protobuf，这部分还没完善，敬请期待
标准插件不再与核心强绑定，使用 SemVer，但新插件使用的一些新版核心函数可能会导致无法在旧版核心中使用
*关于插件开发配置上越来越复杂的吐槽：为了逃离配置地狱而亲手创造了一个配置地狱，也是很讽刺了
编译
CGO
需要设置 CGO_ENABLED=1， go-sqlite3 需要用到 CGO
go-sqlite3 is cgo package. If you want to build your app using go-sqlite3, you need gcc. However, after you have built and installed go-sqlite3 with
go install github.com/mattn/go-sqlite3(which requires gcc), you can build your app without relying on gcc in future.
build.sh
简单写了个编译脚本，存放在 build.sh
版本号
格式为 tbsign_go.<YYYYMMDD>.<BACKEND_COMMIT_HASH[0:7]>.<FRONTEND_COMMIT_HASH[0:7]>.<OS>-<ARCH> ，如果是用于 Windows 系统的二进制还会有 .exe 拓展名
官方提供的二进制包含 linux/amd64, linux/arm64, windows/amd64, darwin/amd64, darwin/arm64 五个版本，使用 xgo 进行交叉编译，手动触发编译的 Actions 任务
其它系统请自行编译运行
已知问题
- 不支持限制单次签到贴吧总数，会一次性全部签完
- 没有灵活的请求间隔和请求头模拟，有封号的风险
- 只有签到这一个功能，对重签的处理约等于没有
- 混乱的输出，随处可见的打点
- 没有进行任何优化
- 一次性执行，仍然需要 cron
- 会运行未安装/未激活的插件
- 邀请码系统在考虑要不要做，如果不想做就会移入不会解决列表
- 邮箱相关……邮箱找回✅
-
签发用户 JWT 的密钥仅存在于内存中，系统重启后会掉登录特性！都是特性！
下面提到的不会解决
- 兼容性
- 不会对所谓的 vip 账号有任何特殊照顾，原 vip 账号的特权也会下放给所有账号
- 无法支持一个贴吧账号绑定到多个云签账号
- 不同语言各有特性，不会强求 1:1 兼容
- 不支持自定义的数据表前缀，统一使用默认前缀
tc_ - 不支持分表
- 登录/注册不会有验证码
- 接口
- 循环封禁无法确认封禁是否成功，因为返回的结果是一样的
- 执行成长任务时无法确认是否重复执行，原因同上
TODO
* 带 ? 开头的表示有考虑，但可能永远不做
- 解决已知问题
- 兼容部分原版插件
- 优化 PHP 原版的相关功能
- 不再考虑
通过读取config.php取得数据库连接信息 - 自动清理解除绑定的账号的插件设置
- ?打包/Docker/或者别的
- ?自动化部署
- ?支持更多 Gorm 也支持的数据库
- ?邮箱以外的推送方式
- 完善权限控制
- 个人数据导出 (接口
/passport/export已写好，但没想好如何处理好安全问题，当前所有接口都会自动删除bduss和stoken的值，但导出会不可避免地需要处理这个问题) - ……更多的想起来再加
更多
更多的 todo 和已知 bug 请查看实时更新的 Projects/TbSign➡️
感谢
Documentation
¶
There is no documentation for this package.
Source Files
Directories