Skip to content

docs: add example and HTML output screenshot for container scanning #3716

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

docs: add example and HTML output screenshot for container scanning #3716

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
dcacc22
docs: add container scan example and HTML output screenshot
AbhishekHerbertSamuel Jul 27, 2025
da852cf
docs: add container scan example and HTML output screenshot
AbhishekHerbertSamuel Aug 4, 2025
ce8aa36
Website: container scan section at top level; fix /static/img path; r…
AbhishekHerbertSamuel Aug 31, 2025
ac0304d
Remove legacy container scan image files
AbhishekHerbertSamuel Aug 31, 2025
d70b16a
website: container scan section — match code-card style, align screen…
AbhishekHerbertSamuel Oct 5, 2025
c49cf73
fix: align container scan screenshot markup with GitHub Workflows sec…
AbhishekHerbertSamuel Oct 27, 2025
1b85738
Apply suggestion from @another-rex
another-rex Oct 31, 2025
833f742
Attempt to fix formatting, and close div
another-rex Oct 31, 2025
170bcac
Merge branch 'master' into docs/container-scanning
another-rex Oct 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
140 changes: 103 additions & 37 deletions gcp/website/frontend3/src/templates/home.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<link rel="preload" fetchpriority="high" as="image" href="/static/img/external-link.svg" type="image/webp">
<!-- Defer offscreen images on mobile screens -->
<link rel="preload" fetchpriority="high" as="image" href="/static/img/footer-decoration.webp" type="image/webp"
media="(min-width: 768px)" onload="this.media='all'">
media="(min-width: 768px)" onload="this.media='all'">
<noscript>
<link rel="stylesheet" href="/static/img/footer-decoration.webp" type="image/webp">
</noscript>
Expand All @@ -19,8 +19,10 @@
<div class="mdc-layout-grid__cell--span-12 hero">
<h1 class="title">A distributed vulnerability database for Open Source</h1>
<div class="explainer">
<p>An open, precise, and distributed approach to producing and consuming vulnerability information for open
<p>An open, precise, and distributed approach to producing and consuming vulnerability information for
open
source.
</p>
</div>
<div class="cta">
<a class="cta-primary link-button" href="{{ url_for('frontend_handlers.list_vulnerabilities') }}">
Expand Down Expand Up @@ -128,7 +130,8 @@ <h2 class="heading">OSV schema</h2>
<div class="cta">
<a class="cta-primary link-button" href="https://ossf.github.io/osv-schema/">OSV Schema</a>
<a class="cta-primary link-button"
href="https://security.googleblog.com/2021/06/announcing-unified-vulnerability-schema.html">Blog post</a>
href="https://security.googleblog.com/2021/06/announcing-unified-vulnerability-schema.html">Blog
post</a>
</div>
</div>
<div class="mdc-layout-grid__cell--span-12 text-info data-sources">
Expand All @@ -144,7 +147,7 @@ <h2 class="heading">Data sources</h2>
</p>
<div class="cta">
<a class="cta-primary link-button" href="https://google.github.io/osv.dev/data/#current-data-sources"
aria-label="Learn more about our data sources">Learn more</a>
aria-label="Learn more about our data sources">Learn more</a>
</div>
</div>
<div id="use-the-api" class="mdc-layout-grid__cell--span-12 usage-examples">
Expand All @@ -160,7 +163,9 @@ <h3 class="code-card-title">Query by commit hash</h3>
'{"commit": "6879efc2c1596d11a6a6ad296f80063b558d5e0f"}' \
"https://api.osv.dev/v1/query"</pre>
<clipboard-copy class="code-card-copy" for="example-commit-hash">
<md-icon-button class="icon"><md-icon>content_copy</md-icon></md-icon-button>
<md-icon-button class="icon">
<md-icon>content_copy</md-icon>
</md-icon-button>
</clipboard-copy>
</div>
<div class="code-card mdc-layout-grid__cell--span-6 mdc-layout-grid__cell--span-12-tablet">
Expand All @@ -170,13 +175,16 @@ <h3 class="code-card-title">Query by version number</h3>
"package": {"name": "jinja2", "ecosystem": "PyPI"}}' \
"https://api.osv.dev/v1/query"</pre>
<clipboard-copy class="code-card-copy" for="example-version-number">
<md-icon-button class="icon"><md-icon>content_copy</md-icon></md-icon-button>
<md-icon-button class="icon">
<md-icon>content_copy</md-icon>
</md-icon-button>
</clipboard-copy>
</div>
</div>
<div class="mdc-layout-grid__cell--span-12">
<div class="cta">
<a class="cta-primary link-button" href="https://google.github.io/osv.dev/api/">API Documentation</a>
<a class="cta-primary link-button" href="https://google.github.io/osv.dev/api/">API
Documentation</a>
</div>
</div>
</div>
Expand All @@ -191,7 +199,9 @@ <h3 class="code-card-title">Install OSV&#8209;Scanner</h3>
go install github.com/google/osv-scanner/v2/cmd/osv-scanner@v2
</pre>
<clipboard-copy class="code-card-copy" for="example-scanner-install">
<md-icon-button class="icon"><md-icon>content_copy</md-icon></md-icon-button>
<md-icon-button class="icon">
<md-icon>content_copy</md-icon>
</md-icon-button>
</clipboard-copy>
</div>
<div class="mobile-spacer mdc-layout-grid__cell--span-3"></div>
Expand All @@ -202,7 +212,9 @@ <h3 class="code-card-title">Scan SBOM or Lockfiles</h3>
osv-scanner --lockfile=package-lock.json
</pre>
<clipboard-copy class="code-card-copy" for="example-sbom-scan">
<md-icon-button class="icon"><md-icon>content_copy</md-icon></md-icon-button>
<md-icon-button class="icon">
<md-icon>content_copy</md-icon>
</md-icon-button>
</clipboard-copy>
</div>
<div class="code-card mdc-layout-grid__cell--span-6 mdc-layout-grid__cell--span-12-tablet">
Expand All @@ -211,7 +223,9 @@ <h3 class="code-card-title">Scan directory recursively</h3>
osv-scanner -r path/to/your/project
</pre>
<clipboard-copy class="code-card-copy" for="example-dir-scan">
<md-icon-button class="icon"><md-icon>content_copy</md-icon></md-icon-button>
<md-icon-button class="icon">
<md-icon>content_copy</md-icon>
</md-icon-button>
</clipboard-copy>
</div>
</div>
Expand All @@ -232,7 +246,9 @@ <h3 class="code-card-title">Guided Remediation (basic)</h3>
osv-scanner fix --non-interactive --strategy=relock -M path/to/package.json -L path/to/package-lock.json
</pre>
<clipboard-copy class="code-card-copy" for="example-guided-remediation-basic">
<md-icon-button class="icon"><md-icon>content_copy</md-icon></md-icon-button>
<md-icon-button class="icon">
<md-icon>content_copy</md-icon>
</md-icon-button>
</clipboard-copy>
</div>
<div class="code-card mdc-layout-grid__cell--span-6 mdc-layout-grid__cell--span-12-tablet">
Expand All @@ -241,43 +257,93 @@ <h3 class="code-card-title">Guided Remediation (interactive)</h3>
osv-scanner fix -M path/to/package.json -L path/to/package-lock.json
</pre>
<clipboard-copy class="code-card-copy" for="example-guided-remediation-advanced">
<md-icon-button class="icon"><md-icon>content_copy</md-icon></md-icon-button>
<md-icon-button class="icon">
<md-icon>content_copy</md-icon>
</md-icon-button>
</clipboard-copy>
</div>


