Skip to content

Commit d507576

Browse files
committed
docs: add note about container image to intro
Signed-off-by: Felix Moessbauer <[email protected]>
1 parent 0b84dc6 commit d507576

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

docs/source/examples.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,14 @@ It is also possible to download multiple packages by name, version and architect
5353
guestfs-tools 1.52.3-1 source
5454
EOF
5555
56+
Alternatively, the download can be executed from the container image:
57+
58+
.. code-block:: bash
59+
60+
echo "guestfs-tools 1.52.3-1 source" | \
61+
docker run -v$(pwd)/downloads:/mnt/downloads -i ghcr.io/siemens/debsbom:latest \
62+
debsbom download --outdir /mnt/downloads --sources
63+
5664
Merge Source Packages
5765
~~~~~~~~~~~~~~~~~~~~~
5866

docs/source/intro.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,14 @@ Their relationship is expressed with the ``GENERATES`` relation.
7676
For packages that are marked as ``Built-Using`` in the dpkg status file, we use the ``GENERATED_FROM`` relation.
7777
This expresses the same semantic in SPDX, but this way it can still be identified if it is a proper source/binary relationship or a built-using one.
7878

79+
Container Image
80+
---------------
81+
82+
The ``debsbom`` tool is available as a container image at ``ghcr.io/siemens/debsbom:<latest|tag>``.
83+
It runs as root inside the container, allowing mounted directories (e.g., the download directory) to be owned by the invoking user in rootless environments, simplifying CI usage.
84+
85+
The container image is built in a bit‑for‑bit reproducible manner.
86+
This can be verified by forking the repository, executing the CI pipeline, and comparing the hashes of the resulting container manifest.
7987

8088
Limitations
8189
-----------

0 commit comments

Comments
 (0)