From 1c7c8548f52154a12dcd0b17ec6345013b77da5d Mon Sep 17 00:00:00 2001 From: sule01u Date: Mon, 13 Nov 2023 14:08:23 +0800 Subject: [PATCH] update readme --- README.md | 25 ++++++++++++++++++++----- README_en.md | 24 +++++++++++++++++++----- 2 files changed, 39 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 6fa8ab0..e080f4d 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,11 @@ - **无回显漏洞解决:** 无回显漏洞检测光看响应状态码不太靠谱?支持--dnslog参数指定dnslog域名,看到dnslog记录才是真的成功验证漏洞存在 - **其他一些常规支持**:单个url扫描/ url文件扫描 / 支持指定代理 / 支持多线程 / 扫描报告生成 -## 🏂 Run +## 🏂 安装使用 + +**MacOS && linux** + ```Bash -# 安装使用, 更新版本之后建议重装依赖,新版本可能会增加三方库的依赖; $ git clone https://github.com/sule01u/SBSCAN.git $ cd SBSCAN $ python3 -m venv sbscan # 创建虚拟环境 @@ -23,6 +25,17 @@ $ source sbscan/bin/activate # 激活虚拟环境 $ pip3 install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple # -i 指定使用国内清华源安装依赖; $ python3 sbscan.py --help ``` +**Windows** + +```bash +$ git clone https://github.com/sule01u/SBSCAN.git +$ cd SBSCAN +$ python3 -m venv sbscan # 创建虚拟环境 +$ .\venv\Scripts\activate # 激活虚拟环境 +$ pip3 install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple # -i 指定使用国内清华源安装依赖; +$ python3 sbscan.py --help +``` + > 检测效果图, 使用彩色表格打印更直观显示检测结果,**检测报告**保存位置将会在扫描结束后控制台显示 ![](https://p.ipic.vip/1j9o3a.png) @@ -36,14 +49,16 @@ $ python3 sbscan.py --help > 自行构建 docker 进行 ```Bash -docker build -t sbscan . -alias sbscan='docker run --rm -it -v "$(pwd)":/SBSCAN sbscan' +$ git clone https://github.com/sule01u/SBSCAN.git +$ cd SBSCAN +$ docker build -t sbscan . +$ alias sbscan='docker run --rm -it -v "$(pwd)":/SBSCAN sbscan' ``` > 使用现有镜像 ```Bash -alias sbscan='docker run --rm -it -v "$(pwd)":/SBSCAN milusuleo/sbscan' +$ alias sbscan='docker run --rm -it -v "$(pwd)":/SBSCAN milusuleo/sbscan' ``` > 使用 diff --git a/README_en.md b/README_en.md index 4c4900e..db43899 100644 --- a/README_en.md +++ b/README_en.md @@ -18,13 +18,25 @@ ## 🏂 Run +**MacOS && Linux** + ```shell -# Install and use, it is recommended to reinstall the dependency after the updated version, the new version may increase the dependency of the three-party library; $ git clone https://github.com/sule01u/SBSCAN.git $ cd SBSCAN $ python3 -m venv sbscan $ source sbscan/bin/activate -$ pip3 install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple # To avoid conflicts with other package versions, it's suggested to create a virtual environment before installing dependencies. Use '-i' to specify the Tsinghua University mirror for installations. +$ pip3 install -r requirements.txt +$ python3 sbscan.py --help +``` + +**windows** + +```bash +$ git clone https://github.com/sule01u/SBSCAN.git +$ cd SBSCAN +$ python3 -m venv sbscan +$ .\venv\Scripts\activate +$ pip3 install -r requirements.txt $ python3 sbscan.py --help ``` @@ -41,14 +53,16 @@ $ python3 sbscan.py --help > Build your own Docker image ```Bash -docker build -t sbscan . -alias sbscan='docker run --rm -it -v "$(pwd)":/SBSCAN sbscan' +$ git clone https://github.com/sule01u/SBSCAN.git +$ cd SBSCAN +$ docker build -t sbscan . +$ alias sbscan='docker run --rm -it -v "$(pwd)":/SBSCAN sbscan' ``` > Pull an existing image in the docker hub ```bash -alias sbscan='docker run --rm -it -v "$(pwd)":/SBSCAN milusuleo/sbscan' +$ alias sbscan='docker run --rm -it -v "$(pwd)":/SBSCAN milusuleo/sbscan' ``` > How to use