</div>
<div class="mdc-layout-grid__cell--span-12">
<div class="cta">
<a class="cta-primary link-button" href="https://google.github.io/osv-scanner/experimental/guided-remediation/">More details</a>
<a class="cta-primary link-button"
href="https://google.github.io/osv-scanner/experimental/guided-remediation/">More details</a>
</div>
</div>
</div>
<div id="use-the-github-workflows" class="mdc-layout-grid__cell--span-12 github-action">
<h2 class="heading">GitHub Workflows</h2>
<div id="use-container-scanning" class="mdc-layout-grid__cell--span-12 usage-examples">
<h2 class="heading">Container Image Scanning</h2>
<p class="description">
OSV-Scanner also provides reusable GitHub workflows that can be easily integrated into CI/CD pipelines to provide
continuous vulnerability scanning coverage. This can scan newly added dependencies in pull requests for introduced
vulnerabilities, as well as perform regular vulnerability scans for the entire project.</p>
<div class="image-container">
<img src="/static/img/github-action-scan-output.webp" alt="Screenshot of OSV-Scanner GitHub Action" loading="lazy">
You can use
<a href="https://github.com/google/osv-scanner" target="_blank" rel="noopener">OSV-Scanner</a>
to scan your container images for known vulnerabilities.
</p>

