From 5a4fab398b6ac5b3dd123692e811d6918703fb40 Mon Sep 17 00:00:00 2001 From: boy-hack <34109680@qq.com> Date: Thu, 21 Mar 2019 13:43:02 +0800 Subject: [PATCH] =?UTF-8?q?:bookmark:=200.1=20=E6=9B=B4=E6=96=B0=E7=9B=B8?= =?UTF-8?q?=E5=85=B3=E9=97=AE=E9=A2=98&THANKS.md&CHANGELOG.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README-ZH.md | 14 +++++++++----- README.md | 10 ++++------ doc/CHANGELOG.md | 4 ++++ doc/THANKS.md | 1 + 4 files changed, 18 insertions(+), 11 deletions(-) create mode 100644 doc/CHANGELOG.md create mode 100644 doc/THANKS.md diff --git a/README-ZH.md b/README-ZH.md index 9d0706d..35eba07 100644 --- a/README-ZH.md +++ b/README-ZH.md @@ -46,7 +46,7 @@ w12scan分为WEB端(用于展示显示数据)和Client端(用于搜索相 * 扫描与识别 * 端口扫描使用masscan,端口识别使用nmap,web应用识别调用wappalyzer和精简版的w11scan(指纹识别) * 容易的分布式 - * 在程序架构设计就考虑到了这一点,扫描端只接受任务,最后的结果只和WEB端进行交互,所以在分布式上十分容易,直接在另一台机器上运行扫描端即可。能基于docker进行分布式,也能很方便集成celery服务。[部署方案](./doc/deployment.md) + * 在程序架构设计就考虑到了这一点,扫描端只接受任务,最后的结果只和WEB端进行交互,所以在分布式上十分容易,直接在另一台机器上运行扫描端即可。能基于docker进行分布式,也能很方便集成celery服务。 ## 安装 基于docker一键部署 @@ -55,10 +55,14 @@ git clone https://github.com/boy-hack/w12scan cd w12scan docker-compose up -d ``` -在Windows上安装,需要注意一点 https://github.com/boy-hack/w12scan/issues/12 (感谢 @Hotsunrize). 等待一段时间后访问`http://127.0.0.1:8000` -### 部署相关问题 + +### 相关问题 1. 因为依赖elasticsearch服务,内存一定要大于4G,8G最好,否则elasticsearch启动不了。 -## 法律 -本程序主要用于收集网络数据用于分析研究。在使用该程序之前请遵守当地相关法律进行。 +2. 在Windows上安装,需要注意`.sh`文件格式问题 https://github.com/boy-hack/w12scan/issues/12 (感谢 @Hotsunrize). +3. Q:如何分布式部署?A:[部署方案](./doc/DEPLOYMENT.md) +4. Q:启动后搜索数为0?A:需要添加扫描目标 +5. 不要边扫描边搜索,elastisearch在插入数据时会作分析,分词等等操作(此时效率不高),如果在此时搜索可能会返回503,建议扫描完毕后在进行搜索。(后期会使用数据迁移解决) +## 法律 +本程序主要用于收集网络数据用于分析研究。在使用该程序之前请遵守当地相关法律进行。 \ No newline at end of file diff --git a/README.md b/README.md index 6ea9b1e..4735276 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ Based on python3 + django + elasticsearch + redis and use the web restful api to * Scanning * Use masscan,nmap,wappalyzer,w11scan * Easy to distribute - * This is taken into account in the design of the program architecture. It is very easy to distribute and run the scan terminal directly on another machine. It also can be distributed based on docker, celery service.[Deployment](./doc/deployment.md) + * This is taken into account in the design of the program architecture. It is very easy to distribute and run the scan terminal directly on another machine. It also can be distributed based on docker, celery service. ## Installation Quickly build an environment with docker @@ -53,12 +53,10 @@ git clone https://github.com/boy-hack/w12scan cd w12scan docker-compose up -d ``` -For Windows, you need to pay attention to https://github.com/boy-hack/w12scan/issues/12 (thanks @Hotsunrize). Wait a while to visit `http://127.0.0.1:8000` ### Some Issue 1. Because relying on the elasticsearch service, please ensure that the memory is larger than 8G. +2. For Windows, you need to pay attention to https://github.com/boy-hack/w12scan/issues/12 (thanks @Hotsunrize). +3. Q:How to install distributed A:[Deployment](./doc/DEPLOYMENT.md) ## Legal -This program is mainly used to collect network data for analysis and research. Please follow the relevant local laws before using this program. - - - +This program is mainly used to collect network data for analysis and research. Please follow the relevant local laws before using this program. \ No newline at end of file diff --git a/doc/CHANGELOG.md b/doc/CHANGELOG.md new file mode 100644 index 0000000..02a6a8a --- /dev/null +++ b/doc/CHANGELOG.md @@ -0,0 +1,4 @@ +# Version 0.1 (2019-3-21) +- 完成资产发现以及搜索大部分功能 +- 添加`相关问题解决方案`、`分布式安装方案` +- 添加THANKS、CHANGELOG \ No newline at end of file diff --git a/doc/THANKS.md b/doc/THANKS.md new file mode 100644 index 0000000..3000180 --- /dev/null +++ b/doc/THANKS.md @@ -0,0 +1 @@ +* 模仿自@0xbug https://github.com/0xbug/Biu \ No newline at end of file