clair README

The project's README from github.com/quay/clair. As one markdown file: README.md.

Clair

Docker Repository on Quay PkgGoDev IRC Channel

Note: The main branch may be in an unstable or even broken state during development. Please use releases instead of the main branch in order to get stable binaries.

Clair Logo

Clair is an open source project for the static analysis of vulnerabilities in application containers (currently including OCI and docker).

Clients use the Clair API to index their container images and can then match it against known vulnerabilities.

Our goal is to enable a more transparent view of the security of container-based infrastructure. Thus, the project was named Clair after the French term which translates to clear, bright, transparent.

The book contains all the documentation on Clair's architecture and operation.

Community

Contributing

See CONTRIBUTING for details on submitting patches and the contribution workflow.

License

Clair is under the Apache 2.0 license. See the LICENSE file for details.

clair (quay/clair)

Searching Database…

11.1K ·GitHub
What is this?Clair is an open source tool for static analysis of vulnerabilities in application container images, covering both OCI and Docker image formats.
Is this a CLI tool or a server I run?It is a server with an API: clients send container images to Clair to be indexed, then query that index to match it against known vulnerabilities, rather than running a single local command.
How do I get a stable build running?Grab a tagged release rather than building from the main branch, since main can be unstable or broken during active development. A Docker image is also available for running it.
Which container image formats can it scan?Clair currently supports indexing and checking both OCI images and Docker images.
Is it safe to deploy straight from the main branch?No - the README explicitly warns the main branch can be unstable or broken during development, so production deployments should use a released version instead.
Who would actually run Clair?Teams running container-based infrastructure (Docker/OCI/Kubernetes environments) who want visibility into known vulnerabilities in the images they deploy.
Why is the project called Clair?Clair is the French word for clear, bright, or transparent, reflecting the project's goal of giving a transparent view into container image vulnerabilities.
Where is the full documentation?The README points to 'The book', a separate documentation site covering Clair's architecture and operation, rather than keeping detailed docs in the README itself.
How does the index-then-match workflow actually work?A client first submits a container image to Clair to be indexed (its contents cataloged), then that index is matched against Clair's vulnerability data to surface known issues.
Creator
quay
Size
35.8 MB
Stars
11.1K
Age
10y
Commits · 90 Days