sign

README

项目介绍

自动签到程序, 纯属娱乐.

功能

定时执行一些任务, 支持的任务定义在 task.proto

部署

依赖环境

• MySQL
  • 存储任务
  • 所需表在 sign.sql
• RabbitMQ
  • 任务分发
• Etcd (k8s 的)
  • 注册中心

配置文件

模板在 conf.yaml.default

编译

$ make go.build

可执行文件默认输出到 build/output/.

启动

$ ./xxx.out --config conf.yaml

Kubernetes 部署

k8s 部署配置模板在 deployments 中.

1. 创建 Secret

• 这里把配置及连接 etcd 所需的证书都放到 config 目录中, 并创建 Secret

$ kubectl create secret generic sign-config --from-file=config/

1. 创建 Deployment

$ kubectl create -f deployment.yaml

创建任务

使用 signctl

1. 构建 signctl

signctl 生成在 build/output.

$ make go.build.signctl

1. 创建用户

创建用户后会返回 token, 之后任何操作使用 -T token 方式.

$ ./signctl.out create user -H server_address --nickname xxx

1. 创建 task

$ ./signctl.out create task -H server_address -T token \
    --kind 6 -p 'owner=jfcere' -p 'repo=ngx-markdown' --spec '*/5 * * * *'

查看支持的任务及其参数:

$ ./signctl.out create task -h
Available kind and params:
  Kind Name         	Kind ID
    Task Param
  ---------         	-------
  BILIBILI_B_COUNT  	      2
    cookie(string)
  BILIBILI_SIGN_IN  	      1
    cookie(string)
  CUSTOM_MESSAGE    	     11
    content(string)
  EVOLUTION_RELEASE 	      5
    device(string)
  GITHUB_RELEASE    	      6
    owner(string) repo(string)
  JUEJIN_CALENDAR   	     10
    cookie(string)
  JUEJIN_COUNT      	      8
    cookie(string)
  JUEJIN_POINT      	      9
    cookie(string)
  JUEJIN_SIGN_IN    	      7
    cookie(string)
  STG_SIGN_IN       	      3
    username(string) passwd(string)
  V2EX_SIGN_IN      	      4
    cookie(string)

Usage:
  signctl create task [flags]

Flags:
      --description string   description of the task
  -h, --help                 help for task
      --kind int32           kind of the task
  -p, --param strings        the param required by the task can be specified multiple times (key=value)
      --spec string          crontab expression

Global Flags:
  -H, --host string    apiserver address (default "http://127.0.0.1:8080")
  -T, --token string   user token

测试服

https://task.baldcamera.com

注意:

• 目前部署版本为 v0.10.0, 请使用相同 tag 的 signctl 测试
• 创建用户时指定 --telegram 标记用于接收通知
• 测试服中的数据会随时清除

各组件介绍

app

类似网关, signctl 与其交互来对各资源进行操作.

task

管理任务对象, 创建任务, 同时负责执行任务, 应该多实例部署.

notice

类似消息推送, 目前使用 telegram bot 做消息接收.

trigger

触发器, 时间到时将任务发到 RabbitMQ, 再由 executor 执行.

user

用户管理.

signctl

一个简单的命令行工具, 用于创建任务.

程序架构

非常简单.