github.com/khulnasoft/trivy@v0.48.1-0.20231207234930-27df843a75e0/mkdocs.yml (about)

     1  site_name: Trivy
     2  site_url: https://khulnasoft.github.io/trivy/
     3  site_description: A Simple and Comprehensive Vulnerability Scanner for Containers and other Artifacts, Suitable for CI
     4  docs_dir: docs/
     5  repo_name: GitHub
     6  repo_url: https://github.com/khulnasoft/trivy
     7  edit_uri: "blob/main/docs/"
     8  
     9  nav:
    10    - Getting Started: 
    11        - Overview: index.md
    12        - Installation: getting-started/installation.md
    13        - Signature Verification: getting-started/signature-verification.md
    14        - FAQ: getting-started/faq.md
    15    - Tutorials:
    16        - Overview: tutorials/overview.md   
    17        - CI/CD:
    18            - Overview: tutorials/integrations/index.md
    19            - GitHub Actions: tutorials/integrations/github-actions.md
    20            - CircleCI: tutorials/integrations/circleci.md
    21            - Travis CI: tutorials/integrations/travis-ci.md
    22            - GitLab CI: tutorials/integrations/gitlab-ci.md
    23            - Bitbucket Pipelines: tutorials/integrations/bitbucket.md
    24            - AWS CodePipeline: tutorials/integrations/aws-codepipeline.md
    25            - AWS Security Hub: tutorials/integrations/aws-security-hub.md
    26            - Azure: tutorials/integrations/azure-devops.md
    27        - Kubernetes:
    28            - Cluster Scanning: tutorials/kubernetes/cluster-scanning.md
    29            - Kyverno: tutorials/kubernetes/kyverno.md
    30            - GitOps: tutorials/kubernetes/gitops.md
    31        - Misconfiguration:
    32            - Terraform scanning: tutorials/misconfiguration/terraform.md
    33        - Signing:
    34            - Vulnerability Scan Record Attestation: tutorials/signing/vuln-attestation.md
    35        - Shell:
    36            - Completion: tutorials/shell/shell-completion.md
    37        - Additional Resources:
    38            - Additional Resources: tutorials/additional-resources/references.md
    39            - Community References: tutorials/additional-resources/community.md
    40            - CKS Reference: tutorials/additional-resources/cks.md
    41    - Docs:
    42        - Overview: docs/index.md
    43        - Target:
    44            - Container Image: docs/target/container_image.md
    45            - Filesystem: docs/target/filesystem.md
    46            - Rootfs: docs/target/rootfs.md
    47            - Code Repository: docs/target/repository.md
    48            - Virtual Machine Image: docs/target/vm.md
    49            - Kubernetes: docs/target/kubernetes.md
    50            - AWS: docs/target/aws.md
    51            - SBOM: docs/target/sbom.md
    52        - Scanner:
    53            - Vulnerability: docs/scanner/vulnerability.md
    54            - Misconfiguration:
    55                - Overview: docs/scanner/misconfiguration/index.md
    56                - Policy:
    57                    - Built-in Policies: docs/scanner/misconfiguration/policy/builtin.md
    58                    - Exceptions: docs/scanner/misconfiguration/policy/exceptions.md
    59                - Custom Policies:
    60                    - Overview: docs/scanner/misconfiguration/custom/index.md
    61                    - Data: docs/scanner/misconfiguration/custom/data.md
    62                    - Combine: docs/scanner/misconfiguration/custom/combine.md
    63                    - Selectors: docs/scanner/misconfiguration/custom/selectors.md
    64                    - Schemas: docs/scanner/misconfiguration/custom/schema.md
    65                    - Testing: docs/scanner/misconfiguration/custom/testing.md
    66                    - Debugging Policies: docs/scanner/misconfiguration/custom/debug.md
    67            - Secret: docs/scanner/secret.md
    68            - License: docs/scanner/license.md
    69        - Coverage:
    70            - Overview: docs/coverage/index.md
    71            - OS:
    72                - Overview: docs/coverage/os/index.md
    73                - AlmaLinux: docs/coverage/os/alma.md
    74                - Alpine Linux: docs/coverage/os/alpine.md
    75                - Amazon Linux: docs/coverage/os/amazon.md
    76                - CBL-Mariner: docs/coverage/os/cbl-mariner.md
    77                - CentOS: docs/coverage/os/centos.md
    78                - Chainguard: docs/coverage/os/chainguard.md
    79                - Debian: docs/coverage/os/debian.md
    80                - Oracle Linux: docs/coverage/os/oracle.md
    81                - Photon OS: docs/coverage/os/photon.md
    82                - Red Hat: docs/coverage/os/rhel.md
    83                - Rocky Linux: docs/coverage/os/rocky.md
    84                - SUSE: docs/coverage/os/suse.md
    85                - Ubuntu: docs/coverage/os/ubuntu.md
    86                - Wolfi: docs/coverage/os/wolfi.md
    87                - Google Distroless (Images): docs/coverage/os/google-distroless.md
    88                - Bitnami (Images): docs/coverage/os/bitnami.md
    89            - Language:
    90                - Overview: docs/coverage/language/index.md
    91                - C/C++: docs/coverage/language/c.md
    92                - Dart: docs/coverage/language/dart.md
    93                - .NET: docs/coverage/language/dotnet.md
    94                - Elixir: docs/coverage/language/elixir.md
    95                - Go: docs/coverage/language/golang.md
    96                - Java: docs/coverage/language/java.md
    97                - Node.js: docs/coverage/language/nodejs.md
    98                - PHP: docs/coverage/language/php.md
    99                - Python: docs/coverage/language/python.md
   100                - Ruby: docs/coverage/language/ruby.md
   101                - Rust: docs/coverage/language/rust.md
   102                - Swift: docs/coverage/language/swift.md
   103            - IaC:
   104                - Overview: docs/coverage/iac/index.md
   105                - Azure ARM Template: docs/coverage/iac/azure-arm.md
   106                - CloudFormation: docs/coverage/iac/cloudformation.md
   107                - Docker: docs/coverage/iac/docker.md
   108                - Helm: docs/coverage/iac/helm.md
   109                - Kubernetes: docs/coverage/iac/kubernetes.md
   110                - Terraform: docs/coverage/iac/terraform.md
   111            - Kubernetes: docs/coverage/kubernetes.md
   112        - Configuration:
   113            - Overview: docs/configuration/index.md
   114            - Filtering: docs/configuration/filtering.md
   115            - Skipping Files: docs/configuration/skipping.md
   116            - Reporting: docs/configuration/reporting.md
   117            - Cache: docs/configuration/cache.md
   118            - DB: docs/configuration/db.md
   119            - Others: docs/configuration/others.md
   120        - Supply Chain:
   121            - SBOM: docs/supply-chain/sbom.md
   122            - Attestation:
   123                  - SBOM: docs/supply-chain/attestation/sbom.md
   124                  - Cosign Vulnerability Scan Record: docs/supply-chain/attestation/vuln.md
   125                  - SBOM Attestation in Rekor: docs/supply-chain/attestation/rekor.md
   126            - VEX: docs/supply-chain/vex.md
   127        - Compliance:
   128            - Reports:  docs/compliance/compliance.md
   129        - Advanced:
   130            - Modules: docs/advanced/modules.md
   131            - Plugins: docs/advanced/plugins.md
   132            - Air-Gapped Environment: docs/advanced/air-gap.md
   133            - Container Image:
   134                - Embed in Dockerfile: docs/advanced/container/embed-in-dockerfile.md
   135                - Unpacked container image filesystem: docs/advanced/container/unpacked-filesystem.md
   136                - Private Docker Registries:
   137                    - Overview: docs/advanced/private-registries/index.md
   138                    - Docker Hub: docs/advanced/private-registries/docker-hub.md
   139                    - AWS ECR (Elastic Container Registry): docs/advanced/private-registries/ecr.md
   140                    - GCR (Google Container Registry): docs/advanced/private-registries/gcr.md
   141                    - ACR (Azure Container Registry): docs/advanced/private-registries/acr.md
   142                    - Self-Hosted: docs/advanced/private-registries/self.md
   143        - References:
   144            - Configuration:
   145                - CLI:
   146                    - Overview: docs/references/configuration/cli/trivy.md
   147                    - AWS: docs/references/configuration/cli/trivy_aws.md
   148                    - Config: docs/references/configuration/cli/trivy_config.md
   149                    - Convert: docs/references/configuration/cli/trivy_convert.md
   150                    - Filesystem: docs/references/configuration/cli/trivy_filesystem.md
   151                    - Image: docs/references/configuration/cli/trivy_image.md
   152                    - Kubernetes: docs/references/configuration/cli/trivy_kubernetes.md
   153                    - Module: docs/references/configuration/cli/trivy_module.md
   154                    - Module Install: docs/references/configuration/cli/trivy_module_install.md
   155                    - Module Uninstall: docs/references/configuration/cli/trivy_module_uninstall.md
   156                    - Plugin: docs/references/configuration/cli/trivy_plugin.md
   157                    - Plugin Info: docs/references/configuration/cli/trivy_plugin_info.md
   158                    - Plugin Install: docs/references/configuration/cli/trivy_plugin_install.md
   159                    - Plugin List: docs/references/configuration/cli/trivy_plugin_list.md
   160                    - Plugin Run: docs/references/configuration/cli/trivy_plugin_run.md
   161                    - Plugin Uninstall: docs/references/configuration/cli/trivy_plugin_uninstall.md
   162                    - Plugin Update: docs/references/configuration/cli/trivy_plugin_update.md
   163                    - Repository: docs/references/configuration/cli/trivy_repository.md
   164                    - Rootfs: docs/references/configuration/cli/trivy_rootfs.md
   165                    - SBOM: docs/references/configuration/cli/trivy_sbom.md
   166                    - Server: docs/references/configuration/cli/trivy_server.md
   167                    - Version: docs/references/configuration/cli/trivy_version.md
   168                    - VM: docs/references/configuration/cli/trivy_vm.md
   169                - Config file: docs/references/configuration/config-file.md
   170            - Modes:
   171                - Standalone: docs/references/modes/standalone.md
   172                - Client/Server: docs/references/modes/client-server.md
   173            - Troubleshooting: docs/references/troubleshooting.md
   174    - Ecosystem: 
   175      - Overview: ecosystem/index.md
   176      - CI/CD: ecosystem/cicd.md
   177      - IDE and Dev tools: ecosystem/ide.md
   178      - Production and Clouds: ecosystem/prod.md
   179      - Security Management: ecosystem/security.md
   180    - Contributing:
   181        - How to contribute:
   182            - Issues: community/contribute/issue.md
   183            - Discussions: community/contribute/discussion.md
   184            - Pull Requests: community/contribute/pr.md
   185        - Maintainer:
   186            - Help Wanted: community/maintainer/help-wanted.md
   187            - Triage: community/maintainer/triage.md
   188  theme:
   189    name: material
   190    custom_dir: docs/overrides
   191    language: "en"
   192    logo: imgs/logo-white.svg
   193    features:
   194      - navigation.tabs
   195      - navigation.tabs.sticky
   196      - navigation.sections
   197      - navigation.footer
   198      - content.action.edit
   199      - content.tabs.link
   200      - content.code.annotate
   201      - content.code.copy
   202  
   203  markdown_extensions:
   204    - pymdownx.highlight
   205    - pymdownx.superfences
   206    - admonition
   207    - footnotes
   208    - attr_list
   209    - pymdownx.tabbed:
   210        alternate_style: true
   211    - def_list
   212    - pymdownx.details
   213    - pymdownx.emoji:
   214        emoji_index: !!python/name:materialx.emoji.twemoji
   215        emoji_generator: !!python/name:materialx.emoji.to_svg
   216  
   217  extra:
   218    generator: false
   219    version:
   220      method: mike
   221      provider: mike
   222      default: latest
   223    social:
   224      - icon: fontawesome/brands/twitter
   225        link: https://twitter.com/KhulnasoftTrivy
   226      - icon: fontawesome/brands/github
   227        link: https://github.com/khulnasoft/trivy
   228      - icon: fontawesome/brands/slack
   229        link: https://github.com/khulnasoft/trivy
   230  
   231  plugins:
   232    - search
   233    - macros
   234