forked from mirrors/kingfisher
132 lines
3.5 KiB
YAML
132 lines
3.5 KiB
YAML
site_name: Kingfisher
|
|
site_url: https://mongodb.github.io/kingfisher
|
|
site_description: >-
|
|
Open source secret scanner with live validation. 954 detection rules,
|
|
blast radius mapping, credential revocation, and a browser-based
|
|
report viewer that also imports Gitleaks and TruffleHog output.
|
|
Built in Rust by MongoDB.
|
|
site_author: MongoDB
|
|
repo_url: https://github.com/mongodb/kingfisher
|
|
repo_name: mongodb/kingfisher
|
|
|
|
copyright: Copyright © 2024-2026 MongoDB, Inc.
|
|
|
|
theme:
|
|
name: material
|
|
custom_dir: overrides
|
|
logo: assets/images/kingfisher_logo.png
|
|
favicon: assets/images/kingfisher_logo.png
|
|
palette:
|
|
- scheme: default
|
|
primary: teal
|
|
accent: teal
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
- scheme: slate
|
|
primary: teal
|
|
accent: teal
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to light mode
|
|
features:
|
|
- navigation.instant
|
|
- navigation.tracking
|
|
- navigation.tabs
|
|
- navigation.tabs.sticky
|
|
- navigation.sections
|
|
- navigation.top
|
|
- search.suggest
|
|
- search.highlight
|
|
- content.code.copy
|
|
- content.tabs.link
|
|
- toc.follow
|
|
icon:
|
|
repo: fontawesome/brands/github
|
|
|
|
plugins:
|
|
- search
|
|
- blog:
|
|
blog_dir: blog
|
|
post_date_format: long
|
|
post_url_format: "{date}/{slug}"
|
|
post_excerpt: required
|
|
archive: true
|
|
categories: true
|
|
pagination_per_page: 10
|
|
authors: false
|
|
- rss:
|
|
match_path: blog/posts/.*
|
|
date_from_meta:
|
|
as_creation: date
|
|
categories:
|
|
- categories
|
|
- tags
|
|
- minify:
|
|
minify_html: true
|
|
|
|
markdown_extensions:
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- pymdownx.details
|
|
- pymdownx.snippets
|
|
- admonition
|
|
- attr_list
|
|
- md_in_html
|
|
- tables
|
|
- toc:
|
|
permalink: true
|
|
- def_list
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Getting Started:
|
|
- Installation: getting-started/installation.md
|
|
- Quick Start: getting-started/quick-start.md
|
|
- Usage:
|
|
- Basic Scanning: usage/basic-scanning.md
|
|
- Platform Integrations: usage/integrations.md
|
|
- Project Configuration (kingfisher.yaml): usage/configuration.md
|
|
- Advanced Configuration: usage/advanced.md
|
|
- Baseline Management: usage/baseline.md
|
|
- Deployment: usage/deployment.md
|
|
- Features:
|
|
- Access Map (Blast Radius): features/access-map.md
|
|
- Hosted Report Viewer: features/report-viewer.md
|
|
- Secret Revocation: features/revocation.md
|
|
- Source Code Parsing: features/parsing.md
|
|
- Finding Fingerprints: features/fingerprints.md
|
|
- LLM & Agent Integration: features/agents.md
|
|
- Rules:
|
|
- Built-in Rules List: rules/builtin-rules.md
|
|
- Writing Custom Rules: rules/overview.md
|
|
- Reference:
|
|
- Architecture: reference/architecture.md
|
|
- Rust Library Crates: reference/library.md
|
|
- Python Bindings: reference/python-bindings.md
|
|
- Benchmarks & Comparison: reference/comparison.md
|
|
- Report Viewer: https://mongodb.github.io/kingfisher/viewer/
|
|
- Blog:
|
|
- blog/index.md
|
|
- Changelog: changelog.md
|
|
|
|
extra:
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/mongodb/kingfisher
|
|
|
|
extra_css:
|
|
- assets/stylesheets/extra.css
|
|
|
|
extra_javascript:
|
|
- assets/javascripts/rules-filter.js
|