diff --git a/README.md b/README.md index 17b887f..7bb46f6 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,15 @@ 这是一个可以用来打卡的服务器. -客户端需要在设定的间隔时间内, 不断的通过客户端向服务器发送一个请求打卡. +客户端需要在设定的时间间隔内, 重复的的通过客户端向服务器发送一个请求打卡. -服务端则根据打卡记录, 分析用户的行为, 显示, 什么时候在线(online), 什么时候离线(offline) +服务端则根据打卡记录, 分析用户的行为, 显示, 客户什么时候在线(online), 什么时候离线(offline) ## 安装 -下载最新的版本的 binary, 拷贝到服务器上直接执行即可, 默认监听在 0.0.0.0:3000. +下载最新的版本的 [release bianry](https://github.com/crystal-china/daka/releases), 拷贝到一台 Linux 服务器上直接执行即可, 默认监听在 0.0.0.0:3000. -也可以手动指定: +也可以手动指定监听地址和端口: ```sh bin/daka -b 127.0.0.1 -p 3001 @@ -19,8 +19,8 @@ bin/daka -b 127.0.0.1 -p 3001 可以通过 http://you_server/admin 来访问打卡记录页面, 默认登录密码 1234567, 你可以通过环境变量 `DAKAPWD` 设定新的密码 -默认要求打卡时间为 `1 分钟 + 30~60秒`, 通过 `DAKAINERVAL` 设定要求的打卡间隔. -例如: 设定 DAKAINERVAL 为 5 则表示, 打卡最低间隔为 `5 分钟 + 30~60秒` +默认要求打卡时间为 `1 分钟 + 30 ~ 60秒`, 通过 `DAKAINERVAL` 设定要求的打卡间隔. +例如: 设定 DAKAINERVAL 为 5 则表示, 打卡最低间隔为 `5 分钟 + 30 ~ 60秒` ## 用法 @@ -32,11 +32,11 @@ xhs -a user:1234567 https://your_server/daka hostname=${HOSTNAME} --ignore-stdin ### 查询打卡记录 -访问如下地址, 使用 basic_auth, 用户名 user, 输入你的用户密码即可. +访问如下地址, 使用 basic_auth, 用户名为 user, 密码为你设得密码, 默认 1234567 http://you_server/admin -你可以直接在终端访问, 将会以表格的形式输出到终端. +你也可以直接通过命令行访问, 将会以表格的形式输出到终端. ```sh $: xhs -b -a user:1234567 https://your_server/admin