<!-- Command box (same look as 'Use the API' cards, centered) -->
<div class="code-card-container mdc-layout-grid__inner">
<div class="mobile-spacer mdc-layout-grid__cell--span-3"></div>
<div class="code-card mdc-layout-grid__cell--span-6 mdc-layout-grid__cell--span-12-tablet">
<h3 class="code-card-title">Scan container image</h3>
<pre class="code-card-content" id="example-container-scan-serve">
osv-scanner scan image --serve alpine:3.12
</pre>
<clipboard-copy class="code-card-copy" for="example-container-scan-serve">
<md-icon-button class="icon">
<md-icon>content_copy</md-icon>
</md-icon-button>
</clipboard-copy>
</div>
<div class="mobile-spacer mdc-layout-grid__cell--span-3"></div>
</div>
<div class="cta">
<a class="cta-primary link-button" href="https://google.github.io/osv-scanner/github-action/"
aria-label="Learn more about osv scanner github action">Learn more</a>

<!-- Big screenshot (same size/markup as GitHub Workflows) -->
<div class="image-container" style="margin-top: 16px;">
<img
src="/static/img/container-scan-html.png"
alt="Screenshot of container scan HTML output"
loading="lazy"
style="
max-width: 1000px;
width: 100%;
height: auto;
display: block;
margin: 0 auto;
border: none;
/* crop 2px from the TOP only */
clip-path: inset(2px 0 0 0);
"
>
</div>
</div>
<div class="mdc-layout-grid__cell--span-12 open-source-banner">
<h2 class="heading">Open source</h2>
<p class="description">
This project is <a href="https://github.com/google/osv">open source</a>. If you have any ideas or questions,
please feel free to
reach out by <a href="https://github.com/google/osv/issues/new/choose">creating an issue</a>!
</p>
<div class="cta">
<a class="cta-primary link-button" href="https://google.github.io/osv.dev/faq/"
aria-label="Learn more on our FAQ">Learn more</a>


<div id="use-the-github-workflows"
class="mdc-layout-grid__cell--span-12 github-action">
<h2 class="heading">GitHub Workflows</h2>
<p class="description"> OSV-Scanner also provides reusable GitHub workflows that can be easily
integrated into CI/CD pipelines to provide continuous vulnerability scanning coverage. This can scan
newly added dependencies in pull requests for introduced vulnerabilities, as well as perform regular
vulnerability scans for the entire project.</p>
<div class="image-container"><img src="/static/img/github-action-scan-output.webp"
alt="Screenshot of OSV-Scanner GitHub Action" loading="lazy"></div>
<div class="cta"><a class="cta-primary link-button"
href="https://google.github.io/osv-scanner/github-action/"
aria-label="Learn more about osv scanner github action">Learn more</a></div>
</div>

<div class="mdc-layout-grid__cell--span-12 open-source-banner">
<h2 class="heading">Open source</h2>
<p class="description"> This project is <a href="https://github.com/google/osv">open source</a>. If you
have any ideas or questions, please feel free to reach out by <a
href="https://github.com/google/osv/issues/new/choose">creating an issue</a>! </p>

<div class="cta">
<a class="cta-primary link-button" href="https://google.github.io/osv.dev/faq/"
aria-label="Learn more on our FAQ">Learn more</a>
</div>
</div>
</div>
</div>
<footer></footer>
</div>
{% endblock %}
<footer>
</footer>
</div> {% endblock %}
Binary file added gcp/website/frontend3/static/img/container-scan-html.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion gcp/website/frontend3/webpack.dev.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ module.exports = {
plugins: [
new CopyPlugin({
patterns: [
{ from: './src/templates/*.html', to: '[name].html' },
{ from: './src/templates', to: '.', globOptions: { ignore: ['**/base.html'] } },
{ from: './img/*', to: 'static/img/[name][ext]' },
],
}),
Expand Down
Loading