Skip to content

Commit 0b10a46

Browse files
sschuberthmbarbero
authored andcommitted
Add ORT (Server) / Eclipse Apoapsis to the list
With ORT Server being an Eclipse project as part of Apoapsis, it makes sense to be listed here, even if the list is not supposed to be exhaustive. Signed-off-by: Sebastian Schuberth <sebastian@doubleopen.io>
1 parent d7d8223 commit 0b10a46

1 file changed

Lines changed: 57 additions & 12 deletions

File tree

docs/sbom/tooling.md

Lines changed: 57 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# Tooling Ecosystem for CycloneDX
22
This page introduces a selection of tools that **generate** SBOMs for projects written in various programming languages and across different ecosystems. While not exhaustive, it aims to offer a starting point for creating SBOMs in the CycloneDX format.
33

4-
| **Environment** | **Ecosystem/Build System** | **Tool** |
5-
|---------------------|----------------------------|---------------------------------------------------------------|
6-
| **Java** | Maven | [cyclonedx-for-maven](#cyclonedx-for-maven) |
7-
| | Gradle | [cyclonedx-for-gradle](#cyclonedx-for-gradle) |
8-
| **Python** | All | [cyclonedx-for-python](#cyclonedx-for-python) |
9-
| | Github Actions | [gh-python-generate-sbom](#gh-python-generate-sbom) |
10-
| **Nodejs** | All | [cyclonedx-bom](#cyclonedx-bom) |
11-
| | NPM | [cyclonedx-npm](#cyclonedx-npm) |
12-
| | Yarn | [yarn-plugin-cyclonedx](#yarn-plugin-cyclonedx) |
13-
| | React | [webpack-plugin with React](#webpack-plugin-with-react) |
14-
| **Go** | Modules | [cyclonedx-gomod](#cyclonedx-gomod) |
15-
| **Multi-Ecosystem** | All | [cdxgen](#cdxgen) |
4+
| **Environment** | **Ecosystem/Build System** | **Tool** |
5+
|---------------------|----------------------------|--------------------------------------------------------------------------|
6+
| **Java** | Maven | [cyclonedx-for-maven](#cyclonedx-for-maven) |
7+
| | Gradle | [cyclonedx-for-gradle](#cyclonedx-for-gradle) |
8+
| **Python** | All | [cyclonedx-for-python](#cyclonedx-for-python) |
9+
| | Github Actions | [gh-python-generate-sbom](#gh-python-generate-sbom) |
10+
| **Nodejs** | All | [cyclonedx-bom](#cyclonedx-bom) |
11+
| | NPM | [cyclonedx-npm](#cyclonedx-npm) |
12+
| | Yarn | [yarn-plugin-cyclonedx](#yarn-plugin-cyclonedx) |
13+
| | React | [webpack-plugin with React](#webpack-plugin-with-react) |
14+
| **Go** | Modules | [cyclonedx-gomod](#cyclonedx-gomod) |
15+
| **Multi-Ecosystem** | All | [cdxgen](#cdxgen), [OSS Review Toolkit](#ORT), [ORT Server](#ORT Server) |
1616

1717
Once a suitable generation tool is selected, we recommend consulting our [How to generate and upload SBOMs](./howto.md) guide. This guide is a concise tutorial that focuses on integrating SBOM generation into the project's existing CI/CD pipelines to automatically produce SBOMs for new releases and upload them to our SBOM Registry.
1818

@@ -340,3 +340,48 @@ Supported Languages/Platforms: [Comprehensive List](https://cyclonedx.github.io/
340340

341341
#### Examples
342342
Examples of SBOM generation pipelines using polyglot tools can be found on our [SBOM Early Adopters](./earlyadopters.md) page.
343+
344+
### ORT
345+
* Website: https://oss-review-toolkit.org
346+
* Source: https://github.com/oss-review-toolkit/ort
347+
348+
Supported Languages/Platforms: [Comprehensive List](https://oss-review-toolkit.org/ort/docs/tools/analyzer)
349+
* C / C++ (Bazel, Conan)
350+
* Erlang (Rebar3, Mix, Gleam)
351+
* Golang
352+
* Haskell
353+
* Java (Maven, Gradle, sbt)
354+
* .NET
355+
* Node.js
356+
* Python
357+
* Ruby
358+
* Rust
359+
* PHP
360+
* Swift (SwiftPM, Carthage, Cocoapods)
361+
362+
#### Installation: [Instructions](https://oss-review-toolkit.org/ort/docs/getting-started/installation)
363+
Via Docker: `docker pull ghcr.io/oss-review-toolkit/ort`
364+
365+
#### Usage
366+
Generate an SBOM for a local directory under version control:
367+
* `ort analyze -i <input-dir> -o <output-dir>`
368+
* `ort report -f CycloneDX -i <output-dir>/analyzer-result.yml -o <output-dir>`
369+
370+
#### Examples
371+
Usage examples can be found as part of the [tutorial](https://oss-review-toolkit.org/ort/docs/getting-started/tutorial).
372+
373+
### ORT Server
374+
* Website: https://eclipse-apoapsis.github.io/ort-server
375+
* Source: https://github.com/eclipse-apoapsis/ort-server
376+
377+
Supported Languages/Platforms: Same as [ORT](#ORT).
378+
379+
#### Installation: [Instructions](https://eclipse-apoapsis.github.io/ort-server/docs/admin-guide/guides/development-helm-chart)
380+
Via Helm: `helm install release-name oci://ghcr.io/eclipse-apoapsis/charts/ort-server`
381+
382+
#### Usage
383+
ORT Server is an enterprise-ready server with a REST API and a web front-end.
384+
It is being user interactively via its UI or the [OSC CLI tool](https://eclipse-apoapsis.github.io/ort-server/docs/user-guide/cli/getting-started) for automation.
385+
386+
#### Examples
387+
Usage examples can be found as part of the [introduction](https://eclipse-apoapsis.github.io/ort-server/docs/intro).

0 commit comments

Comments
 (0)