Re-create documentation portal. Keep docs up to date. Publish on Pypi

.circleci/config.yml

@@ -16,8 +16,8 @@ orbs:
 jobs:
   Build-37:  # This is the name of the job, feel free to change it to better match what you're trying to do!
     # These next lines defines a Docker executors: https://circleci.com/docs/executor-types/
-    # You can specify an image from Dockerhub or use one of the convenience images from CircleCI's Developer Hub
-    # A list of available CircleCI Docker convenience images are available here: https://circleci.com/developer/images/image/cimg/python
+    # You can specify an image from Dockerhub or use one of the convenience img from CircleCI's Developer Hub
+    # A list of available CircleCI Docker convenience img are available here: https://circleci.com/developer/images/image/cimg/python
     # The executor is the environment in which the steps below will be executed - below will use a python 3.10.2 container
     # Change the version below to your required version of python
     docker:
@@ -38,8 +38,8 @@ jobs:
           command: python setup.py test
   Build-38:  # This is the name of the job, feel free to change it to better match what you're trying to do!
     # These next lines defines a Docker executors: https://circleci.com/docs/executor-types/
-    # You can specify an image from Dockerhub or use one of the convenience images from CircleCI's Developer Hub
-    # A list of available CircleCI Docker convenience images are available here: https://circleci.com/developer/images/image/cimg/python
+    # You can specify an image from Dockerhub or use one of the convenience img from CircleCI's Developer Hub
+    # A list of available CircleCI Docker convenience img are available here: https://circleci.com/developer/images/image/cimg/python
     # The executor is the environment in which the steps below will be executed - below will use a python 3.10.2 container
     # Change the version below to your required version of python
     docker:
@@ -60,8 +60,8 @@ jobs:
           command: python setup.py test
   Build-39:  # This is the name of the job, feel free to change it to better match what you're trying to do!
     # These next lines defines a Docker executors: https://circleci.com/docs/executor-types/
-    # You can specify an image from Dockerhub or use one of the convenience images from CircleCI's Developer Hub
-    # A list of available CircleCI Docker convenience images are available here: https://circleci.com/developer/images/image/cimg/python
+    # You can specify an image from Dockerhub or use one of the convenience img from CircleCI's Developer Hub
+    # A list of available CircleCI Docker convenience img are available here: https://circleci.com/developer/images/image/cimg/python
     # The executor is the environment in which the steps below will be executed - below will use a python 3.10.2 container
     # Change the version below to your required version of python
     docker:
@@ -82,8 +82,8 @@ jobs:
           command: python setup.py test
   Build-310:  # This is the name of the job, feel free to change it to better match what you're trying to do!
     # These next lines defines a Docker executors: https://circleci.com/docs/executor-types/
-    # You can specify an image from Dockerhub or use one of the convenience images from CircleCI's Developer Hub
-    # A list of available CircleCI Docker convenience images are available here: https://circleci.com/developer/images/image/cimg/python
+    # You can specify an image from Dockerhub or use one of the convenience img from CircleCI's Developer Hub
+    # A list of available CircleCI Docker convenience img are available here: https://circleci.com/developer/images/image/cimg/python
     # The executor is the environment in which the steps below will be executed - below will use a python 3.10.2 container
     # Change the version below to your required version of python
     docker:
@@ -104,8 +104,8 @@ jobs:
           command: python setup.py test
   Build-311:  # This is the name of the job, feel free to change it to better match what you're trying to do!
     # These next lines defines a Docker executors: https://circleci.com/docs/executor-types/
-    # You can specify an image from Dockerhub or use one of the convenience images from CircleCI's Developer Hub
-    # A list of available CircleCI Docker convenience images are available here: https://circleci.com/developer/images/image/cimg/python
+    # You can specify an image from Dockerhub or use one of the convenience img from CircleCI's Developer Hub
+    # A list of available CircleCI Docker convenience img are available here: https://circleci.com/developer/images/image/cimg/python
     # The executor is the environment in which the steps below will be executed - below will use a python 3.10.2 container
     # Change the version below to your required version of python
     docker:

