From 1cfcbfabfced270dcf918f0156d555bdd4ae7a2c Mon Sep 17 00:00:00 2001 From: Ciprian Dorin Craciun Date: Fri, 2 Sep 2022 16:20:38 +0300 Subject: [PATCH] [readme] Add SBOM section; minor updates. --- documentation/readme.rst | 41 +++++++++++++++++++++++++--------------- 1 file changed, 26 insertions(+), 15 deletions(-) diff --git a/documentation/readme.rst b/documentation/readme.rst index ac0a7fc..fb12cca 100644 --- a/documentation/readme.rst +++ b/documentation/readme.rst @@ -26,7 +26,7 @@ kawipiko -- blazingly fast static HTTP server * `Manual <#manual>`__ and `Examples <#examples>`__ * `Installation <#installation>`__ and `FAQ <#faq>`__ * `Features <#features>`__ and `Benchmarks <#benchmarks>`__ - * `About <#about>`__, `Copyright and licensing <#notice-copyright-and-licensing>`__, and `References <#references>`__ + * `About <#about>`__, `Copyright and licensing <#notice-copyright-and-licensing>`__, `SBOM <#sbom-software-bill-of-materials>`__, and `References <#references>`__ * `chat on Discord `__, `discuss on GitHub `__, or `email author `__ @@ -126,19 +126,6 @@ plus efficient management and storage of large collections of many small files. -.. contents:: - :depth: 1 - :local: - :backlinks: none - - - - --------- - - - - Manual ====== @@ -387,7 +374,7 @@ The following is a list of the most important features that are currently missin and a few TLS or security related headers can also be included;) * (TODO) support for mapping virtual hosts to key prefixes; - (currently virtual hosts, i.e. the ``Host`` header, are ignored;) + (currently virtual hosts, i.e. the ``Host`` header, is supported by the server, and partially by the archiver;) * (TODO) support for mapping virtual hosts to multiple CDB archives; (i.e. the ability to serve multiple domains, each with its own CDB archive;) @@ -397,6 +384,7 @@ The following is a list of the most important features that are currently missin * (TODO) minifying HTML, CSS and JavaScript, by leveraging ``https://github.com/tdewolff/minify``; * (TODO) customized error pages (embedded in the CDB archive); + (currently only ``404`` wildcards are supported;) @@ -574,6 +562,9 @@ Ciprian Dorin Craciun * ``__ * ``__ +Please also see the `SBOM (Software Bill of Materials) <./documentation/sbom/sbom.md>`__ +for links this project's dependencies and their authors. + @@ -613,6 +604,26 @@ release the sources and/or documentation under a different license. +SBOM (Software Bill of Materials) +================================= + + +This project, like many other open-source projects, +incorporates code from other open-source projects +(besides other tools used to develop, build and test). + +Strictly related to the project's dependencies (direct and transitive), +please see the `SBOM (Software Bill of Materials) <./documentation/sbom/sbom.md>`__ +for links to these dependencies and their licenses. + + + + +-------- + + + + References ==========