添加详细的安装依赖文档

2026-08-26 04:47:48 +08:00 · 2019-08-14 02:02:31 +08:00
parent 96487aec2e
commit 88e084e695
2 changed files with 95 additions and 23 deletions
@@ -53,7 +53,16 @@

 **🐍安装要求**

-1. Python 3.6-3.7
+1. OneForAll是基于CPython开发的，所以你需要Python环境才能运行，如果你的系统还没有Pythin环境你可以参考[Python 3 安装指南](https://pythonguidecn.readthedocs.io/zh/latest/starting/installation.html#python-3)，理论上Python 3.6，3.7和3.8都可以正常运行OneForAll，**但是**许多测试都是在Python 3.7上进行的，所以**推荐**你使用**Python 3.7**版本运行OneForAll。运行以下命令检查Python和pip3版本：
+```bash
+python -V
+pip3 -V
+```
+如果你看到以下类似输出便说明Python环境没有问题：
+```bash
+Python 3.7.4
+pip 19.2.2 from C:\Users\shmilylty\AppData\Roaming\Python\Python37\site-packages\pip (python 3.7)
+```

 **✔安装步骤**

@@ -72,37 +81,36 @@
   ```

 2. 安装依赖
-
-   * 使用pipenv
-
-     ```bash
-     pip3 install pipenv
-     cd OneForAll/
-     pipenv install --python 3.7
-     cd oneforall
-     pipenv run python3 oneforall.py --help
-     ```
-
-   * 使用pip3
+   首先运行以下命令
+   你可以通过pip3安装OneForAll的依赖（如果你熟悉[pipenv](https://docs.pipenv.org/en/latest/)，那么推荐你使用[pipenv安装依赖]((./docs/Installation_dependency.md))），以下为**Windows系统**下使用**pip3**安装依赖的示例：（注意：如果你的Python3安装在系统Program Files目录下，如：`C:\Program Files\Python37`，那么请以管理员身份运行命令提示符cmd执行以下命令！）

   ```bash
   cd OneForAll/
+   python -m pip install -U pip setuptools wheel -i https://mirrors.aliyun.com/pypi/simple/
   pip3 install -r requirements.txt -i https://mirrors.aliyun.com/pypi/simple/
   cd oneforall/
-     python3 oneforall.py --help
+   python oneforall.py --help
   ```


-如果在安装依赖过程中发现编译某个依赖库失败时可以参考[编译失败解决方法](./docs/building_fail_solution.md)，如果还没有解决欢迎加群反馈。
+其他系统平台的请参考[依赖安装](./docs/Installation_dependency.md)，如果在安装依赖过程中发现编译某个依赖库失败时可以参考[编译失败解决方法](./docs/building_fail_solution.md)，如果还没有解决欢迎加群反馈。

 **✨使用演示**
+如果你是通过pip3安装的依赖则使用以下命令运行示例：

 ```bash
+cd oneforall/
 python3 oneforall.py --target example.com run
 ```

 ![Example](./docs/usage_example.svg)

+如果你通过pipenv安装的依赖则使用以下命令运行示例：
+```bash
+cd oneforall/
+pipenv run python oneforall.py --target example.com run
+```
+
 **🤔使用帮助**

 命令行参数只提供了一些常用参数，更多详细的参数配置请见[config.py](./oneforall/config.py)，如果你认为有些参数是命令界面经常使用到的或缺少了什么参数等问题非常欢迎反馈。由于众所周知的原因，如果要使用一些被墙的收集接口请先到[config.py](./oneforall/config.py)配置代理，有些收集模块需要提供API（大多都是可以注册账号免费获取），如果需要使用请到[config.py](./oneforall/config.py)配置API信息，如果不使用请忽略有关报错提示。（详细模块请阅读[收集模块说明](./docs/collection_modules.md)）
@@ -114,7 +122,7 @@ oneforall.py是主程序入口，oneforall.py里有调用aiobrute.py和dbexport.
 1. oneforall.py使用帮助

   ```bash
-   pipenv run python oneforall.py --help
+   python oneforall.py --help
   ```
   ```bash
   NAME
@@ -166,7 +174,7 @@ oneforall.py是主程序入口，oneforall.py里有调用aiobrute.py和dbexport.
   经过测试在16核心的CPU，使用16进程64协程，100M带宽的环境下，设置任务分割为50000，跑两百万字典大概10分钟左右跑完，大概3333个子域每秒。

   ```bash
-   pipenv run python aiobrute.py --help
+   python aiobrute.py --help
   ```

   ```bash
@@ -218,7 +226,7 @@ oneforall.py是主程序入口，oneforall.py里有调用aiobrute.py和dbexport.
 3. dbexport.py使用帮助

   ```bash
-   pipenv run python dbexport.py --help
+   python dbexport.py --help
   ```

   ```bash
@@ -0,0 +1,64 @@
+# 安装依赖
+
+你可以通过pip3和pipenv两种方法安装OneForAll的依赖（如果你熟悉[pipenv](https://docs.pipenv.org/en/latest/)，那么推荐使用你使用pipenv）：
+
+* **Windows系统**（注意：如果你的Python3安装在系统Program Files目录下，如：`C:\Program Files\Python37`，那么请以管理员身份运行命令提示符cmd执行以下命令！）
+
+    1. 使用pipenv
+
+    ```bash
+    cd OneForAll/
+    python -m pip install -U pip setuptools wheel -i https://mirrors.aliyun.com/pypi/simple/
+    pip3 install pipenv -i https://mirrors.aliyun.com/pypi/simple/
+    pipenv install --python 3.7
+    cd oneforall
+    pipenv run python oneforall.py --help
+    ```
+
+    2. 使用pip3
+
+    ```bash
+    cd OneForAll/
+    python -m pip install -U pip setuptools wheel -i https://mirrors.aliyun.com/pypi/simple/
+    pip3 install -r requirements.txt -i https://mirrors.aliyun.com/pypi/simple/
+    cd oneforall/
+    python oneforall.py --help
+    ```
+* **Linux系统**
+
+    1. 使用pipenv
+    ```bash
+    cd OneForAll/
+    sudo python3 -m pip install -U pip setuptools wheel -i https://mirrors.aliyun.com/pypi/simple/
+    sudo pip3 install pipenv -i https://mirrors.aliyun.com/pypi/simple/
+    sudo pipenv install --python 3.7
+    cd oneforall
+    pipenv run python3 oneforall.py --help
+    ```
+    2. 使用pip3
+    ```bash
+    cd OneForAll/
+    sudo python3 -m pip install -U pip setuptools wheel -i https://mirrors.aliyun.com/pypi/simple/
+    sudo pip3 install -r requirements.txt -i https://mirrors.aliyun.com/pypi/simple/
+    cd oneforall/
+    python3 oneforall.py --help
+    ```
+* **Darwin系统**
+
+    1. 使用pipenv
+    ```bash
+    cd OneForAll/
+    python3 -m pip install -U pip setuptools wheel -i https://mirrors.aliyun.com/pypi/simple/
+    pip3 install pipenv -i https://mirrors.aliyun.com/pypi/simple/
+    pipenv install --python 3.7
+    cd oneforall
+    pipenv run python3 oneforall.py --help
+    ```
+    2. 使用pip3
+    ```bash
+    cd OneForAll/
+    python3 -m pip install -U pip setuptools wheel -i https://mirrors.aliyun.com/pypi/simple/
+    pip3 install -r requirements.txt -i https://mirrors.aliyun.com/pypi/simple/
+    cd oneforall/
+    python3 oneforall.py --help
+    ```