## 1. Project Overview & Quickstart (projectdiscovery/nuclei-templates) ## File: README.md

Nuclei Templates

Community curated list of templates for the nuclei engine to find security vulnerabilities in applications.

---- Templates are the core of the [nuclei scanner](https://github.com/projectdiscovery/nuclei) which powers the actual scanning engine. This repository stores and houses various templates for the scanner provided by our team, as well as contributed by the community. We hope that you also contribute by sending templates via **pull requests** or [Github issues](https://github.com/projectdiscovery/nuclei-templates/issues/new?assignees=&labels=&template=submit-template.md&title=%5Bnuclei-template%5D+) to grow the list. ## Nuclei Templates overview An overview of the nuclei template project, including statistics on unique tags, author, directory, severity, and type of templates. The table below contains the top ten statistics for each matrix; an expanded version of this is [available here](TEMPLATES-STATS.md), and also available in [JSON](TEMPLATES-STATS.json) format for integration. | ### 🚨 Known Exploited Vulnerabilities (KEV) Coverage Nuclei templates provide coverage for vulnerabilities actively exploited in the wild: **KEV Source** **Templates** **Description** ---------------- --------------- ----------------- 🔴 **CISA KEV** **454** [CISA Known Exploited Vulnerabilities Catalog](https://www.cisa.gov/known-exploited-vulnerabilities-catalog) 🟠 **VulnCheck KEV** **1449** [VulnCheck KEV](https://vulncheck.com/kev) - Enhanced vulnerability intelligence 🟢 **Both Sources** **407** Templates covering vulnerabilities in both catalogs > 💡 **Total unique KEV templates: 1496** - Use `nuclei -tags kev,vkev` to scan for actively exploited vulnerabilities --- ## Nuclei Templates Top 10 statistics TAG COUNT AUTHOR COUNT DIRECTORY COUNT SEVERITY COUNT TYPE COUNT ----------- ------- --------------- ------- ------------ ------- ---------- ------- ------ ------- vuln 6468 dhiyaneshdk 1894 http 9281 info 4353 file 436 cve 3587 daffainfo 905 cloud 659 high 2552 dns 26 discovery 3265 princechaddha 854 file 436 medium 2457 vkev 1394 dwisiswant0 805 network 259 critical 1555 panel 1365 ritikchaddha 678 code 251 low 330 xss 1269 pussycat0x 675 dast 240 unknown 54 wordpress 1261 pikpikcu 353 workflows 205 exposure 1141 pdteam 314 javascript 92 wp-plugin 1103 pdresearch 275 ssl 38 osint 848 iamnoooob 263 dns 23 **873 directories, 11997 files**. | | --- | 📖 Documentation ----- Please navigate to https://nuclei.projectdiscovery.io for detailed documentation to **build** new or your own **custom** templates. We have also added a set of templates to help you understand how things work. 💪 Contributions ----- Nuclei-templates is powered by major contributions from the community. [Template contributions ](https://github.com/projectdiscovery/nuclei-templates/issues/new?assignees=&labels=&template=submit-template.md&title=%5Bnuclei-template%5D+), [Feature Requests](https://github.com/projectdiscovery/nuclei-templates/issues/new?assignees=&labels=&template=feature_request.md&title=%5BFeature%5D+) and [Bug Reports](https://github.com/projectdiscovery/nuclei-templates/issues/new?assignees=&labels=&template=bug_report.md&title=%5BBug%5D+) are more than welcome. 💬 Discussion ----- Have questions / doubts / ideas to discuss? Feel free to open a discussion on [Github discussions](https://github.com/projectdiscovery/nuclei-templates/discussions) board. 👨‍💻 Community ----- You are welcome to join the active [Discord Community](https://discord.gg/projectdiscovery) to discuss directly with project maintainers and share things with others around security and automation. Additionally, you may follow us on [Twitter](https://twitter.com/pdnuclei) to be updated on all the things about Nuclei. Thanks again for your contribution and keeping this community vibrant. :heart: --- ## File: http/token-spray/README.md ## About This directory holds templates that have static API URL endpoints. Use these to test an API token against many API service endpoints. By providing token input using flag, Nuclei will test the token against all known API endpoints within the API templates, and return any successful results. By incorporating API checks as Nuclei Templates, users can test API keys that have no context (i.e., API keys that do not indicate for which API endpoint they are meant). ## Usage token-spray are **self-contained** template and does not requires URLs as input as the API endpoints have static URLs predefined in the template. Each template in the `token-spray` directory assumes the input API token/s will be provided using CLI `var` flag. ```console # Running token-spray templates against a single token to test nuclei -t token-spray/ -var token=random-token-to-test -esc # Running token-spray templates against a file containing multiple new line delimited tokens nuclei -t token-spray/ -var token=file_with_tokens.txt -esc ``` ## Credits These API testing templates were inspired by the [streaak/keyhacks](https://github.com/streaak/keyhacks) repository. The Bishop Fox [Continuous Attack Surface Testing (CAST)](https://www.bishopfox.com/continuous-attack-surface-testing/how-cast-works/) team created additional API templates for testing API keys uncovered during investigations. You are welcome to add new templates based on the existing format to cover more APIs. --- ## File: http/osint/phishing/README.md ## Description This directory contains a collection of templates designed for the identification and analysis of phishing sites. These templates are specifically created to help OSINT analysts, threat researchers, and security professionals in discovering and studying phishing campaigns. ## Usage The phishing templates are designed for targeted use and are not included in Nuclei's default scans. To incorporate these templates into your scan, you can specify them using the `-itags` flags as follows: ```console nuclei -u -tags phishing -itags phishing ``` For users interested in comprehensive Open Source Intelligence (OSINT) gathering, these phishing templates have been integrated into the OSINT scan profile. This enables a more detailed and focused analysis as part of broader security research efforts or investigative journalism. To execute the OSINT scan configuration profile, which includes phishing checks among other templates, use the following command: ```console # Execute the OSINT scan configuration profile nuclei -u -config ~/nuclei-templates/config/osint.yml ``` The integration of phishing templates into the OSINT scan profile allows for a more nuanced and in-depth approach to security research, aiding in the detection of emerging threats and the analysis of ongoing phishing campaigns. --- ## File: http/osint/user-enumeration/README.md ## Description OSINT templates are available for conducting user enumeration across many websites. By utilizing the flag to input a user, Nuclei can verify the user's existence across all websites listed in the templates and report any instances of success. ## Usage The templates within the `u` directory are **self-contained** and do NOT require URLs as input because the OSINT templates have pre-defined static URLs. Each template in this directory expects the user(name), email, or phone number or list of it to be supplied as input using the `V`/`var` flag through the Nuclei engine. ```bash # Running OSINT templates against a single user to test nuclei -tags osint -var user=elon ``` **OSINT** templates can be also ran against list of usernames as well. ```console $ cat user_names.txt user_1 user_2 user_3 user_4 user_5 ``` ```bash # Running OSINT templates against a list of users to test nuclei -tags osint -var user=user_names.txt ``` ### Categories The OSINT templates are classified into categories such as `archived`, `art`, `blog`, `business`, `coding`, `dating`, `finance`, `gaming`, `health`, `hobby`, `images`, `misc`, `music`, `news`, `political`, `search`, `shopping`, `social`, `tech`, `video`, `porn`. To execute OSINT templates within a particular category, you can apply a filter using the `tags` flag and set the prefix value to `osint-`. ```bash # Running OSINT templates against the social category nuclei -t osint/ -tags osint-social -var user=some-user # Running OSINT templates against the multiple categories nuclei -t osint/ -tags osint-social,osint-finance -var user=some-user ``` ## Acknowledgment These OSINT templates were inspired by the [WebBreacher/WhatsMyName](https://github.com/WebBreacher/WhatsMyName) repository. --- ## File: http/osint/README.md ## Description Nuclei-templates provide a comprehensive suite of security checks, including OSINT templates in this directory for user-enumeration and phishing templates for the identification and analysis of phishing sites. The **User Enumeration templates** are tailored for user enumeration across various websites, allowing Nuclei to verify user existence. They expect input such as username, email, or phone number through the `V`/`var` flag. The **Phishing templates** are crafted for detecting and analyzing phishing sites. These templates are essential for OSINT analysts, threat researchers, and security professionals to uncover and study phishing campaigns. ## Usage These templates are specifically added to help OSINT analysts, threat researchers therefore, we have added them to the OSINT scan profile [here](https://github.com/projectdiscovery/nuclei-templates/blob/main/config/osint.yml). Users can execute the OSINT scan configuration profile with the following command: ```console nuclei -u -config ~/nuclei-templates/config/osint.yml ``` --- ## File: http/credential-stuffing/README.md ## Credential Stuffing Templates This directory contains a collection of credential stuffing templates for both cloud and self-hosted services. These templates help automate the detection and prevention of credential stuffing attempts on your organization's websites and applications using the Nuclei vulnerability scanner. ### Types of Templates - **Cloud Services**: Templates for credential stuffing testing on cloud service providers. - **Self-Hosted Services**: Templates for credential stuffing testing on self-hosted software instances that often have custom hosting environments. ### Usage #### Cloud Services Template An example of using a cloud service credential stuffing template can be seen with the Datadog Login Check template: ```bash nuclei -var username=testing@projectdiscovery.io -var password=test123 -id datadog-login-check ``` Here, the `-var` option supplies the necessary inputs (username/email and password) to the template. #### Self-Hosted Services Template An example of using a self-hosted service credential stuffing template can be seen with the Jira Login Check template: ```bash nuclei -u https://jira.projectdiscovery.io/ -id jira-login-check -var username=testing@projectdiscovery.io -var password=test123 ``` In this case, you also need to provide the hostname/IP of the deployed instance using the `-u` or `--url` option along with the necessary credentials using the `-var` option. ### Attack Types By default, Nuclei uses Pitchfork mode in which it takes the first line from `email.txt` as the username input and the first line from `pass.txt` as the password parameter input. Ensure that both `email.txt` and `pass.txt` have an equal number of entries, with email/password combinations aligned on the same line in both files. Starting with Nuclei 2.8, you can override the default behavior using the `-at` or `-attack-type` CLI option. Specifying the attack-type option as `clusterbomb` enables convenient verification of weak credentials for a list of given email addresses across various services. For example, assuming `email.txt` contains: ``` email1@example.com email2@example.com email3@example.com ``` And `pass.txt` contains: ``` password1 password2 password3 ``` The command below will check credential validity by sequentially testing each email from `email.txt` with all entries in `pass.txt` across different hosts stored in `jira.txt`: ```bash cat jira.txt | nuclei -var username=email.txt -var password=pass.txt -id jira-login-check -attack-type clusterbomb ``` Developing custom target-specific templates for internal/custom portals can yield even more comprehensive results. ### Contributing and Updating Templates Help us improve the credential stuffing templates by contributing new templates, reporting bugs, or requesting new features. Contributions are most welcome! Fix issues, add new templates, and update existing ones by submitting a pull request. Always adhere to the best practices for YAML syntax and ensure that your template is tested before submitting. Please refer to the template documentation to learn more about writing and submitting new templates to this repository: https://docs.projectdiscovery.io/templates/introduction --- ## File: profiles/README.md ## About This directory hosts Nuclei configuration profiles specifically designed for various use cases, including Bug Bounty, OSINT, and Compliance. The centerpiece of these configurations is the `recommended.yml` file, which offers a handpicked selection of templates that are both efficient and relevant for the majority of scanning scenarios. This curated approach is intended to provide a more focused scanning experience, reducing the occurrence of irrelevant results that often accompany broader scans. ## Usage The Nuclei configuration profiles are straightforward to integrate into your existing scanning workflows. Below are guidelines on how to utilize the `recommended.yml` configuration for a streamlined scanning process, as well as instructions for customizing your scans to fit specific needs. ### Using the Recommended Configuration To execute a scan with the `recommended.yml` configuration, which has been optimized for general use to yield efficient and relevant results, use the following command: ``` nuclei -config ~/nuclei-templates/profiles/recommended.yml ``` ## Customizing Your Scanning Configuration If you have specific requirements or wish to modify the focus of your scans, you can create a custom configuration file based on the structure of recommended.yml. Adjust the template selections to fit your targeted scanning objectives. Once your configuration is set, run Nuclei using your custom file with the command: ``` nuclei -config your-custom-config.yml ``` ## Examples Here are examples of how to run scans for specific scenarios: #### Running Local Privilege Escalation Checks For targeting local privilege escalation vulnerabilities, utilize the dedicated config as follows: ``` nuclei -config ~/nuclei-templates/profiles/privilege-escalation.yml ``` #### Config Focusing on OSINT ``` nuclei -config ~/nuclei-templates/profiles/osint.yml ``` --- ## File: README_CN.md

Nuclei 模板

这个仓库用于存放由社区精心挑选的模板,可以使用nuclei引擎结合模板发现应用中的漏洞。

---- 模板是 [nuclei 扫描器](https://github.com/projectdiscovery/nuclei) 的核心. 这个git仓库储存了由PD团队以及社区贡献的各种扫描模板. 我们希望您也能攻通过 **pull requests** 或者[Github issues](https://github.com/projectdiscovery/nuclei-templates/issues/new?assignees=&labels=&template=submit-template.md&title=%5Bnuclei-template%5D+)来提交模板以扩大我们的仓库列表. ## Nuclei模板项目情况概述 以下是nuclei模板项目的情况概览,包括唯一标签,作者,目录,严重性,模板类型的相关统计情况.以下表格列出了前面提到的每项情况的TOP10信息;你也可以点击[这里](TEMPLATES-STATS.md)查看详细信息.当然你也可以点击[这里](TEMPLATES-STATS.json)获取JSON格式的详细情况统计 | ### 🚨 已知被利用漏洞 (KEV) 覆盖范围 Nuclei 模板为野外被积极利用的漏洞提供覆盖: **KEV 来源** **模板数量** **描述** ---------------- --------------- ----------------- 🔴 **CISA KEV** **454** [CISA 已知被利用漏洞目录](https://www.cisa.gov/known-exploited-vulnerabilities-catalog) 🟠 **VulnCheck KEV** **1449** [VulnCheck KEV](https://vulncheck.com/kev) - 增强的漏洞情报 🟢 **两个来源** **407** 覆盖两个目录中漏洞的模板 > 💡 **唯一 KEV 模板总数: 1496** - 使用 `nuclei -tags kev,vkev` 扫描被积极利用的漏洞 --- ## Nuclei Templates Top 10 statistics TAG COUNT AUTHOR COUNT DIRECTORY COUNT SEVERITY COUNT TYPE COUNT ----------- ------- --------------- ------- ------------ ------- ---------- ------- ------ ------- vuln 6468 dhiyaneshdk 1894 http 9281 info 4353 file 436 cve 3587 daffainfo 905 cloud 659 high 2552 dns 26 discovery 3265 princechaddha 854 file 436 medium 2457 vkev 1394 dwisiswant0 805 network 259 critical 1555 panel 1365 ritikchaddha 678 code 251 low 330 xss 1269 pussycat0x 675 dast 240 unknown 54 wordpress 1261 pikpikcu 353 workflows 205 exposure 1141 pdteam 314 javascript 92 wp-plugin 1103 pdresearch 275 ssl 38 osint 848 iamnoooob 263 dns 23 **873 directories, 11997 files**. | | --- | 📖 文档 ----- 详细的文档请访问我们的网站[https://nuclei.projectdiscovery.io](https://nuclei.projectdiscovery.io),在我们网站的详细文档中,我们提供了如何创建模板的具体方法,并且也提供了相应的示例模板来帮助您更好地理解模板的开发以及运行原理. 💪 贡献 ----- 社区是Nuclei模板项目的主要贡献主力,我们非常欢迎开发者们来贡献模板,提出需求和报告Bug. 💬 交流 ----- 如果您有任何关于该项目的疑问或是新奇的点子,欢迎在[Github discussions](https://github.com/projectdiscovery/nuclei-templates/discussions)创建新的板块来进行讨论. 👨‍💻 社区 ----- 欢迎您加入我们的[Discord 社区](https://discord.gg/projectdiscovery)，与项目维护人员直接讨论，或与其他人分享有关安全和自动化的想法。 此外，您还可以在 [Twitter](https://twitter.com/pdnuclei) 上关注我们，了解 Nuclei 的最新动态。 最后,感谢您对这个项目的贡献,这将让我们的社区更加充满活力. --- ## File: README_JA.md

Nuclei テンプレート

アプリケーションのセキュリティ脆弱性を発見するためのNucleiエンジン用テンプレートのコミュニティキュレーションリスト

---- テンプレートは、実際のスキャンエンジンを動作させる[nucleiスキャナー](https://github.com/projectdiscovery/nuclei)のコアです。 このリポジトリは、私たちのチームが提供するテンプレートや、コミュニティからの貢献によるさまざまなテンプレートを保存・管理します。 テンプレートのリストを増やすために、**プルリクエスト**や[Github issues](https://github.com/projectdiscovery/nuclei-templates/issues/new?assignees=&labels=&template=submit-template.md&title=%5Bnuclei-template%5D+)を通じて貢献していただけると幸いです。 ## Nuclei テンプレートの概要 Nucleiテンプレートプロジェクトの概要であり、ユニークなタグ、著者、ディレクトリ、重大度、テンプレートの種類に関する統計を含みます。以下の表は、各マトリックスのトップ10の統計を示しています。拡張バージョンは[こちら](TEMPLATES-STATS.md)で確認でき、[JSON](TEMPLATES-STATS.json)形式でも利用可能です。 | ### 🚨 既知の悪用される脆弱性 (KEV) カバレッジ Nucleiテンプレートは、野生で積極的に悪用されている脆弱性のカバレッジを提供します: **KEV ソース** **テンプレート数** **説明** ---------------- --------------- ----------------- 🔴 **CISA KEV** **454** [CISA 既知の悪用される脆弱性カタログ](https://www.cisa.gov/known-exploited-vulnerabilities-catalog) 🟠 **VulnCheck KEV** **1449** [VulnCheck KEV](https://vulncheck.com/kev) - 強化された脆弱性インテリジェンス 🟢 **両方のソース** **407** 両方のカタログの脆弱性をカバーするテンプレート > 💡 **ユニークKEVテンプレート総数: 1496** - `nuclei -tags kev,vkev` を使用して積極的に悪用されている脆弱性をスキャン --- ## Nuclei Templates Top 10 statistics TAG COUNT AUTHOR COUNT DIRECTORY COUNT SEVERITY COUNT TYPE COUNT ----------- ------- --------------- ------- ------------ ------- ---------- ------- ------ ------- vuln 6468 dhiyaneshdk 1894 http 9281 info 4353 file 436 cve 3587 daffainfo 905 cloud 659 high 2552 dns 26 discovery 3265 princechaddha 854 file 436 medium 2457 vkev 1394 dwisiswant0 805 network 259 critical 1555 panel 1365 ritikchaddha 678 code 251 low 330 xss 1269 pussycat0x 675 dast 240 unknown 54 wordpress 1261 pikpikcu 353 workflows 205 exposure 1141 pdteam 314 javascript 92 wp-plugin 1103 pdresearch 275 ssl 38 osint 848 iamnoooob 263 dns 23 **873 directories, 11997 files**. | | --- | 📖 ドキュメント ----- 新しいテンプレートやカスタムテンプレートを作成するための詳細なドキュメントは、https://nuclei.projectdiscovery.io で確認できます。作業方法を理解するためのテンプレートも用意しています。 💪 貢献 ----- Nucleiテンプレートはコミュニティの貢献によって動作します。 [テンプレートの貢献](https://github.com/projectdiscovery/nuclei-templates/issues/new?assignees=&labels=&template=submit-template.md&title=%5Bnuclei-template%5D+)、[機能リクエスト](https://github.com/projectdiscovery/nuclei-templates/issues/new?assignees=&labels=&template=feature_request.md&title=%5BFeature%5D+)、[バグ報告](https://github.com/projectdiscovery/nuclei-templates/issues/new?assignees=&labels=&template=bug_report.md&title=%5BBug%5D+)はいつでも歓迎します。 💬 ディスカッション ----- 質問、疑問、アイデアを話し合いたいですか？ [Github discussions](https://github.com/projectdiscovery/nuclei-templates/discussions)で自由に始めることができます。 👨‍💻 コミュニティ ----- プロジェクトの管理者と直接話し合い、セキュリティや自動化に関することを他の人と共有するために、[Discord Community](https://discord.gg/projectdiscovery)に参加することを歓迎します。さらに、Nucleiに関するすべての情報を更新するために、[Twitter](https://twitter.com/pdnuclei)をフォローすることもできます。 皆さんの貢献とコミュニティの活性化への努力に感謝します。 :heart: --- ## File: README_KR.md

Nuclei 템플릿

커뮤니티에서 엄선한, 애플리케이션 보안 취약점을 찾기 위한 Nuclei 엔진용 템플릿 목록

---- 템플릿은 실제 스캐닝 엔진을 동작하게 하는 [nuclei scanner](https://github.com/projectdiscovery/nuclei)의 핵심입니다. 이 저장소는 우리 팀에서 제공하거나, 커뮤니티에서 기여한 다양한 템플릿들을 저장하고 보관합니다. 템플릿 목록을 증가시키기 위해서 **pull requests** 나 [Github issues](https://github.com/projectdiscovery/nuclei-templates/issues/new?assignees=&labels=&template=submit-template.md&title=%5Bnuclei-template%5D+) 를 통해 기여해주시기를 부탁드립니다. ## Nuclei 템플릿 개요 고유 태그, 작성자, 디렉토리, 심각도, 템플릿 종류에 대한 통계를 포함하고 있는 nuclei 템플릿의 개요입니다. 아래 표는 각 지표의 상위 10개 항목을 나타내고 있습니다. 더 자세한 정보는 [이곳](TEMPLATES-STATS.md)에서 확인 가능하고, [JSON](TEMPLATES-STATS.json) 형식으로도 확인 가능합니다. | ### 🚨 알려진 악용되는 취약점 (KEV) 적용 범위 Nuclei 템플릿은 실제로 악용되고 있는 취약점에 대한 적용 범위를 제공합니다: **KEV 소스** **템플릿 수** **설명** ---------------- --------------- ----------------- 🔴 **CISA KEV** **454** [CISA 알려진 악용되는 취약점 카탈로그](https://www.cisa.gov/known-exploited-vulnerabilities-catalog) 🟠 **VulnCheck KEV** **1449** [VulnCheck KEV](https://vulncheck.com/kev) - 강화된 취약점 인텔리전스 🟢 **두 소스 모두** **407** 두 카탈로그의 취약점을 포함하는 템플릿 > 💡 **총 고유 KEV 템플릿: 1496** - `nuclei -tags kev,vkev`를 사용하여 적극적으로 악용되는 취약점 스캔 --- ## Nuclei Templates Top 10 statistics TAG COUNT AUTHOR COUNT DIRECTORY COUNT SEVERITY COUNT TYPE COUNT ----------- ------- --------------- ------- ------------ ------- ---------- ------- ------ ------- vuln 6468 dhiyaneshdk 1894 http 9281 info 4353 file 436 cve 3587 daffainfo 905 cloud 659 high 2552 dns 26 discovery 3265 princechaddha 854 file 436 medium 2457 vkev 1394 dwisiswant0 805 network 259 critical 1555 panel 1365 ritikchaddha 678 code 251 low 330 xss 1269 pussycat0x 675 dast 240 unknown 54 wordpress 1261 pikpikcu 353 workflows 205 exposure 1141 pdteam 314 javascript 92 wp-plugin 1103 pdresearch 275 ssl 38 osint 848 iamnoooob 263 dns 23 **873 directories, 11997 files**. | | --- | 📖 문서 ----- 새 템플릿이나 사용자 정의 템플릿을 빌드하기 위한 자세한 문서는 https://nuclei.projectdiscovery.io 에서 확인할 수 있습니다. 작업 방식의 이해를 돕기 위한 템플릿들도 있습니다. 💪 기여 ----- Nuclei 템플릿은 커뮤니티의 기여로 동작합니다. [템플릿 기여](https://github.com/projectdiscovery/nuclei-templates/issues/new?assignees=&labels=&template=submit-template.md&title=%5Bnuclei-template%5D+), [기능 요청](https://github.com/projectdiscovery/nuclei-templates/issues/new?assignees=&labels=&template=feature_request.md&title=%5BFeature%5D+), [버그 제보](https://github.com/projectdiscovery/nuclei-templates/issues/new?assignees=&labels=&template=bug_report.md&title=%5BBug%5D+)는 언제든지 환영합니다. 💬 논의 ----- 같이 이야기하고 싶은 질문, 의문 혹은 아이디어가 있으신가요? [Github discussions](https://github.com/projectdiscovery/nuclei-templates/discussions) 에서 자유롭게 시작할 수 있습니다. 👨‍💻 커뮤니티 ----- 프로젝트 관리자와 직접 논의하고 보안과 자동화 관련 사항을 다른 사람과 공유하기 위해 [Discord Community](https://discord.gg/projectdiscovery) 에 참여하는 것을 환영합니다. 추가로 Nuclei 에 대한 모든 정보를 업데이트 하기 위해 [트위터](https://twitter.com/pdnuclei) 팔로우를 할 수 있습니다. 여러분의 기여와 커뮤니티의 활성화를 위한 노력에 다시한번 감사드립니다. :heart: ## 2. Official Technical Reference & Guides (projectdiscovery/docs) ## File: README.md # ProjectDiscovery Documentation

This is the source code for the ProjectDiscovery documentation located at https://docs.projectdiscovery.io

--- ## Development 1. Checkout this repository 1. Install mintlify with `npm i mintlify@latest` 1. Run `mintlify dev` ## Deploying To build the final product, we have a couple of additional steps: 1. Build the JS Protocol Docs - `npm install jsdoc-to-markdown` - `./bin/jsdocs.sh` 2. Build the PDCP API reference documentation - Either download the latest `openapi.yaml` manually or run `./bin/download-api.sh` - Run `./bin/generate-api.sh` to generate any new API files - **OR** run `./bin/generate-filtered-api.sh` to generate API docs without internal/admin endpoints 3. Deployment After those, Mintlify handles the deployment automatically. --- ## File: bin/README-auto-grouped-api.md # Auto-Grouped API Documentation Generator This script **automatically generates and maintains** API documentation with logical grouping based on OpenAPI tags. It combines the best of both worlds: auto-generation (no missing endpoints) and logical organization. ## Usage ```bash # Use default source file (Downloads directory) ./bin/generate-auto-grouped-api.sh # Use custom source file ./bin/generate-auto-grouped-api.sh /path/to/your/openapi.yaml ``` ## What it does ### 🤖 **Auto-Generation** - Reads OpenAPI specification - Filters out admin and internal APIs - Generates MDX files for all public endpoints - **Never misses endpoints** - everything is included automatically ### 📁 **Logical Grouping** The script organizes endpoints into logical groups based on OpenAPI tags: - **Assets** → `assets` + `enumerations` tags - **Templates** → `templates` + `template/v2` tags - **Scans** → `scans` tag - **Results** → `results` + `retests` tags - **Configurations** → `configurations` tag - **Users** → `users` + `user` tags - **Logs** → `elog` + `scan_log` tags - **Export** → `export` tag - **Automations** → `automations` tag - **Integration** → `oauth` tag - **Utilities** → `chaos`, `vulns`, `leaks`, `billing`, `usage` tags ### 🔄 **Auto-Updates Navigation** - Automatically updates `mint.json` with new structure - Maintains logical grouping - Sorts endpoints alphabetically within groups - Handles new endpoints automatically ## Benefits ✅ **No Manual Maintenance** - Add new endpoints to OpenAPI spec and they appear automatically ✅ **Never Miss Endpoints** - All public endpoints are included ✅ **Logical Organization** - Grouped by functionality, not alphabetically ✅ **Consistent Naming** - Uses OpenAPI summaries and operation IDs ✅ **Future-Proof** - Works with any OpenAPI specification changes ## Output Structure After running, your `mint.json` will have clean navigation like: ```json { "group": "API Reference", "pages": [ "api-reference/introduction", { "group": "Assets", "pages": [ "api-reference/assets/get-asset-list", "api-reference/assets/upload-asset", "api-reference/enumerations/create-enumeration", "..." ] }, { "group": "Templates", "pages": [ "api-reference/templates/create-template", "api-reference/templates/get-template-list", "..." ] } ] } ``` ## Comparison with Manual Approach | Feature | Manual (`generate-filtered-api.sh`) | Auto-Grouped (`generate-auto-grouped-api.sh`) | |---------|--------------------------------------|-----------------------------------------------| | **Missing Endpoints** | ❌ Requires manual addition to `mint.json` | ✅ Never - all endpoints auto-included | | **Logical Grouping** | ✅ Full manual control | ✅ Smart tag-based grouping | | **Maintenance** | ❌ High - update `mint.json` for new endpoints | ✅ Zero - fully automated | | **Consistency** | ❌ Depends on manual updates | ✅ Always consistent | | **New API Versions** | ❌ Manual review and updates needed | ✅ Automatically handles changes | ## When to Use **Use Auto-Grouped when:** - You want zero maintenance overhead - You frequently add/remove API endpoints - You have a team that might forget to update navigation - You want consistent organization based on API design **Use Manual when:** - You need very specific custom grouping that doesn't match tags - You want to exclude certain public endpoints from docs - You have complex navigation requirements ## Next Steps After running this script: 1. **Preview:** `mintlify dev` 2. **Deploy:** Your CI/CD can run this script automatically when OpenAPI changes 3. **Customize:** Modify the `logicalGroups` mapping in the script if needed --- ## File: bin/README-filtered-api.md # Filtered API Documentation Generator This script generates API documentation from an OpenAPI specification while excluding internal and admin endpoints. ## Usage ```bash # Use default source file (Downloads directory) ./bin/generate-filtered-api.sh # Use custom source file ./bin/generate-filtered-api.sh /path/to/your/openapi.yaml ``` **Note:** The script will create a filtered `openapi.yaml` file in the current directory for Mintlify to use. ## What gets filtered out The script automatically excludes: 1. **Admin APIs**: All paths starting with `/v1/admin/` - Examples: `/v1/admin/user/search`, `/v1/admin/team/change_owner` 2. **Internal APIs**: Endpoints tagged with `internal` - Any endpoint with `"internal"` in its tags array ## Output - Creates filtered API documentation in the `api-reference/` directory - Removes existing `internal/` and `admin/` folders before regenerating - Uses Mintlify scraping to generate MDX files for each endpoint - Provides detailed console output showing what was filtered ## Requirements - Node.js and npm/npx - Internet connection (to download @mintlify/scraping package) - Valid OpenAPI 3.x specification file ## Integration with existing workflow You can replace the existing `./bin/generate-api.sh` call in your build process with: ```bash # Old way (includes internal/admin APIs) ./bin/generate-api.sh # New way (excludes internal/admin APIs) ./bin/generate-filtered-api.sh ``` ## Troubleshooting If you encounter errors: 1. **"OpenAPI source file not found"**: Ensure the file path is correct 2. **"Node.js is required"**: Install Node.js from https://nodejs.org 3. **Network errors**: Check internet connection for npm package downloads 4. **Permission errors**: Ensure the script is executable (`chmod +x bin/generate-filtered-api.sh`)