2021-03-10 01:05:37 +07:00
|
|
|
site_name: Trivy
|
2025-02-26 12:41:46 +02:00
|
|
|
site_url: https://trivy.dev/
|
2024-11-17 23:34:48 -07:00
|
|
|
site_description: Trivy - All-in-one open source security scanner
|
2021-03-10 01:05:37 +07:00
|
|
|
docs_dir: docs/
|
|
|
|
|
repo_name: GitHub
|
|
|
|
|
repo_url: https://github.com/aquasecurity/trivy
|
2023-05-30 10:23:05 +01:00
|
|
|
edit_uri: "blob/main/docs/"
|
2021-03-10 01:05:37 +07:00
|
|
|
|
|
|
|
|
nav:
|
2024-11-17 23:34:48 -07:00
|
|
|
- Home: index.md
|
|
|
|
|
- Getting Started:
|
|
|
|
|
- First steps: getting-started/index.md
|
2021-07-12 03:14:17 +03:00
|
|
|
- Installation: getting-started/installation.md
|
2023-09-12 13:57:40 +07:00
|
|
|
- Signature Verification: getting-started/signature-verification.md
|
2023-03-08 12:23:17 +00:00
|
|
|
- FAQ: getting-started/faq.md
|
2022-09-15 19:27:58 +01:00
|
|
|
- Tutorials:
|
|
|
|
|
- Overview: tutorials/overview.md
|
|
|
|
|
- CI/CD:
|
|
|
|
|
- Overview: tutorials/integrations/index.md
|
|
|
|
|
- GitHub Actions: tutorials/integrations/github-actions.md
|
|
|
|
|
- CircleCI: tutorials/integrations/circleci.md
|
|
|
|
|
- Travis CI: tutorials/integrations/travis-ci.md
|
|
|
|
|
- GitLab CI: tutorials/integrations/gitlab-ci.md
|
|
|
|
|
- Bitbucket Pipelines: tutorials/integrations/bitbucket.md
|
|
|
|
|
- AWS CodePipeline: tutorials/integrations/aws-codepipeline.md
|
|
|
|
|
- AWS Security Hub: tutorials/integrations/aws-security-hub.md
|
|
|
|
|
- Azure: tutorials/integrations/azure-devops.md
|
|
|
|
|
- Kubernetes:
|
|
|
|
|
- Cluster Scanning: tutorials/kubernetes/cluster-scanning.md
|
|
|
|
|
- Kyverno: tutorials/kubernetes/kyverno.md
|
|
|
|
|
- GitOps: tutorials/kubernetes/gitops.md
|
2023-08-27 08:08:51 +01:00
|
|
|
- Misconfiguration:
|
|
|
|
|
- Terraform scanning: tutorials/misconfiguration/terraform.md
|
2024-02-14 08:40:11 +00:00
|
|
|
- Custom Checks with Rego: tutorials/misconfiguration/custom-checks.md
|
2023-02-15 12:29:03 +01:00
|
|
|
- Signing:
|
|
|
|
|
- Vulnerability Scan Record Attestation: tutorials/signing/vuln-attestation.md
|
|
|
|
|
- Shell:
|
|
|
|
|
- Completion: tutorials/shell/shell-completion.md
|
|
|
|
|
- Additional Resources:
|
2022-09-15 19:27:58 +01:00
|
|
|
- Additional Resources: tutorials/additional-resources/references.md
|
|
|
|
|
- Community References: tutorials/additional-resources/community.md
|
|
|
|
|
- CKS Reference: tutorials/additional-resources/cks.md
|
2023-01-08 15:16:03 +02:00
|
|
|
- Docs:
|
2022-05-02 13:44:26 +03:00
|
|
|
- Overview: docs/index.md
|
2023-02-01 08:48:33 +02:00
|
|
|
- Target:
|
2023-06-02 09:34:07 +03:00
|
|
|
- Container Image: docs/target/container_image.md
|
|
|
|
|
- Filesystem: docs/target/filesystem.md
|
|
|
|
|
- Rootfs: docs/target/rootfs.md
|
2023-07-31 14:27:36 +03:00
|
|
|
- Code Repository: docs/target/repository.md
|
2023-06-02 09:34:07 +03:00
|
|
|
- Virtual Machine Image: docs/target/vm.md
|
|
|
|
|
- Kubernetes: docs/target/kubernetes.md
|
|
|
|
|
- SBOM: docs/target/sbom.md
|
2023-04-17 11:54:31 +03:00
|
|
|
- Scanner:
|
2023-08-17 11:00:34 +03:00
|
|
|
- Vulnerability: docs/scanner/vulnerability.md
|
2023-04-17 11:54:31 +03:00
|
|
|
- Misconfiguration:
|
|
|
|
|
- Overview: docs/scanner/misconfiguration/index.md
|
2025-05-15 18:36:35 -06:00
|
|
|
- Configuration: docs/scanner/misconfiguration/config/config.md
|
2023-04-17 11:54:31 +03:00
|
|
|
- Policy:
|
2024-05-02 12:16:17 -06:00
|
|
|
- Built-in Checks: docs/scanner/misconfiguration/check/builtin.md
|
2024-05-15 19:14:51 -06:00
|
|
|
- Custom Checks:
|
2023-04-17 11:54:31 +03:00
|
|
|
- Overview: docs/scanner/misconfiguration/custom/index.md
|
|
|
|
|
- Data: docs/scanner/misconfiguration/custom/data.md
|
|
|
|
|
- Combine: docs/scanner/misconfiguration/custom/combine.md
|
|
|
|
|
- Selectors: docs/scanner/misconfiguration/custom/selectors.md
|
|
|
|
|
- Schemas: docs/scanner/misconfiguration/custom/schema.md
|
|
|
|
|
- Testing: docs/scanner/misconfiguration/custom/testing.md
|
|
|
|
|
- Debugging Policies: docs/scanner/misconfiguration/custom/debug.md
|
2024-05-22 12:40:55 +01:00
|
|
|
- Contribute Checks: docs/scanner/misconfiguration/custom/contribute-checks.md
|
2023-04-17 11:54:31 +03:00
|
|
|
- Secret: docs/scanner/secret.md
|
|
|
|
|
- License: docs/scanner/license.md
|
2023-08-17 11:00:34 +03:00
|
|
|
- Coverage:
|
|
|
|
|
- Overview: docs/coverage/index.md
|
|
|
|
|
- OS:
|
|
|
|
|
- Overview: docs/coverage/os/index.md
|
|
|
|
|
- AlmaLinux: docs/coverage/os/alma.md
|
|
|
|
|
- Alpine Linux: docs/coverage/os/alpine.md
|
|
|
|
|
- Amazon Linux: docs/coverage/os/amazon.md
|
2024-07-22 07:58:53 +01:00
|
|
|
- Azure Linux (CBL-Mariner): docs/coverage/os/azure.md
|
2025-05-23 09:50:59 +02:00
|
|
|
- Bottlerocket: docs/coverage/os/bottlerocket.md
|
2023-08-17 11:00:34 +03:00
|
|
|
- CentOS: docs/coverage/os/centos.md
|
|
|
|
|
- Chainguard: docs/coverage/os/chainguard.md
|
|
|
|
|
- Debian: docs/coverage/os/debian.md
|
2025-05-29 13:33:29 +03:00
|
|
|
- Echo: docs/coverage/os/echo.md
|
2025-05-29 14:21:22 +03:00
|
|
|
- MinimOS: docs/coverage/os/minimos.md
|
2023-08-17 11:00:34 +03:00
|
|
|
- Oracle Linux: docs/coverage/os/oracle.md
|
|
|
|
|
- Photon OS: docs/coverage/os/photon.md
|
|
|
|
|
- Red Hat: docs/coverage/os/rhel.md
|
|
|
|
|
- Rocky Linux: docs/coverage/os/rocky.md
|
|
|
|
|
- SUSE: docs/coverage/os/suse.md
|
|
|
|
|
- Ubuntu: docs/coverage/os/ubuntu.md
|
|
|
|
|
- Wolfi: docs/coverage/os/wolfi.md
|
2023-08-31 22:18:05 +02:00
|
|
|
- Google Distroless (Images): docs/coverage/os/google-distroless.md
|
2023-08-17 11:00:34 +03:00
|
|
|
- Language:
|
|
|
|
|
- Overview: docs/coverage/language/index.md
|
|
|
|
|
- C/C++: docs/coverage/language/c.md
|
|
|
|
|
- Dart: docs/coverage/language/dart.md
|
|
|
|
|
- .NET: docs/coverage/language/dotnet.md
|
|
|
|
|
- Elixir: docs/coverage/language/elixir.md
|
|
|
|
|
- Go: docs/coverage/language/golang.md
|
|
|
|
|
- Java: docs/coverage/language/java.md
|
|
|
|
|
- Node.js: docs/coverage/language/nodejs.md
|
|
|
|
|
- PHP: docs/coverage/language/php.md
|
|
|
|
|
- Python: docs/coverage/language/python.md
|
|
|
|
|
- Ruby: docs/coverage/language/ruby.md
|
|
|
|
|
- Rust: docs/coverage/language/rust.md
|
|
|
|
|
- Swift: docs/coverage/language/swift.md
|
2024-05-14 22:56:48 -04:00
|
|
|
- Julia: docs/coverage/language/julia.md
|
2023-08-17 11:00:34 +03:00
|
|
|
- IaC:
|
|
|
|
|
- Overview: docs/coverage/iac/index.md
|
|
|
|
|
- Azure ARM Template: docs/coverage/iac/azure-arm.md
|
|
|
|
|
- CloudFormation: docs/coverage/iac/cloudformation.md
|
|
|
|
|
- Docker: docs/coverage/iac/docker.md
|
|
|
|
|
- Helm: docs/coverage/iac/helm.md
|
|
|
|
|
- Kubernetes: docs/coverage/iac/kubernetes.md
|
|
|
|
|
- Terraform: docs/coverage/iac/terraform.md
|
2024-10-02 15:44:17 +04:00
|
|
|
- Others:
|
2024-11-21 14:45:13 +06:00
|
|
|
- Overview: docs/coverage/others/index.md
|
2024-10-02 15:44:17 +04:00
|
|
|
- Bitnami Images: docs/coverage/others/bitnami.md
|
|
|
|
|
- Conda: docs/coverage/others/conda.md
|
|
|
|
|
- RPM Archives: docs/coverage/others/rpm.md
|
2023-10-13 12:00:28 +03:00
|
|
|
- Kubernetes: docs/coverage/kubernetes.md
|
2023-04-17 11:54:31 +03:00
|
|
|
- Configuration:
|
|
|
|
|
- Overview: docs/configuration/index.md
|
|
|
|
|
- Filtering: docs/configuration/filtering.md
|
2025-05-28 15:09:48 +03:00
|
|
|
- Selecting Files: docs/configuration/skipping.md
|
2023-04-17 11:54:31 +03:00
|
|
|
- Reporting: docs/configuration/reporting.md
|
|
|
|
|
- Cache: docs/configuration/cache.md
|
2024-11-27 19:37:17 +02:00
|
|
|
- Databases: docs/configuration/db.md
|
2023-04-17 11:54:31 +03:00
|
|
|
- Others: docs/configuration/others.md
|
|
|
|
|
- Supply Chain:
|
|
|
|
|
- SBOM: docs/supply-chain/sbom.md
|
|
|
|
|
- Attestation:
|
2024-07-25 16:18:37 +04:00
|
|
|
- SBOM: docs/supply-chain/attestation/sbom.md
|
|
|
|
|
- Cosign Vulnerability Scan Record: docs/supply-chain/attestation/vuln.md
|
|
|
|
|
- SBOM Attestation in Rekor: docs/supply-chain/attestation/rekor.md
|
|
|
|
|
- VEX:
|
|
|
|
|
- Overview: docs/supply-chain/vex/index.md
|
|
|
|
|
- VEX Repository: docs/supply-chain/vex/repo.md
|
|
|
|
|
- Local VEX Files: docs/supply-chain/vex/file.md
|
2025-02-27 08:21:09 +01:00
|
|
|
- VEX SBOM Reference: docs/supply-chain/vex/sbom-ref.md
|
2024-07-30 12:02:20 +04:00
|
|
|
- VEX Attestation: docs/supply-chain/vex/oci.md
|
2022-12-28 20:38:48 +02:00
|
|
|
- Compliance:
|
2024-05-22 12:51:28 +01:00
|
|
|
- Built-in Compliance: docs/compliance/compliance.md
|
|
|
|
|
- Custom Compliance: docs/compliance/contrib-compliance.md
|
2024-05-28 13:37:55 +06:00
|
|
|
- Plugins:
|
|
|
|
|
- Overview: docs/plugin/index.md
|
|
|
|
|
- User guide: docs/plugin/user-guide.md
|
|
|
|
|
- Developer guide: docs/plugin/developer-guide.md
|
2022-05-02 13:44:26 +03:00
|
|
|
- Advanced:
|
2022-06-15 15:23:00 +03:00
|
|
|
- Modules: docs/advanced/modules.md
|
2024-11-27 19:37:17 +02:00
|
|
|
- Connectivity and Network considerations: docs/advanced/air-gap.md
|
|
|
|
|
- Self-Hosting Trivy's Databases: docs/advanced/self-hosting.md
|
2022-05-02 13:44:26 +03:00
|
|
|
- Container Image:
|
|
|
|
|
- Embed in Dockerfile: docs/advanced/container/embed-in-dockerfile.md
|
|
|
|
|
- Unpacked container image filesystem: docs/advanced/container/unpacked-filesystem.md
|
|
|
|
|
- Private Docker Registries:
|
|
|
|
|
- Overview: docs/advanced/private-registries/index.md
|
|
|
|
|
- Docker Hub: docs/advanced/private-registries/docker-hub.md
|
|
|
|
|
- AWS ECR (Elastic Container Registry): docs/advanced/private-registries/ecr.md
|
|
|
|
|
- GCR (Google Container Registry): docs/advanced/private-registries/gcr.md
|
|
|
|
|
- ACR (Azure Container Registry): docs/advanced/private-registries/acr.md
|
|
|
|
|
- Self-Hosted: docs/advanced/private-registries/self.md
|
2025-05-28 09:09:16 +01:00
|
|
|
- Usage Telemetry: docs/advanced/telemetry.md
|
2022-05-02 13:44:26 +03:00
|
|
|
- References:
|
2023-04-17 11:54:31 +03:00
|
|
|
- Configuration:
|
|
|
|
|
- CLI:
|
|
|
|
|
- Overview: docs/references/configuration/cli/trivy.md
|
2024-06-25 13:06:27 +04:00
|
|
|
- Clean: docs/references/configuration/cli/trivy_clean.md
|
2023-04-17 11:54:31 +03:00
|
|
|
- Config: docs/references/configuration/cli/trivy_config.md
|
2023-06-02 09:34:07 +03:00
|
|
|
- Convert: docs/references/configuration/cli/trivy_convert.md
|
2023-04-17 11:54:31 +03:00
|
|
|
- Filesystem: docs/references/configuration/cli/trivy_filesystem.md
|
|
|
|
|
- Image: docs/references/configuration/cli/trivy_image.md
|
|
|
|
|
- Kubernetes: docs/references/configuration/cli/trivy_kubernetes.md
|
2024-05-14 12:29:20 +04:00
|
|
|
- Module:
|
|
|
|
|
- Module: docs/references/configuration/cli/trivy_module.md
|
|
|
|
|
- Module Install: docs/references/configuration/cli/trivy_module_install.md
|
|
|
|
|
- Module Uninstall: docs/references/configuration/cli/trivy_module_uninstall.md
|
|
|
|
|
- Plugin:
|
|
|
|
|
- Plugin: docs/references/configuration/cli/trivy_plugin.md
|
|
|
|
|
- Plugin Info: docs/references/configuration/cli/trivy_plugin_info.md
|
|
|
|
|
- Plugin Install: docs/references/configuration/cli/trivy_plugin_install.md
|
|
|
|
|
- Plugin List: docs/references/configuration/cli/trivy_plugin_list.md
|
|
|
|
|
- Plugin Run: docs/references/configuration/cli/trivy_plugin_run.md
|
|
|
|
|
- Plugin Uninstall: docs/references/configuration/cli/trivy_plugin_uninstall.md
|
|
|
|
|
- Plugin Update: docs/references/configuration/cli/trivy_plugin_update.md
|
|
|
|
|
- Plugin Upgrade: docs/references/configuration/cli/trivy_plugin_upgrade.md
|
|
|
|
|
- Plugin Search: docs/references/configuration/cli/trivy_plugin_search.md
|
2024-10-15 15:24:10 +04:00
|
|
|
- Registry:
|
|
|
|
|
- Registry: docs/references/configuration/cli/trivy_registry.md
|
|
|
|
|
- Registry Login: docs/references/configuration/cli/trivy_registry_login.md
|
|
|
|
|
- Registry Logout: docs/references/configuration/cli/trivy_registry_logout.md
|
2023-04-17 11:54:31 +03:00
|
|
|
- Repository: docs/references/configuration/cli/trivy_repository.md
|
|
|
|
|
- Rootfs: docs/references/configuration/cli/trivy_rootfs.md
|
|
|
|
|
- SBOM: docs/references/configuration/cli/trivy_sbom.md
|
|
|
|
|
- Server: docs/references/configuration/cli/trivy_server.md
|
|
|
|
|
- Version: docs/references/configuration/cli/trivy_version.md
|
2024-07-29 10:51:38 +06:00
|
|
|
- VEX:
|
|
|
|
|
- VEX: docs/references/configuration/cli/trivy_vex.md
|
|
|
|
|
- VEX Download: docs/references/configuration/cli/trivy_vex_repo_download.md
|
|
|
|
|
- VEX Init: docs/references/configuration/cli/trivy_vex_repo_init.md
|
|
|
|
|
- VEX List: docs/references/configuration/cli/trivy_vex_repo_list.md
|
|
|
|
|
- VEX Repo: docs/references/configuration/cli/trivy_vex_repo.md
|
2023-04-17 11:54:31 +03:00
|
|
|
- VM: docs/references/configuration/cli/trivy_vm.md
|
|
|
|
|
- Config file: docs/references/configuration/config-file.md
|
2022-05-02 13:44:26 +03:00
|
|
|
- Modes:
|
|
|
|
|
- Standalone: docs/references/modes/standalone.md
|
|
|
|
|
- Client/Server: docs/references/modes/client-server.md
|
|
|
|
|
- Troubleshooting: docs/references/troubleshooting.md
|
2024-11-29 17:15:24 +09:00
|
|
|
- Terminology: docs/references/terminology.md
|
2025-03-05 07:14:44 +04:00
|
|
|
- Abbreviations: docs/references/abbreviations.md
|
2022-11-16 10:06:13 +02:00
|
|
|
- Ecosystem:
|
|
|
|
|
- Overview: ecosystem/index.md
|
|
|
|
|
- CI/CD: ecosystem/cicd.md
|
|
|
|
|
- IDE and Dev tools: ecosystem/ide.md
|
|
|
|
|
- Production and Clouds: ecosystem/prod.md
|
2024-01-15 06:13:27 +00:00
|
|
|
- Reporting: ecosystem/reporting.md
|
2022-09-15 19:27:58 +01:00
|
|
|
- Contributing:
|
2024-02-12 18:27:35 +04:00
|
|
|
- Principles: community/principles.md
|
2022-05-02 13:44:26 +03:00
|
|
|
- How to contribute:
|
|
|
|
|
- Issues: community/contribute/issue.md
|
2023-05-10 12:06:37 +03:00
|
|
|
- Discussions: community/contribute/discussion.md
|
2022-05-02 13:44:26 +03:00
|
|
|
- Pull Requests: community/contribute/pr.md
|
2024-05-22 12:40:55 +01:00
|
|
|
- Contribute Rego Checks:
|
|
|
|
|
- Overview: community/contribute/checks/overview.md
|
|
|
|
|
- Add Service Support: community/contribute/checks/service-support.md
|
2022-05-02 13:44:26 +03:00
|
|
|
- Maintainer:
|
2024-05-29 09:02:00 +04:00
|
|
|
- Release Flow: community/maintainer/release-flow.md
|
2024-06-06 14:08:55 +04:00
|
|
|
- Backporting: community/maintainer/backporting.md
|
2022-05-02 13:44:26 +03:00
|
|
|
- Help Wanted: community/maintainer/help-wanted.md
|
|
|
|
|
- Triage: community/maintainer/triage.md
|
2024-12-03 22:24:56 +02:00
|
|
|
- Enterprise:
|
|
|
|
|
- Comparison: commercial/compare.md
|
|
|
|
|
- Contact Us: commercial/contact.md
|
2025-06-05 16:20:55 +03:00
|
|
|
- Partners: partners.md
|
2021-03-10 01:05:37 +07:00
|
|
|
theme:
|
2022-05-02 13:44:26 +03:00
|
|
|
name: material
|
2023-05-16 21:32:17 -06:00
|
|
|
custom_dir: docs/overrides
|
2022-05-02 13:44:26 +03:00
|
|
|
language: "en"
|
|
|
|
|
logo: imgs/logo-white.svg
|
|
|
|
|
features:
|
|
|
|
|
- navigation.tabs
|
|
|
|
|
- navigation.tabs.sticky
|
|
|
|
|
- navigation.sections
|
2023-05-30 10:23:05 +01:00
|
|
|
- navigation.footer
|
|
|
|
|
- content.action.edit
|
2022-07-25 18:19:04 +06:00
|
|
|
- content.tabs.link
|
2023-05-30 10:23:05 +01:00
|
|
|
- content.code.annotate
|
|
|
|
|
- content.code.copy
|
2024-11-17 23:34:48 -07:00
|
|
|
font:
|
|
|
|
|
text: Inter
|
2021-03-10 01:05:37 +07:00
|
|
|
|
|
|
|
|
markdown_extensions:
|
2024-11-17 23:34:48 -07:00
|
|
|
- abbr
|
|
|
|
|
- admonition
|
|
|
|
|
- attr_list
|
|
|
|
|
- def_list
|
|
|
|
|
- footnotes
|
|
|
|
|
- md_in_html
|
|
|
|
|
- toc:
|
|
|
|
|
permalink: true
|
2021-03-10 01:05:37 +07:00
|
|
|
- pymdownx.highlight
|
2024-11-17 23:34:48 -07:00
|
|
|
- pymdownx.details
|
2024-11-29 17:15:24 +09:00
|
|
|
- pymdownx.magiclink
|
2024-02-13 16:35:06 +04:00
|
|
|
- pymdownx.superfences:
|
|
|
|
|
custom_fences:
|
|
|
|
|
- name: mermaid
|
|
|
|
|
class: mermaid
|
|
|
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
2022-07-25 18:19:04 +06:00
|
|
|
- pymdownx.tabbed:
|
|
|
|
|
alternate_style: true
|
2021-03-10 01:05:37 +07:00
|
|
|
|
|
|
|
|
extra:
|
|
|
|
|
generator: false
|
|
|
|
|
version:
|
|
|
|
|
method: mike
|
|
|
|
|
provider: mike
|
2023-05-16 21:32:17 -06:00
|
|
|
default: latest
|
2023-05-30 10:23:05 +01:00
|
|
|
social:
|
2024-12-09 17:53:44 +05:30
|
|
|
- icon: fontawesome/brands/x-twitter
|
2023-05-30 10:23:05 +01:00
|
|
|
link: https://twitter.com/AquaTrivy
|
|
|
|
|
- icon: fontawesome/brands/github
|
|
|
|
|
link: https://github.com/aquasecurity/trivy
|
2024-12-03 22:24:56 +02:00
|
|
|
analytics:
|
|
|
|
|
provider: google
|
|
|
|
|
property: G-V9LJGFH7GX
|
2021-03-10 01:05:37 +07:00
|
|
|
|
|
|
|
|
plugins:
|
|
|
|
|
- search
|
2022-05-02 13:44:26 +03:00
|
|
|
- macros
|
2022-06-21 18:00:28 +03:00
|
|
|
|
