commit c038f288513f0a9f93c17e1bd72aa7d9fbdc3b84
Author: WeiMing <weiming@threatbook.cn>
Date:   Fri Jun 11 10:40:14 2021 +0800

    change doc

diff --git a/.gitinore b/.gitinore
new file mode 100644
index 0000000..f79b951
--- /dev/null
+++ b/.gitinore
@@ -0,0 +1,3 @@
+.DS_Store
+docs/.DS_Store
+.gitinore
diff --git a/docs b/docs
new file mode 160000
index 0000000..71a813c
--- /dev/null
+++ b/docs
@@ -0,0 +1 @@
+Subproject commit 71a813cc5f7aebf821296e01e07b5f684de6c27c
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..77ebb37
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,139 @@
+\#HFish
+
+HFish是一款安全、简单可信赖的跨平台蜜罐软件，允许商业和个人用户免费使用。
+
+
+
+\## 特点
+
+\+ 安全可靠：主打低中交互蜜罐，简单有效；
+
+\+ 蜜罐丰富：支持SSH、FTP、TFTP、MySQL、Redis、MySQL、Telnet、VNC、Gitlab、Exchange、Memcache、Elasticsearch、打印机、视像头、交换机、Wordpress、OA系统等20多种蜜罐服务，支持用户制作自定义Web蜜罐；
+
+\+ 开放透明：支持对接微步在线X社区API、五路syslog输出、支持邮件、钉钉、企业威胁、飞书、自定义WebHook告警输出；
+
+\+ 快捷管理：支持单个安装包批量部署，支持批量修改端口和服务；
+
+\+ 跨平台：支持Linux x32/x64/ARM、Windows x32/x64平台；
+
+
+
+\## 链接
+
+[官方网站](https://hfish.io/)：更多使用蜜罐、使用场景和玩法详见官网
+
+[详细文档](https://hfish.io/docs/#/)：更详细的功能说明、故障排错指南
+
+
+
+\## 架构
+
+HFish由控制端和节点端组成，控制端用来生成和管理节点端，并接收、分析和展示节点端回传的数据，节点端接受控制端的控制并负责构建蜜罐服务。
+
+
+
+\## 注意
+
+\+ Linux 安装无需root权限，但是会导致无法监听低于TCP/1024以下端口
+
+\+ 控制端使用 TCP/4433 和 TCP/4434 端口，节点端监听端口根据模拟的服务不同而不同
+
+\+ 节点端需要可访问控制端的 TCP/4434 端口，控制端不会主动访问节点端
+
+\+ 控制端默认用户名/密码：**`admin / HFish2021`**
+
+
+
+\## 部署控制端
+
+先部署控制端，再通过控制端的Web页面配置节点端，安装包仅包含控制端和节点端，蜜罐服务包需要部署控制端后从 **`服务管理**` 页面联网下载或离线上传
+
+
+
+可联网环境：如果用户的环境允许联网，建议使用以下快速部署步骤：
+
+\+ Linux x64 环境：
+
+- \* 在shell中运行命令：**`sh | curl https://hfish.io/install.sh`**
+- 请转到下面的配置段落继续阅读
+
+
+
+\+ Windows x64 环境：
+
+- 下载控制端安装包：从Github https://github.com/hacklcx/HFish/releases 或码云 https://gitee.com/lauix/HFish 下载最新安装包
+- 解压缩后双击 **`server.exe`**
+- 请转到下面的【配置控制端】段落继续阅读
+
+
+
+离线部署：如果用户为隔离网络环境，请使用以下部署方式
+
+\+ Linux x64 环境：
+
+- 下载控制端安装包：从Github https://github.com/hacklcx/HFish/releases 或码云 https://gitee.com/lauix/HFish 下载最新安装包
+- 解压缩安装包：**`tar zxvf ./hfish-*-linux-*.tar.gz -C hfish`**
+- 进入安装目录：**`cd hfish`**
+- 启动控制端：**`nohup ./server &`**
+- 请转到下面的【配置控制端】段落继续阅读
+
+
+
+\## 配置控制端
+
+新部署的控制端需要没有任何蜜罐服务，必须新增服务和节点，控制端和节点端可以部署在同一台机器上。
+
+
+
+\+ 新增服务
+
+- 浏览器中输入 **`https://`**，登录控制端
+- 进入 **`服务管理**` 页面
+- 如果当前控制端可联网，点击服务表格右侧的下载按钮，并等待服务下载完成
+- 如果当前控制端不可联网，点击右上角 **`新增服务`** 按钮，上传服务包，服务包下载地址： **`https://hfish.io/services.html`**
+
+
+
+\+ 新增节点
+
+- 浏览器中输入 **`https://`**，登录控制端
+- 进入 **`节点管理`** 页面，点击右上角新增节点按钮，根据节点操作系统和CPU架构动态创建安装包
+- Linux可以选择命令安装或下载节点程序运行，Windows只能选择下载节点程序运行
+
+
+
+\## 效果图
+
+\+ 攻击详情：记录所有对蜜罐的访问请求，包括正常请求、攻击行为、暴力破解
+
+
+
+
+
+\+ 扫描详情：记录对所有节点主机的UDP和SYN扫描
+
+
+
+\+ 蜜饵管理
+
+
+
+\+ 节点信息
+
+
+
+\+ 模板管理
+
+
+
+
+
+\+ 威胁情报对接
+
+
+
+\+ 告警配置
+
+
+
+\## 微信群
\ No newline at end of file