# tz

**Repository Path**: zeusTeam/tz

## Basic Information

- **Project Name**: tz
- **Description**: sndp-tz
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: v2
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2017-03-29
- **Last Updated**: 2021-06-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# TZ v2.0

本程序适用于提供简单静态页面、文件下载的站点。

> node 要求： 6.x+
>
> 数据库使用 sqlite3，记录用户的访问、下载记录

## 如何部署

`git` clone 或者直接下载源码压缩包到本地，这里假设最终的文件夹为 `tz`，执行以下操作完成部署：
``` shell
# 进入tz目录
cd tz

# 安装 nodejs 依赖（如何没有 node 环境，请先安装）
npm i

# 等待 npm 执行完成后，即可启动 index.js 程序
node index.js
```

注意：程序默认使用的是`80`端口，如需要修改请编辑`config/config.json`中的`port`

### 更改网站内容

网站资源统一放置在`static`目录下，直接将新内容覆盖进去即可。

### 后台运行

使用`node index.js`运行时，并不是后台常驻进程，如果需要后台运行，可以使用`nohup`或者`forever`，这里介绍 [forever](https://github.com/foreverjs/forever) 方式。

安装好 `forever` 后，执行`forever start index.js` 即可。

## 功能列表

### 数据表说明

默认数据库文件名为`zeus.db`，默认的表名为`log`，其字段如下


字段名 | 类型 | 说明
---------|----------|---------
 id | Int | 自增主键
 uuid | String | 用户标识码，从请求中的 `u` 参数得到
 ip | String | 请求来源 `IP`
 type | String | 操作类型，`visit` 或者 `download`
 agent | String | user-agent 值
 date | String | `ISO` 格式的时间
 data | String | 请求参数

### index.html

主页，新请求时先记录用户的访问信息，然后返回`index.html`的内容。

> 如果需要记录 `uuid`，则这样填写 `index.html?u={UUID}`

### download

下载文件；最终下载的文件在`config/config.json`中指定。

如果需要定制下载文件的保存名，则传递`filename`参数

> 如果需要记录 `uuid`，则这样填写 `download?u={UUID}`

### 记录查询

访问 `_` 来获取历史记录，默认返回的是 `type=visit` 的结果（最新的前 `100` 条），如果需要查看 `download` 的，则使用 `_?type=download`.

**如何分页？**

传递参数 `page`、`pageSize` 即可完成分页，如 `_?type=download&page=2&pageSize=20`，查看第20到40条下载记录。

## LOGS

### 2017年5月22日

1. 新增 `README.md` 文档
2. 新增查看结果的分页功能
3. 新增查看结果的分组功能

### 2017年5月25日

1. 新增图片访问记录功能：访问 `imgs` 下的 `jpg` 图片时，记录访客数据，类型为 `IMAGE`
2. 注意：现在只支持 `jpg` 格式的图片，图片访问时，也支持 `u` 参数
3. 查看图片访问记录： http://{域名}/_?type=image 
4. 新增删除记录的功能： `_?type=image&action=clean` 则表示删除 type=image 的数据
5. 记录 agent 时增加条件判断，详见： `config.ignoreAgents`