From 05c89d12444e78f16f312f39ffbcc597f6d5c379 Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <51nk0r5w1m> Date: Wed, 16 Oct 2024 00:58:25 -0400 Subject: [PATCH 001/100] Initial commit: Add MkDocs configuration and documentation structure --- .gitignore | 4 ++++ docs/index.md | 17 +++++++++++++++++ mkdocs.yml | 1 + 3 files changed, 22 insertions(+) create mode 100644 .gitignore create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7040fb8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +venv/ +__pycache__/ +*.log +.DS_Store diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..000ea34 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,17 @@ +# Welcome to MkDocs + +For full documentation visit [mkdocs.org](https://www.mkdocs.org). + +## Commands + +* `mkdocs new [dir-name]` - Create a new project. +* `mkdocs serve` - Start the live-reloading docs server. +* `mkdocs build` - Build the documentation site. +* `mkdocs -h` - Print help message and exit. + +## Project layout + + mkdocs.yml # The configuration file. + docs/ + index.md # The documentation homepage. + ... # Other markdown pages, images and other files. diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..c97182f --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1 @@ +site_name: My Docs From 08e910276b99d485276bbcc45058669409418fe3 Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <51nk0r5w1m> Date: Wed, 16 Oct 2024 02:13:36 -0400 Subject: [PATCH 002/100] Update index.md with new content and structure --- docs/index.md | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/docs/index.md b/docs/index.md index 000ea34..07503da 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,30 @@ -# Welcome to MkDocs +# 🌐 OWASP Amass Documentation -For full documentation visit [mkdocs.org](https://www.mkdocs.org). +Expanding Data Horizons: Amassing More Than Subdomains + +**OWASP Amass** is an open-source, versatile reconnaissance platform designed to comprehensively map an organization’s digital footprint 🧩. Built for flexibility and depth, Amass combines advanced data collection, network mapping, and OSINT capabilities to deliver detailed insights into online assets. + +--- + +## Overview + +Amass extends far beyond basic subdomain enumeration, offering a comprehensive approach to information gathering that reveals the full scope of an organization's infrastructure. + +- **Broader Data Collection Capabilities**: Gather a wide range of information to uncover assets and connections that traditional methods might miss. +- **Advanced Recon Features**: Use powerful tools for detailed network mapping and asset identification to fully understand potential attack surfaces. +- **Hands-on Learning and Best Practices**: Access expert guidance on using Amass's advanced features and optimized reconnaissance workflows. +- **Community-Driven Innovation**: Contributors, including Jeff Foley, actively share insights, demos, and practical applications, driving ongoing improvements. +- **Continuous Development**: Regular updates introduce new functionalities and enhanced performance, keeping Amass aligned with the latest reconnaissance needs. + +--- + +## Getting Started 🚀 + +Follow these steps to start exploring Amass: +1. **Installation**: Check out the [installation guide](installation.md) for setup instructions. +2. **Basic Usage**: Learn practical ways to use Amass in the [user manual](user-manual.md). +3. **Configuration**: Customize Amass with settings described in the [configuration guide](configuration.md). -## Commands * `mkdocs new [dir-name]` - Create a new project. * `mkdocs serve` - Start the live-reloading docs server. From 4a78570b47bc4e04bd7ef2344873934f72b3dec0 Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 02:28:54 -0400 Subject: [PATCH 003/100] Update index.md --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 07503da..7da0e58 100644 --- a/docs/index.md +++ b/docs/index.md @@ -18,7 +18,7 @@ Amass extends far beyond basic subdomain enumeration, offering a comprehensive a --- -## Getting Started 🚀 +## Getting Started 🔧 Follow these steps to start exploring Amass: 1. **Installation**: Check out the [installation guide](installation.md) for setup instructions. From 7b361b0a5dadf3a2675d05041916ebcead5aaad9 Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 02:31:00 -0400 Subject: [PATCH 004/100] Update index.md --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 7da0e58..69254dc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,7 +2,7 @@ Expanding Data Horizons: Amassing More Than Subdomains -**OWASP Amass** is an open-source, versatile reconnaissance platform designed to comprehensively map an organization’s digital footprint 🧩. Built for flexibility and depth, Amass combines advanced data collection, network mapping, and OSINT capabilities to deliver detailed insights into online assets. +**OWASP Amass** is an open-source, versatile reconnaissance platform designed to comprehensively map an organization’s digital footprint. Built for flexibility and depth, Amass combines advanced data collection, network mapping, and OSINT capabilities to deliver detailed insights into online assets 🧩. --- From 48360f8ed4f05ae71e0b7f668e6c5c7c88973dda Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 02:47:03 -0400 Subject: [PATCH 005/100] Update index.md --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 69254dc..d9db592 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -# 🌐 OWASP Amass Documentation +# 🕸️ OWASP Amass Documentation Expanding Data Horizons: Amassing More Than Subdomains From e12813b416b166a407b85d4f6e0b3364f1f75e90 Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 03:24:13 -0400 Subject: [PATCH 006/100] Update index.md --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index d9db592..9081c09 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -# 🕸️ OWASP Amass Documentation +# 🕸️ Amass Docs Expanding Data Horizons: Amassing More Than Subdomains From 11654499c068a6e80e4f89446eef900316f0c67f Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 03:30:37 -0400 Subject: [PATCH 007/100] Update index.md --- docs/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 9081c09..380a742 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -# 🕸️ Amass Docs +# 🕸️ Amass Expanding Data Horizons: Amassing More Than Subdomains @@ -13,7 +13,7 @@ Amass extends far beyond basic subdomain enumeration, offering a comprehensive a - **Broader Data Collection Capabilities**: Gather a wide range of information to uncover assets and connections that traditional methods might miss. - **Advanced Recon Features**: Use powerful tools for detailed network mapping and asset identification to fully understand potential attack surfaces. - **Hands-on Learning and Best Practices**: Access expert guidance on using Amass's advanced features and optimized reconnaissance workflows. -- **Community-Driven Innovation**: Contributors, including Jeff Foley, actively share insights, demos, and practical applications, driving ongoing improvements. +- **Community-Driven Innovation**: Contributors actively share insights, demos, and practical applications, driving ongoing improvements. - **Continuous Development**: Regular updates introduce new functionalities and enhanced performance, keeping Amass aligned with the latest reconnaissance needs. --- From fb0983f8c28ad3c57e7f7877c29125e79e4110ce Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 10:45:29 -0400 Subject: [PATCH 008/100] Update index.md --- docs/index.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/index.md b/docs/index.md index 380a742..f896bc3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -37,3 +37,21 @@ Follow these steps to start exploring Amass: docs/ index.md # The documentation homepage. ... # Other markdown pages, images and other files. + + +License +-------- + + Copyright 2017 Jeff Foley + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. From 93bccf22ef71635acd31ac2eb94a5f430556a4ec Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 11:24:19 -0400 Subject: [PATCH 009/100] Update index.md --- docs/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index f896bc3..3a7c70c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,12 +4,12 @@ Expanding Data Horizons: Amassing More Than Subdomains **OWASP Amass** is an open-source, versatile reconnaissance platform designed to comprehensively map an organization’s digital footprint. Built for flexibility and depth, Amass combines advanced data collection, network mapping, and OSINT capabilities to deliver detailed insights into online assets 🧩. ---- - ## Overview Amass extends far beyond basic subdomain enumeration, offering a comprehensive approach to information gathering that reveals the full scope of an organization's infrastructure. +!!! info "Open Asset Model (OAM)" + - **Broader Data Collection Capabilities**: Gather a wide range of information to uncover assets and connections that traditional methods might miss. - **Advanced Recon Features**: Use powerful tools for detailed network mapping and asset identification to fully understand potential attack surfaces. - **Hands-on Learning and Best Practices**: Access expert guidance on using Amass's advanced features and optimized reconnaissance workflows. From d9b08274394718d50f806ddea8cb7dbf7ad626f5 Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 12:33:49 -0400 Subject: [PATCH 010/100] Update index.md --- docs/index.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 3a7c70c..3f327f4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,13 +2,15 @@ Expanding Data Horizons: Amassing More Than Subdomains -**OWASP Amass** is an open-source, versatile reconnaissance platform designed to comprehensively map an organization’s digital footprint. Built for flexibility and depth, Amass combines advanced data collection, network mapping, and OSINT capabilities to deliver detailed insights into online assets 🧩. +**OWASP Amass** is an open-source, versatile reconnaissance platform designed to comprehensively map an organization’s digital footprint. Built for flexibility and depth, Amass combines advanced data collection, network mapping, and OSINT capabilities to deliver detailed insights into physical and digital assets 🧩. ## Overview Amass extends far beyond basic subdomain enumeration, offering a comprehensive approach to information gathering that reveals the full scope of an organization's infrastructure. !!! info "Open Asset Model (OAM)" + The Open Asset Model expands traditional asset specifications by covering both physical and digital assets, aiming to provide a comprehensive view of organization'sattack surface. It defines assets and their relationships, capturing the real-world interconnectedness between them. + [Taxonomy documentation](https://github.com/owasp-amass/open-asset-model/blob/master/docs/taxonomy.md) - **Broader Data Collection Capabilities**: Gather a wide range of information to uncover assets and connections that traditional methods might miss. - **Advanced Recon Features**: Use powerful tools for detailed network mapping and asset identification to fully understand potential attack surfaces. From 02aaa7416de3f821757ee65fd525aebe459cdb5d Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 13:10:05 -0400 Subject: [PATCH 011/100] Update mkdocs.yml --- mkdocs.yml | 79 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 78 insertions(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index c97182f..64b0be6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1 +1,78 @@ -site_name: My Docs +# pip install mkdocs mkdocs-material +# mkdocs serve +# mkdocs gh-deploy + +site_name: OWASP Amass +repo_name: OWASP Amass +repo_url: https://github.com/51nk0r5w1m/docs +site_description: "In-depth OSINT collection and external attack surface mapping " +site_author: OWASP Amass Contributors +remote_branch: gh-pages + +#copyright: + +theme: + name: 'material' + #favicon: images/slack_logo_small.png + #logo: images/slack_logo.png + palette: + - media: '(prefers-color-scheme: light)' + scheme: default + primary: 'white' + accent: 'red' + toggle: + icon: material/brightness-7 + name: Switch to dark mode + - media: '(prefers-color-scheme: dark)' + scheme: slate + primary: 'black' + accent: 'red' + toggle: + icon: material/brightness-4 + name: Switch to light mode + font: + text: 'Lato' + code: 'Fira Code' + features: + - content.code.copy + - content.code.select + +extra_css: + - 'css/app.css' + +markdown_extensions: + - smarty + - codehilite: + guess_lang: false + - footnotes + - meta + - toc: + permalink: true + - pymdownx.betterem: + smart_enable: all + - pymdownx.caret + - pymdownx.inlinehilite + - pymdownx.magiclink + - pymdownx.smartsymbols + - pymdownx.superfences + - pymdownx.emoji + - pymdownx.tabbed: + alternate_style: true + - tables + - admonition + - attr_list + - md_in_html + +nav: + - 'Introduction': index.md + - 'Getting Started': getting-started.md + - 'Installation': installation.md + - 'Configuration': configuration.md + - 'Recon Techniques': recon-techniques.md + - 'Data Sources': data-sources.md + - 'Advanced Usage': advanced-usage.md + #- 'API Documentation': api/0.x/index.html + - 'Discussions ⏏': https://github.com/51nk0r5w1m/docs/discussions + - 'Change Log': changelog.md + - 'Contributing': contributing.md + #- 'Code of Conduct': code-of-conduct.md From fdafc35d51307e4c848586633f6009671cf4b5bb Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 13:23:18 -0400 Subject: [PATCH 012/100] Update mkdocs.yml --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 64b0be6..d5ff6e7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -72,7 +72,7 @@ nav: - 'Data Sources': data-sources.md - 'Advanced Usage': advanced-usage.md #- 'API Documentation': api/0.x/index.html - - 'Discussions ⏏': https://github.com/51nk0r5w1m/docs/discussions + #- 'Discussions ⏏': https://github.com/owasp-amass/amass/discussions - 'Change Log': changelog.md - 'Contributing': contributing.md #- 'Code of Conduct': code-of-conduct.md From 30c498148f0ef155ce02f93f8bd37a6e0975fa0d Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 17:13:05 -0400 Subject: [PATCH 013/100] Create workflows --- .github/workflows | 1 + 1 file changed, 1 insertion(+) create mode 100644 .github/workflows diff --git a/.github/workflows b/.github/workflows new file mode 100644 index 0000000..5e40119 --- /dev/null +++ b/.github/workflows @@ -0,0 +1 @@ +.keep From 36af3c369e5b89f575608968b38104c41608c053 Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 17:14:28 -0400 Subject: [PATCH 014/100] Delete .github/workflows --- .github/workflows | 1 - 1 file changed, 1 deletion(-) delete mode 100644 .github/workflows diff --git a/.github/workflows b/.github/workflows deleted file mode 100644 index 5e40119..0000000 --- a/.github/workflows +++ /dev/null @@ -1 +0,0 @@ -.keep From a7773cb5014e2af92cdf133c72528421bfc62fb3 Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 17:14:52 -0400 Subject: [PATCH 015/100] Create placeholder.txt --- .github/workflows/placeholder.txt | 1 + 1 file changed, 1 insertion(+) create mode 100644 .github/workflows/placeholder.txt diff --git a/.github/workflows/placeholder.txt b/.github/workflows/placeholder.txt new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/.github/workflows/placeholder.txt @@ -0,0 +1 @@ + From 841d3b0dac6aaf715e09b7ea437f7e59e056622c Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 17:15:50 -0400 Subject: [PATCH 016/100] Delete .github/workflows/placeholder.txt --- .github/workflows/placeholder.txt | 1 - 1 file changed, 1 deletion(-) delete mode 100644 .github/workflows/placeholder.txt diff --git a/.github/workflows/placeholder.txt b/.github/workflows/placeholder.txt deleted file mode 100644 index 8b13789..0000000 --- a/.github/workflows/placeholder.txt +++ /dev/null @@ -1 +0,0 @@ - From 01f73b95ca15c45ee60dffb1efe5a32e644d3001 Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 17:16:38 -0400 Subject: [PATCH 017/100] Create placeholder.txt Create .github/workflows directory --- .github/workflows/placeholder.txt | 1 + 1 file changed, 1 insertion(+) create mode 100644 .github/workflows/placeholder.txt diff --git a/.github/workflows/placeholder.txt b/.github/workflows/placeholder.txt new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/.github/workflows/placeholder.txt @@ -0,0 +1 @@ + From c6b3ea2574757627bc93824f7f60a6460ef1dab5 Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 17:19:04 -0400 Subject: [PATCH 018/100] test.yml workflow --- .github/workflows/.github/workflows/test.yml | 28 ++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 .github/workflows/.github/workflows/test.yml diff --git a/.github/workflows/.github/workflows/test.yml b/.github/workflows/.github/workflows/test.yml new file mode 100644 index 0000000..0ac91c9 --- /dev/null +++ b/.github/workflows/.github/workflows/test.yml @@ -0,0 +1,28 @@ +name: Test MkDocs Build + +on: + push: + branches: + - renovate/** # Trigger on Renovate branches + - features + pull_request: + branches: + - features + +jobs: + test: + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v3 + + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: '3.x' + + - name: Install dependencies + run: pip install -r requirements.txt + + - name: Build MkDocs site + run: mkdocs build --strict From 8d7995b3ffcc7eb68a639aa1cfa499f342e4f102 Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 17:22:24 -0400 Subject: [PATCH 019/100] Add create-pr-for-main.yml workflow --- .../.github/workflows/create-pr-for-main.yml | 29 +++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 .github/workflows/.github/workflows/create-pr-for-main.yml diff --git a/.github/workflows/.github/workflows/create-pr-for-main.yml b/.github/workflows/.github/workflows/create-pr-for-main.yml new file mode 100644 index 0000000..1e5deaa --- /dev/null +++ b/.github/workflows/.github/workflows/create-pr-for-main.yml @@ -0,0 +1,29 @@ +name: Create PR to Main After Tests + +on: + workflow_run: + workflows: ["Test MkDocs Build"] + types: + - completed + +jobs: + create-pr: + if: ${{ github.event.workflow_run.conclusion == 'success' }} + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v3 + + - name: Set up Git + run: | + git config user.name "GitHub Actions" + git config user.email "actions@github.com" + + - name: Create Pull Request + uses: peter-evans/create-pull-request@v5 + with: + branch: features + base: main + title: "Automated PR for updates from features" + body: "This PR merges successfully tested updates from the features branch." + token: ${{ secrets.GITHUB_TOKEN }} From 29a9e773ca518067910ca4c385e896a400d7be2c Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 17:23:46 -0400 Subject: [PATCH 020/100] Delete .github/workflows/.github directory --- .../.github/workflows/create-pr-for-main.yml | 29 ------------------- .github/workflows/.github/workflows/test.yml | 28 ------------------ 2 files changed, 57 deletions(-) delete mode 100644 .github/workflows/.github/workflows/create-pr-for-main.yml delete mode 100644 .github/workflows/.github/workflows/test.yml diff --git a/.github/workflows/.github/workflows/create-pr-for-main.yml b/.github/workflows/.github/workflows/create-pr-for-main.yml deleted file mode 100644 index 1e5deaa..0000000 --- a/.github/workflows/.github/workflows/create-pr-for-main.yml +++ /dev/null @@ -1,29 +0,0 @@ -name: Create PR to Main After Tests - -on: - workflow_run: - workflows: ["Test MkDocs Build"] - types: - - completed - -jobs: - create-pr: - if: ${{ github.event.workflow_run.conclusion == 'success' }} - runs-on: ubuntu-latest - steps: - - name: Checkout code - uses: actions/checkout@v3 - - - name: Set up Git - run: | - git config user.name "GitHub Actions" - git config user.email "actions@github.com" - - - name: Create Pull Request - uses: peter-evans/create-pull-request@v5 - with: - branch: features - base: main - title: "Automated PR for updates from features" - body: "This PR merges successfully tested updates from the features branch." - token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/.github/workflows/test.yml b/.github/workflows/.github/workflows/test.yml deleted file mode 100644 index 0ac91c9..0000000 --- a/.github/workflows/.github/workflows/test.yml +++ /dev/null @@ -1,28 +0,0 @@ -name: Test MkDocs Build - -on: - push: - branches: - - renovate/** # Trigger on Renovate branches - - features - pull_request: - branches: - - features - -jobs: - test: - runs-on: ubuntu-latest - steps: - - name: Checkout code - uses: actions/checkout@v3 - - - name: Set up Python - uses: actions/setup-python@v4 - with: - python-version: '3.x' - - - name: Install dependencies - run: pip install -r requirements.txt - - - name: Build MkDocs site - run: mkdocs build --strict From 7f0543bb347d60ef21b1c73d822f09add668d728 Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 17:24:26 -0400 Subject: [PATCH 021/100] Create test.yml --- .github/workflows/test.yml | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 .github/workflows/test.yml diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..0ac91c9 --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,28 @@ +name: Test MkDocs Build + +on: + push: + branches: + - renovate/** # Trigger on Renovate branches + - features + pull_request: + branches: + - features + +jobs: + test: + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v3 + + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: '3.x' + + - name: Install dependencies + run: pip install -r requirements.txt + + - name: Build MkDocs site + run: mkdocs build --strict From 7a62d7468015e35eb3c2a3b5a44100e6f9b8ecec Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 17:25:06 -0400 Subject: [PATCH 022/100] Add create-pr-for-main.yml workflow --- .github/workflows/create-pr-for-main.yml | 29 ++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 .github/workflows/create-pr-for-main.yml diff --git a/.github/workflows/create-pr-for-main.yml b/.github/workflows/create-pr-for-main.yml new file mode 100644 index 0000000..1e5deaa --- /dev/null +++ b/.github/workflows/create-pr-for-main.yml @@ -0,0 +1,29 @@ +name: Create PR to Main After Tests + +on: + workflow_run: + workflows: ["Test MkDocs Build"] + types: + - completed + +jobs: + create-pr: + if: ${{ github.event.workflow_run.conclusion == 'success' }} + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v3 + + - name: Set up Git + run: | + git config user.name "GitHub Actions" + git config user.email "actions@github.com" + + - name: Create Pull Request + uses: peter-evans/create-pull-request@v5 + with: + branch: features + base: main + title: "Automated PR for updates from features" + body: "This PR merges successfully tested updates from the features branch." + token: ${{ secrets.GITHUB_TOKEN }} From f07c4d1c4ceb10dcbdb6ee1866f1eb1ca725a54c Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 17:25:30 -0400 Subject: [PATCH 023/100] Delete .github/workflows/placeholder.txt --- .github/workflows/placeholder.txt | 1 - 1 file changed, 1 deletion(-) delete mode 100644 .github/workflows/placeholder.txt diff --git a/.github/workflows/placeholder.txt b/.github/workflows/placeholder.txt deleted file mode 100644 index 8b13789..0000000 --- a/.github/workflows/placeholder.txt +++ /dev/null @@ -1 +0,0 @@ - From 96d85806a555c657964c49fba22215e8c713ed91 Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 17:33:32 -0400 Subject: [PATCH 024/100] Delete .github/workflows directory --- .github/workflows/create-pr-for-main.yml | 29 ------------------------ .github/workflows/test.yml | 28 ----------------------- 2 files changed, 57 deletions(-) delete mode 100644 .github/workflows/create-pr-for-main.yml delete mode 100644 .github/workflows/test.yml diff --git a/.github/workflows/create-pr-for-main.yml b/.github/workflows/create-pr-for-main.yml deleted file mode 100644 index 1e5deaa..0000000 --- a/.github/workflows/create-pr-for-main.yml +++ /dev/null @@ -1,29 +0,0 @@ -name: Create PR to Main After Tests - -on: - workflow_run: - workflows: ["Test MkDocs Build"] - types: - - completed - -jobs: - create-pr: - if: ${{ github.event.workflow_run.conclusion == 'success' }} - runs-on: ubuntu-latest - steps: - - name: Checkout code - uses: actions/checkout@v3 - - - name: Set up Git - run: | - git config user.name "GitHub Actions" - git config user.email "actions@github.com" - - - name: Create Pull Request - uses: peter-evans/create-pull-request@v5 - with: - branch: features - base: main - title: "Automated PR for updates from features" - body: "This PR merges successfully tested updates from the features branch." - token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml deleted file mode 100644 index 0ac91c9..0000000 --- a/.github/workflows/test.yml +++ /dev/null @@ -1,28 +0,0 @@ -name: Test MkDocs Build - -on: - push: - branches: - - renovate/** # Trigger on Renovate branches - - features - pull_request: - branches: - - features - -jobs: - test: - runs-on: ubuntu-latest - steps: - - name: Checkout code - uses: actions/checkout@v3 - - - name: Set up Python - uses: actions/setup-python@v4 - with: - python-version: '3.x' - - - name: Install dependencies - run: pip install -r requirements.txt - - - name: Build MkDocs site - run: mkdocs build --strict From b2f442780ebff2107e126675bd4bcb1a4aa34fc0 Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 17:34:39 -0400 Subject: [PATCH 025/100] Create .github --- .github | 1 + 1 file changed, 1 insertion(+) create mode 100644 .github diff --git a/.github b/.github new file mode 100644 index 0000000..5e40119 --- /dev/null +++ b/.github @@ -0,0 +1 @@ +.keep From bb3cd99d36180f692eb01ca0775c2e4ba09546ad Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 17:34:52 -0400 Subject: [PATCH 026/100] Delete .github --- .github | 1 - 1 file changed, 1 deletion(-) delete mode 100644 .github diff --git a/.github b/.github deleted file mode 100644 index 5e40119..0000000 --- a/.github +++ /dev/null @@ -1 +0,0 @@ -.keep From d3afe216044cc95818d8981b6186b647f69ff323 Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 17:35:17 -0400 Subject: [PATCH 027/100] Create placeholder.text --- .github/placeholder.text | 1 + 1 file changed, 1 insertion(+) create mode 100644 .github/placeholder.text diff --git a/.github/placeholder.text b/.github/placeholder.text new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/.github/placeholder.text @@ -0,0 +1 @@ + From c5ea7ebea49f34905e2622d18b851d9125ed57c5 Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 22:58:41 -0400 Subject: [PATCH 028/100] Create workflows --- .github/workflows | 1 + 1 file changed, 1 insertion(+) create mode 100644 .github/workflows diff --git a/.github/workflows b/.github/workflows new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/.github/workflows @@ -0,0 +1 @@ + From f8034e768ad3cf3976d4dd3262ed3d5467013390 Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 23:00:12 -0400 Subject: [PATCH 029/100] Delete .github/workflows --- .github/workflows | 1 - 1 file changed, 1 deletion(-) delete mode 100644 .github/workflows diff --git a/.github/workflows b/.github/workflows deleted file mode 100644 index 8b13789..0000000 --- a/.github/workflows +++ /dev/null @@ -1 +0,0 @@ - From 0143b00c6f52337424bdd004dd4347b801d25f2d Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 23:01:51 -0400 Subject: [PATCH 030/100] Placeholder file to create workflows folder --- .github/workflows/placeholder.txt | 1 + 1 file changed, 1 insertion(+) create mode 100644 .github/workflows/placeholder.txt diff --git a/.github/workflows/placeholder.txt b/.github/workflows/placeholder.txt new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/.github/workflows/placeholder.txt @@ -0,0 +1 @@ + From 24c6005ee3a196680af2df2be4468cb5854f97bd Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 23:08:58 -0400 Subject: [PATCH 031/100] Create mkdocs-build.yml --- .github/workflows/mkdocs-build.yml | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 .github/workflows/mkdocs-build.yml diff --git a/.github/workflows/mkdocs-build.yml b/.github/workflows/mkdocs-build.yml new file mode 100644 index 0000000..c413542 --- /dev/null +++ b/.github/workflows/mkdocs-build.yml @@ -0,0 +1,30 @@ +name: MkDocs Build + +on: + pull_request: + push: + branches: + - master + - features + - development + +jobs: + mkdocs-build: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v3 + + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: '3.x' + + - name: Install dependencies + run: | + pip install mkdocs-material + pip install -r requirements.txt + + - name: Build MkDocs site + run: mkdocs build --strict From 96484e9bf19503993243de52be53dfab4ad9d888 Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 23:24:06 -0400 Subject: [PATCH 032/100] Create renovate.json --- renovate.json | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 renovate.json diff --git a/renovate.json b/renovate.json new file mode 100644 index 0000000..115cbdf --- /dev/null +++ b/renovate.json @@ -0,0 +1,34 @@ +{ + "description": "Renovate configuration for managing Python dependencies, MkDocs, and style/linting tools.", + "extends": ["config:base"], + "baseBranches": ["development"], + "prHourlyLimit": 2, + "automerge": false, + "packageRules": [ + { + "description": "Manage Python dependencies using pip (MkDocs-related and general).", + "matchManagers": ["pip_requirements"], + "separateMinorPatch": true, + "automerge": true, + "automergeType": "pr", + "schedule": ["every weekday"] + }, + { + "description": "Manage style and linting tools (black, isort, ruff).", + "matchManagers": ["pip_requirements"], + "matchPackagePatterns": ["black", "isort", "ruff"], + "separateMinorPatch": true, + "automerge": false, + "schedule": ["every week"] + }, + { + "description": "Manage GitHub Actions dependencies.", + "matchManagers": ["github-actions"], + "separateMinorPatch": true, + "automerge": false, + "pinDigests": true, + "schedule": ["every week"] + } + ], + "dependencyDashboard": true +} From f3174eaf450c50a7d3f00771e80add3a2316bf8b Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 23:24:32 -0400 Subject: [PATCH 033/100] Delete .github/placeholder.text --- .github/placeholder.text | 1 - 1 file changed, 1 deletion(-) delete mode 100644 .github/placeholder.text diff --git a/.github/placeholder.text b/.github/placeholder.text deleted file mode 100644 index 8b13789..0000000 --- a/.github/placeholder.text +++ /dev/null @@ -1 +0,0 @@ - From f26c4430c89ad91565e07abebdf2a2ed6658a9ac Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 23:24:43 -0400 Subject: [PATCH 034/100] Delete .github/workflows/placeholder.txt --- .github/workflows/placeholder.txt | 1 - 1 file changed, 1 deletion(-) delete mode 100644 .github/workflows/placeholder.txt diff --git a/.github/workflows/placeholder.txt b/.github/workflows/placeholder.txt deleted file mode 100644 index 8b13789..0000000 --- a/.github/workflows/placeholder.txt +++ /dev/null @@ -1 +0,0 @@ - From 66cd0c9a69650a5c32dd54e1f9f161e1c459c182 Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 23:29:23 -0400 Subject: [PATCH 035/100] Update mkdocs-build.yml --- .github/workflows/mkdocs-build.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/mkdocs-build.yml b/.github/workflows/mkdocs-build.yml index c413542..6ed148d 100644 --- a/.github/workflows/mkdocs-build.yml +++ b/.github/workflows/mkdocs-build.yml @@ -5,8 +5,8 @@ on: push: branches: - master - - features - - development + - develop + - feature/* jobs: mkdocs-build: From dfbfae1c674e679d9639220837643e88c2839b04 Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <111602071+51nk0r5w1m@users.noreply.github.com> Date: Wed, 16 Oct 2024 23:32:02 -0400 Subject: [PATCH 036/100] Create markdown-lint.yml --- .github/workflows/markdown-lint.yml | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 .github/workflows/markdown-lint.yml diff --git a/.github/workflows/markdown-lint.yml b/.github/workflows/markdown-lint.yml new file mode 100644 index 0000000..943260f --- /dev/null +++ b/.github/workflows/markdown-lint.yml @@ -0,0 +1,28 @@ +name: Markdown Lint + +on: + pull_request: + push: + branches: + - master + - develop + - feature/* + +jobs: + markdown-lint: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v3 + + - name: Set up Node.js + uses: actions/setup-node@v3 + with: + node-version: '16' + + - name: Install markdownlint-cli + run: npm install -g markdownlint-cli + + - name: Run markdownlint + run: markdownlint '**/*.md' From 8fac03bc0b018a68441510c8c894a7b0b32dd781 Mon Sep 17 00:00:00 2001 From: 51nk0r5w1m <51nk0r5w1m> Date: Thu, 17 Oct 2024 01:22:32 -0400 Subject: [PATCH 037/100] Add updates to documentation --- docs/index.md | 26 +- docs/requirements.txt | 56 + mkdocs.yml | 6 +- site/404.html | 494 ++ site/assets/images/favicon.png | Bin 0 -> 1870 bytes .../assets/javascripts/bundle.83f73b43.min.js | 16 + .../javascripts/bundle.83f73b43.min.js.map | 7 + .../javascripts/lunr/min/lunr.ar.min.js | 1 + .../javascripts/lunr/min/lunr.da.min.js | 18 + .../javascripts/lunr/min/lunr.de.min.js | 18 + .../javascripts/lunr/min/lunr.du.min.js | 18 + .../javascripts/lunr/min/lunr.el.min.js | 1 + .../javascripts/lunr/min/lunr.es.min.js | 18 + .../javascripts/lunr/min/lunr.fi.min.js | 18 + .../javascripts/lunr/min/lunr.fr.min.js | 18 + .../javascripts/lunr/min/lunr.he.min.js | 1 + .../javascripts/lunr/min/lunr.hi.min.js | 1 + .../javascripts/lunr/min/lunr.hu.min.js | 18 + .../javascripts/lunr/min/lunr.hy.min.js | 1 + .../javascripts/lunr/min/lunr.it.min.js | 18 + .../javascripts/lunr/min/lunr.ja.min.js | 1 + .../javascripts/lunr/min/lunr.jp.min.js | 1 + .../javascripts/lunr/min/lunr.kn.min.js | 1 + .../javascripts/lunr/min/lunr.ko.min.js | 1 + .../javascripts/lunr/min/lunr.multi.min.js | 1 + .../javascripts/lunr/min/lunr.nl.min.js | 18 + .../javascripts/lunr/min/lunr.no.min.js | 18 + .../javascripts/lunr/min/lunr.pt.min.js | 18 + .../javascripts/lunr/min/lunr.ro.min.js | 18 + .../javascripts/lunr/min/lunr.ru.min.js | 18 + .../javascripts/lunr/min/lunr.sa.min.js | 1 + .../lunr/min/lunr.stemmer.support.min.js | 1 + .../javascripts/lunr/min/lunr.sv.min.js | 18 + .../javascripts/lunr/min/lunr.ta.min.js | 1 + .../javascripts/lunr/min/lunr.te.min.js | 1 + .../javascripts/lunr/min/lunr.th.min.js | 1 + .../javascripts/lunr/min/lunr.tr.min.js | 18 + .../javascripts/lunr/min/lunr.vi.min.js | 1 + .../javascripts/lunr/min/lunr.zh.min.js | 1 + site/assets/javascripts/lunr/tinyseg.js | 206 + site/assets/javascripts/lunr/wordcut.js | 6708 +++++++++++++++++ .../workers/search.6ce7567c.min.js | 42 + .../workers/search.6ce7567c.min.js.map | 7 + site/assets/stylesheets/main.0253249f.min.css | 1 + .../stylesheets/main.0253249f.min.css.map | 1 + .../stylesheets/palette.06af60db.min.css | 1 + .../stylesheets/palette.06af60db.min.css.map | 1 + site/index.html | 689 ++ site/requirements.txt | 56 + site/search/search_index.json | 1 + site/sitemap.xml | 3 + site/sitemap.xml.gz | Bin 0 -> 127 bytes 52 files changed, 8586 insertions(+), 22 deletions(-) create mode 100644 docs/requirements.txt create mode 100644 site/404.html create mode 100644 site/assets/images/favicon.png create mode 100644 site/assets/javascripts/bundle.83f73b43.min.js create mode 100644 site/assets/javascripts/bundle.83f73b43.min.js.map create mode 100644 site/assets/javascripts/lunr/min/lunr.ar.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.da.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.de.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.du.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.el.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.es.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.fi.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.fr.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.he.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.hi.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.hu.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.hy.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.it.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.ja.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.jp.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.kn.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.ko.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.multi.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.nl.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.no.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.pt.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.ro.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.ru.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.sa.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.stemmer.support.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.sv.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.ta.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.te.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.th.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.tr.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.vi.min.js create mode 100644 site/assets/javascripts/lunr/min/lunr.zh.min.js create mode 100644 site/assets/javascripts/lunr/tinyseg.js create mode 100644 site/assets/javascripts/lunr/wordcut.js create mode 100644 site/assets/javascripts/workers/search.6ce7567c.min.js create mode 100644 site/assets/javascripts/workers/search.6ce7567c.min.js.map create mode 100644 site/assets/stylesheets/main.0253249f.min.css create mode 100644 site/assets/stylesheets/main.0253249f.min.css.map create mode 100644 site/assets/stylesheets/palette.06af60db.min.css create mode 100644 site/assets/stylesheets/palette.06af60db.min.css.map create mode 100644 site/index.html create mode 100644 site/requirements.txt create mode 100644 site/search/search_index.json create mode 100644 site/sitemap.xml create mode 100644 site/sitemap.xml.gz diff --git a/docs/index.md b/docs/index.md index 3f327f4..e1811e3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,6 @@ -# 🕸️ Amass +# 🧩Amass Docs -Expanding Data Horizons: Amassing More Than Subdomains - -**OWASP Amass** is an open-source, versatile reconnaissance platform designed to comprehensively map an organization’s digital footprint. Built for flexibility and depth, Amass combines advanced data collection, network mapping, and OSINT capabilities to deliver detailed insights into physical and digital assets 🧩. +**OWASP Amass** is an open-source, versatile reconnaissance platform designed to comprehensively map an organization’s digital footprint. Built for flexibility and depth, Amass combines advanced data collection, network mapping, and OSINT capabilities to deliver detailed insights into physical and digital assets. ## Overview @@ -20,25 +18,15 @@ Amass extends far beyond basic subdomain enumeration, offering a comprehensive a --- -## Getting Started 🔧 - -Follow these steps to start exploring Amass: -1. **Installation**: Check out the [installation guide](installation.md) for setup instructions. -2. **Basic Usage**: Learn practical ways to use Amass in the [user manual](user-manual.md). -3. **Configuration**: Customize Amass with settings described in the [configuration guide](configuration.md). +## Getting Started +🔧 Follow these steps to start exploring Amass: -* `mkdocs new [dir-name]` - Create a new project. -* `mkdocs serve` - Start the live-reloading docs server. -* `mkdocs build` - Build the documentation site. -* `mkdocs -h` - Print help message and exit. +1. **Installation**: Check out the [installation guide](installation.md) for setup instructions. -## Project layout +2. **Basic Usage**: Learn practical ways to use Amass in the [user manual](user-manual.md). - mkdocs.yml # The configuration file. - docs/ - index.md # The documentation homepage. - ... # Other markdown pages, images and other files. +3. **Configuration**: Customize Amass with settings described in the [configuration guide](configuration.md). License diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..a13a8e2 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,56 @@ +babel==2.16.0 +blinker==1.4 +certifi==2024.8.30 +charset-normalizer==3.4.0 +click==8.1.7 +colorama==0.4.6 +command-not-found==0.3 +cryptography==3.4.8 +dbus-python==1.2.18 +distro==1.7.0 +distro-info==1.1+ubuntu0.2 +ghp-import==2.1.0 +httplib2==0.20.2 +idna==3.10 +importlib-metadata==4.6.4 +jeepney==0.7.1 +Jinja2==3.1.4 +keyring==23.5.0 +launchpadlib==1.10.16 +lazr.restfulclient==0.14.4 +lazr.uri==1.0.6 +Markdown==3.7 +MarkupSafe==3.0.1 +mergedeep==1.3.4 +mkdocs==1.6.1 +mkdocs-get-deps==0.2.0 +mkdocs-material==9.5.41 +mkdocs-material-extensions==1.3.1 +more-itertools==8.10.0 +netifaces==0.11.0 +oauthlib==3.2.0 +packaging==24.1 +paginate==0.5.7 +pathspec==0.12.1 +platformdirs==4.3.6 +Pygments==2.18.0 +PyGObject==3.42.1 +PyJWT==2.3.0 +pymdown-extensions==10.11.2 +pyparsing==2.4.7 +python-apt==2.4.0+ubuntu3 +python-dateutil==2.9.0.post0 +PyYAML==6.0.2 +pyyaml_env_tag==0.1 +regex==2024.9.11 +requests==2.32.3 +SecretStorage==3.3.1 +six==1.16.0 +systemd-python==234 +ubuntu-advantage-tools==8001 +ufw==0.36.1 +unattended-upgrades==0.1 +urllib3==2.2.3 +wadllib==1.3.6 +watchdog==5.0.3 +zipp==1.0.0 diff --git a/mkdocs.yml b/mkdocs.yml index d5ff6e7..3d86091 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -18,17 +18,17 @@ theme: palette: - media: '(prefers-color-scheme: light)' scheme: default - primary: 'white' + primary: 'indigo' accent: 'red' toggle: - icon: material/brightness-7 + icon: material/toggle-switch name: Switch to dark mode - media: '(prefers-color-scheme: dark)' scheme: slate primary: 'black' accent: 'red' toggle: - icon: material/brightness-4 + icon: material/toggle-switch-off-outline name: Switch to light mode font: text: 'Lato' diff --git a/site/404.html b/site/404.html new file mode 100644 index 0000000..3c33fc6 --- /dev/null +++ b/site/404.html @@ -0,0 +1,494 @@ + + + +
+ + + + + + + + + + + + + + + + + + +