.readthedocs.yaml

@@ -5,16 +5,24 @@
 # Required
 version: 2
 
-# Build documentation in the docs/ directory with Sphinx
-sphinx:
-  builder: html
-  configuration: docs/conf.py
-  fail_on_warning: false
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+mkdocs:
+  configuration: mkdocs.yml
 
 # Optionally, build your docs in additional formats such as PDF
 formats: all
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
   install:
-    - requirements: docs/requirements.txt
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+  system_packages: true

CHANGELOG.md

@@ -1,5 +1,9 @@
 Changes
 =======
+v4.0.6 (26.06.2023)
+---------------------------
+    -   Re-create documentation portal. Keep docs up to date. Publish on Pypi
+
 4.0.5 (25.06.2023)
 ---------------------------
     -   Update dictionary: + 45442 new directories

README.md

@@ -14,41 +14,43 @@ This application finds all possible ways to login, index of/ directories, web sh
 The scanning is performed by the built-in dictionary and external dictionaries as well. Anonymity and speed are provided by means of using proxy servers.
 Software is written for informational purposes and is open source product under the GPL license.
 
-* *Current 4.0.5 (25.06.2023)*
+[Read The Docs](https://opendoor.readthedocs.io/)
+
+* *Current 4.0.6 (25.06.2023)*
     - Directories: 82239
     - Subdomains: 181018
 
 ***Testing of the software on the live commercial systems and organizations is prohibited!***
 
 ![Alt text](http://dl3.joxi.net/drive/2017/01/30/0001/0378/90490/90/e309742b5c.jpg "OpenDoor OWASP")
 
-#### Implements
-- [x] multithreading control
-- [x] scan's reports
-- [x] directories scanner
-- [x] subdomains scanner
-- [x] HTTP(S) (PORT) support
-- [x] Keep-alive long pooling
-- [x] HTTP(S)/SOCKS proxies
-- [x] dynamic request header
-- [x] custom word-list's prefixes
-- [x] custom word-lists, proxies, ignore lists
-- [x] debug levels (-1 (silent), 1-3)
-- [x] extensions filter
-- [x] custom reports directory
-- [x] custom config wizard (use random techniques)
-- [x] analyze techniques
+- ✅ directories scanner
+- ✅ subdomains scanner
+- ✅ multithreading control
+- ✅ scan's reports
+- ✅ HTTP(S) (PORT) support
+- ✅ Keep-alive long pooling
+- ✅ Invalid certificates scan
+- ✅ HTTP(S)/SOCKS proxies
+- ✅ dynamic request header
+- ✅ custom wordlists prefixes
+- ✅ custom wordlists, proxies, ignore lists
+- ✅ debug levels (1-3)
+- ✅ extensions filter
+- ✅ custom reports directory
+- ✅ custom config wizard (use random techniques)
+- ✅ analyze techniques:
     * detect redirects
-    * detect an index of/ Apache
+    * detect index of/ Apache
     * detect large files
-    * heuristic detect invalid web pages
+    * heuristic detect invalid pages
     * blank success page filter
     * certificate required pages
-- [x] randomization techniques
+- ✅ randomization techniques:
     * random user-agent per request
     * random proxy per request
-    * word-lists shuffling
-    * word-lists filters
+    * wordlists shuffling
+    * wordlists filters
 
 
 #### Install PIP
@@ -84,7 +86,11 @@ curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
 
 #### [Changelog](CHANGELOG.md) (last changes)
 
-v4.0.5 (24.06.2023)
+v4.0.6 (26.06.2023)
+---------------------------
+    -   Re-create documentation portal. Keep docs up to date. Publish on Pypi
+
+v4.0.5 (25.06.2023)
 ---------------------------
     -   Update dictionary: + 45442 new directories
 
@@ -217,6 +223,7 @@ Also, you can suggest an ideas and create a task in my track list
 [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0) [![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/stanislav-web)  
 
 ### Documentation
+- [Read The Docs](https://opendoor.readthedocs.io/)
 - [Opendoor OWASP CookBook](https://github.com/stanislav-web/OpenDoor/wiki)
 - [Issues](https://github.com/stanislav-web/OpenDoor/issues)
 

VERSION

@@ -1 +1 @@
-4.0.5
+4.0.6

docs/Changelog.md

@@ -1,5 +1,9 @@
 Changes
 =======
+v4.0.6 (26.06.2023)
+---------------------------
+    -   Re-create documentation portal. Keep docs up to date. Publish on Pypi
+
 v4.0.5 (25.06.2023)
 ---------------------------
     -   Fix unit tests and resolve dev requirements

docs/Installation-and-update.md

@@ -1,6 +1,6 @@
 Installation
 ===============
-Python v3.9 is a minor requirement.
+**Python v3.7 is a minor requirement**.
 At the moment, the package can be installed from this repository [https://github.com/stanislav-web/OpenDoor](https://github.com/stanislav-web/OpenDoor)
 Now being tested, and the next will be published in other sources, such as Pypi.
 
@@ -14,79 +14,70 @@ Now being tested, and the next will be published in other sources, such as Pypi.
 
 Install PIP
 ---------------------------
-```
+```shell
 curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
 ```
 
-GNU Linux (Local installation and run)
+GNU Linux / OSX (Mac OS)
 ---------------------------
 
-```
+```shell
+# Install locally
  git clone https://github.com/stanislav-web/OpenDoor.git
  cd OpenDoor/
  pip3 install -r requirements.txt
  chmod +x opendoor.py
-
  python3 opendoor.py --host http://www.example.com
 ```
 
-GNU Linux (Global. Preferably for OS distributions)
----------------------------
-
-```
+```shell
+# Install globally to env
  git clone https://github.com/stanislav-web/OpenDoor.git
  cd OpenDoor/
  python3 setup.py build && python3 setup.py install
-
  opendoor --host http://www.example.com
 ```
 
-
 Windows XP/7/8/10
 ---------------------------
 
 I would recommend you to install GUI for Git at first if you don't have pre-installed Git on your laptop.
 Please see [https://git-for-windows.github.io](https://git-for-windows.github.io)
 Go to your Git bash and clone repo
 
-```
-        git clone https://github.com/stanislav-web/OpenDoor.git opendoor
-        cd opendoor
+```shell
+  git clone https://github.com/stanislav-web/OpenDoor.git opendoor
+  cd opendoor
 ```
 
 Next , install python package manager.
 Here you go > [https://pip.pypa.io/en/stable/installing/#do-i-need-to-install-pip](https://pip.pypa.io/en/stable/installing/#do-i-need-to-install-pip)
 Install dependencies
 
-```
-        C:\opendoor> pip install -r requirements.txt
+```shell
+  C:\opendoor> pip install -r requirements.txt
 ```
 s
 Unfortunately, you can't use Socks proxy on Windows. HTTP(S) supported only
 Try your fist launch
 
-```
-        C:\opendoor>python3 opendoor.py -h
+```shell
+  C:\opendoor>python3 opendoor.py -h
 ```
 
-OSX
----
-
-[TODO] Doc is not complete because the package wasn't tested for Mac
-
 Dependencies
 ============
-![Dependencies](images/dependencies.jpg)
+![Dependencies](img/dependencies.jpg)
 
 Update
 ===============
 You have an update a package using `git pull origin master` inside or run update process from interface:
-```
+```shell
 # GNU Linux
 python3 opendoor.py --update
 ```
 
-```
+```shell
 # Win
 C:\opendoor>python opendoor.py --update
 ```

docs/License.md

@@ -1,4 +1,4 @@
-![GNU General Public License](images/lgpl.jpg)
+![GNU General Public License](img/lgpl.jpg)
 
 GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007