forked from aquasecurity/trivy
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: rewrite installation docs and general improvements (aquasecurit…
…y#3368) improve installation guide, improve overview pages, rename cli section to docs
- Loading branch information
Showing
8 changed files
with
118 additions
and
325 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,72 +1,5 @@ | ||
# Docs | ||
|
||
This documentation details how to use Trivy to access the features listed below. | ||
In this section you can find the complete reference documentation for all of the different features and settings that Trivy has to offer. | ||
|
||
## Features | ||
|
||
- Comprehensive vulnerability detection | ||
- [OS packages][os] (Alpine, Wolfi, Red Hat Universal Base Image, Red Hat Enterprise Linux, CentOS, AlmaLinux, Rocky Linux, CBL-Mariner, Oracle Linux, Debian, Ubuntu, Amazon Linux, openSUSE Leap, SUSE Enterprise Linux, Photon OS and Distroless) | ||
- [**Language-specific packages**][lang] (Bundler, Composer, Pipenv, Poetry, npm, yarn, pnpm, Cargo, NuGet, Maven, and Go) | ||
- Detect IaC misconfigurations | ||
- A wide variety of [built-in policies][builtin] are provided **out of the box**: | ||
- Kubernetes | ||
- Docker | ||
- Terraform | ||
- more coming soon | ||
- Support custom policies | ||
- Simple | ||
- Specify only an image name, a directory containing IaC configs, or an artifact name | ||
- See [Quick Start][quickstart] | ||
- Fast | ||
- The first scan will finish within 10 seconds (depending on your network). Consequent scans will finish in single seconds. | ||
- Unlike other scanners that take long to fetch vulnerability information (~10 minutes) on the first run, and encourage you to maintain a durable vulnerability database, Trivy is stateless and requires no maintenance or preparation. | ||
- Easy installation | ||
- `apt-get install`, `yum install` and `brew install` is possible (See [Installation][installation]) | ||
- **No pre-requisites** such as installation of DB, libraries, etc. | ||
- High accuracy | ||
- **Especially Alpine Linux and RHEL/CentOS** | ||
- Other OSes are also high | ||
- DevSecOps | ||
- **Suitable for CI** such as Travis CI, CircleCI, Jenkins, GitLab CI, etc. | ||
- See [CI Example][integrations] | ||
- Support multiple formats | ||
- container image | ||
- A local image in Docker Engine which is running as a daemon | ||
- A local image in [Podman][podman] (>=2.0) which is exposing a socket | ||
- A remote image in Docker Registry such as Docker Hub, ECR, GCR and ACR | ||
- A tar archive stored in the `docker save` / `podman save` formatted file | ||
- An image directory compliant with [OCI Image Format][oci] | ||
- local filesystem and rootfs | ||
- remote git repository | ||
- [SBOM][sbom] (Software Bill of Materials) support | ||
- CycloneDX | ||
- SPDX | ||
- GitHub Dependency Snapshots | ||
|
||
Please see [LICENSE][license] for Trivy licensing information. | ||
|
||
[installation]: ../getting-started/installation.md | ||
[vuln]: ../docs/vulnerability/scanning/index.md | ||
[misconf]: ../docs/misconfiguration/scanning.md | ||
[kubernetesoperator]: ../docs/kubernetes/operator/index.md | ||
[container]: ../docs/vulnerability/scanning/image.md | ||
[rootfs]: ../docs/vulnerability/scanning/rootfs.md | ||
[filesystem]: ../docs/vulnerability/scanning/filesystem.md | ||
[repo]: ../docs/vulnerability/scanning/git-repository.md | ||
[kubernetes]: ../docs/kubernetes/cli/scanning.md | ||
|
||
[standalone]: ../docs/references/modes/standalone.md | ||
[client-server]: ../docs/references/modes/client-server.md | ||
[integrations]: ../tutorials/integrations/index.md | ||
|
||
[os]: ../docs/vulnerability/detection/os.md | ||
[lang]: ../docs/vulnerability/detection/language.md | ||
|
||
[builtin]: ../docs/misconfiguration/policy/builtin.md | ||
[quickstart]: ../index.md | ||
[podman]: ../docs/advanced/container/podman.md | ||
|
||
[sbom]: ../docs/sbom/index.md | ||
|
||
[oci]: https://github.com/opencontainers/image-spec | ||
[license]: https://github.com/aquasecurity/trivy/blob/main/LICENSE | ||
👈 Please use the side-navigation on the left in order to browse the different topics. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.