Skip to content

docs(licenses): link upstream dependency terms #63

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

Merged
nick2781 merged 1 commit into from
Oct 28, 2026
Merged

docs(licenses): link upstream dependency terms #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
57 changes: 18 additions & 39 deletions docs/project/third-party-notices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,41 +1,20 @@
# Third-Party Notices

## Bundled Reed–Solomon Engine

`include/arknet/thirdparty/fecpp.hpp` adapts [fecpp](https://github.com/randombit/fecpp)
at commit `d7e9b41eaaab3c605be36f282465210d17bc432f` as a portable C++20 header-only
engine. Copyright (c) 1997–1998 Luigi Rizzo, 2009–2010 Jack Lloyd, and 2011 Billy
Brumley is retained. The BSD-2-Clause license is installed alongside the header
as `include/arknet/thirdparty/fecpp.LICENSE`. The unchanged pinned source in
`tests/vendor/fecpp/` is an independent parity/recovery reference, with its license.

## External Asio and TLS Dependencies

Standalone Asio and official Boost are external dependencies, selected by the
build configuration. Their distributions contain the applicable BSL-1.0
notices. OpenSSL is an optional TLS dependency, licensed under Apache-2.0 for
3.x and the OpenSSL/SSLeay licenses for 1.1.1. Consult the actual distribution.

`ports/asio` downloads the official standalone Asio 1.38.2 distribution with a
pinned checksum; its BSL-1.0 license is installed with the dependency.

## Development and Documentation Dependencies

`tests/vendor/doctest/doctest.h` is doctest 2.5.3, copyright (c) 2016-2023
Viktor Kirilov, under the MIT License preserved in
`tests/vendor/doctest/LICENSE.txt`. It is used only by development tests.

`tests/vendor/kcp/ikcp.c` and `ikcp.h` are the canonical KCP implementation
at commit `b1a7a2101dcbb96017681a500d6b82bbe5a88766`, copyright (c) 2017
Lin Wei (skywind3000), under the MIT license retained in `tests/vendor/kcp/LICENSE`.
They are independent interoperability test references, not runtime dependencies
or installed headers. The C++ ARQ core is maintained by OpenArkStudio under BSL-1.0.

The documentation uses [Cloudflare Nimbus](https://github.com/cloudflare/nimbus)
0.17.0 and its 0.7.11 starter, copyright (c) 2025 Cloudflare, Inc., under MIT.
The starter license is preserved in [docs/site/LICENSE](https://github.com/OpenArkStudio/arknet/blob/main/docs/site/LICENSE).
Astro, Tailwind CSS, Pagefind and the Markdown tooling are build dependencies;
their applicable licenses are distributed with the locked npm packages.
The optional local report generator uses
[Matplotlib](https://matplotlib.org/stable/project/license.html).
These tools do not become networking-library dependencies.
| Dependency | Use | Upstream license |
| --- | --- | --- |
| [fecpp · d7e9b41](https://github.com/randombit/fecpp/tree/d7e9b41eaaab3c605be36f282465210d17bc432f) | Portable C++20 header-only Reed–Solomon adaptation; unchanged test reference | [BSD-2-Clause](https://github.com/randombit/fecpp/blob/d7e9b41eaaab3c605be36f282465210d17bc432f/license.txt) |
| Standalone Asio / Boost | External dependencies selected by build configuration | [Asio BSL-1.0](https://github.com/chriskohlhoff/asio/blob/asio-1-38-2/LICENSE_1_0.txt), [Boost BSL-1.0](https://www.boost.org/LICENSE_1_0.txt) |
| OpenSSL | Optional TLS | [3.x Apache-2.0](https://github.com/openssl/openssl/blob/openssl-3.0.0/LICENSE.txt), [1.1.1 OpenSSL/SSLeay](https://github.com/openssl/openssl/blob/OpenSSL_1_1_1-stable/LICENSE) |
| doctest 2.5.3 | Development tests only | [MIT](https://github.com/doctest/doctest/blob/v2.5.3/LICENSE.txt) |
| [KCP · b1a7a21](https://github.com/skywind3000/kcp/tree/b1a7a2101dcbb96017681a500d6b82bbe5a88766) | Canonical `ikcp.c`/`ikcp.h` interoperability reference only; not a runtime dependency or installed header | [MIT](https://github.com/skywind3000/kcp/blob/b1a7a2101dcbb96017681a500d6b82bbe5a88766/LICENSE) |
| Cloudflare Nimbus 0.17.0 / starter 0.7.11 | Documentation | [MIT](https://github.com/cloudflare/nimbus/blob/main/LICENSE) |
| Astro / Tailwind CSS / Pagefind / Markdown tooling | Documentation builds; licenses accompany locked npm packages | [Astro](https://github.com/withastro/astro/blob/main/LICENSE), [Tailwind CSS](https://github.com/tailwindlabs/tailwindcss/blob/main/LICENSE), [Pagefind](https://github.com/Pagefind/pagefind/blob/main/LICENSE), [locked packages](https://github.com/OpenArkStudio/arknet/blob/main/docs/site/package-lock.json) |
| Matplotlib | Optional local report generator | [License](https://matplotlib.org/stable/project/license.html) |

## Retained notices and distribution

- fecpp: copyright (c) 1997–1998 Luigi Rizzo, 2009–2010 Jack Lloyd, 2011 Billy Brumley. `include/arknet/thirdparty/fecpp.LICENSE` is installed beside `fecpp.hpp`; `tests/vendor/fecpp/` retains the pinned original source and license for independent parity/recovery checks.
- doctest: copyright (c) 2016–2023 Viktor Kirilov; retained in `tests/vendor/doctest/LICENSE.txt`. KCP: copyright (c) 2017 Lin Wei (skywind3000); retained in `tests/vendor/kcp/LICENSE`. OpenArkStudio maintains the C++ ARQ core under BSL-1.0.
- Nimbus/starter: copyright (c) 2025 Cloudflare, Inc.; starter license retained in [docs/site/LICENSE](https://github.com/OpenArkStudio/arknet/blob/main/docs/site/LICENSE).

`ports/asio` downloads official Standalone Asio 1.38.2 with a pinned checksum and installs its BSL-1.0 license. External distributions supply their applicable licenses/notices; consult the actual distribution. Documentation/report tools are not networking-library dependencies.
53 changes: 18 additions & 35 deletions docs/project/third-party-notices_CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,37 +1,20 @@
# 第三方声明

## 内置 Reed–Solomon 编码引擎

`include/arknet/thirdparty/fecpp.hpp` 将 [fecpp](https://github.com/randombit/fecpp)
的固定提交 `d7e9b41eaaab3c605be36f282465210d17bc432f` 适配为 C++20 header-only 实现。
保留 copyright (c) 1997–1998 Luigi Rizzo、2009–2010 Jack Lloyd 和 2011 Billy Brumley。
BSD-2-Clause 许可证与头文件一起安装，路径为 `include/arknet/thirdparty/fecpp.LICENSE`。
`tests/vendor/fecpp/` 保留相同提交的原始源码和许可证，用于独立校验编码与恢复结果。

## 外部 Asio 与 TLS 依赖

Standalone Asio 和官方 Boost 由构建配置选择，属于外部依赖，其分发包保留适用的
BSL-1.0 声明。OpenSSL 是可选的 TLS 依赖；3.x 使用 Apache-2.0，1.1.1 使用
OpenSSL/SSLeay 许可证。以实际使用的分发包为准。

`ports/asio` 使用固定校验和下载官方 standalone Asio 1.38.2 分发包；
依赖安装时保留其 BSL-1.0 许可证。

## 开发与文档依赖

`tests/vendor/doctest/doctest.h` 使用 doctest 2.5.3，版权所有 (c) 2016-2023
Viktor Kirilov；MIT 许可证保存在 `tests/vendor/doctest/LICENSE.txt`，仅用于开发测试。

`tests/vendor/kcp/ikcp.c` 与 `ikcp.h` 是固定提交
`b1a7a2101dcbb96017681a500d6b82bbe5a88766` 的官方 KCP 实现，
copyright (c) 2017 Lin Wei (skywind3000)，MIT 许可证保存在 `tests/vendor/kcp/LICENSE`。
它们仅作为独立互通测试对照，不属于运行时依赖，也不会安装为公开头文件。
C++ ARQ 核心由 OpenArkStudio 维护，使用 BSL-1.0。

文档使用 [Cloudflare Nimbus](https://github.com/cloudflare/nimbus) 0.17.0
和 0.7.11 starter，copyright (c) 2025 Cloudflare, Inc.，采用 MIT。
starter 的许可证保存在 [docs/site/LICENSE](https://github.com/OpenArkStudio/arknet/blob/main/docs/site/LICENSE)。
Astro、Tailwind CSS、Pagefind 和 Markdown 工具仅用于文档构建；各自许可证随锁定版本的 npm 包分发。
可选的本地报告生成器使用
[Matplotlib](https://matplotlib.org/stable/project/license.html)。
这些工具不是网络库的依赖。
| 依赖 | 用途 | 上游许可证 |
| --- | --- | --- |
| [fecpp · d7e9b41](https://github.com/randombit/fecpp/tree/d7e9b41eaaab3c605be36f282465210d17bc432f) | 可移植 C++20 header-only Reed–Solomon 适配；未修改的测试对照 | [BSD-2-Clause](https://github.com/randombit/fecpp/blob/d7e9b41eaaab3c605be36f282465210d17bc432f/license.txt) |
| Standalone Asio／Boost | 由构建配置选择的外部依赖 | [Asio BSL-1.0](https://github.com/chriskohlhoff/asio/blob/asio-1-38-2/LICENSE_1_0.txt)、[Boost BSL-1.0](https://www.boost.org/LICENSE_1_0.txt) |
| OpenSSL | 可选 TLS | [3.x Apache-2.0](https://github.com/openssl/openssl/blob/openssl-3.0.0/LICENSE.txt)、[1.1.1 OpenSSL/SSLeay](https://github.com/openssl/openssl/blob/OpenSSL_1_1_1-stable/LICENSE) |
| doctest 2.5.3 | 仅开发测试 | [MIT](https://github.com/doctest/doctest/blob/v2.5.3/LICENSE.txt) |
| [KCP · b1a7a21](https://github.com/skywind3000/kcp/tree/b1a7a2101dcbb96017681a500d6b82bbe5a88766) | 仅用官方 `ikcp.c`／`ikcp.h` 作互通对照；不是运行时依赖，不安装为头文件 | [MIT](https://github.com/skywind3000/kcp/blob/b1a7a2101dcbb96017681a500d6b82bbe5a88766/LICENSE) |
| Cloudflare Nimbus 0.17.0／starter 0.7.11 | 文档 | [MIT](https://github.com/cloudflare/nimbus/blob/main/LICENSE) |
| Astro／Tailwind CSS／Pagefind／Markdown 工具 | 文档构建，许可证随锁定版本的 npm 包分发 | [Astro](https://github.com/withastro/astro/blob/main/LICENSE)、[Tailwind CSS](https://github.com/tailwindlabs/tailwindcss/blob/main/LICENSE)、[Pagefind](https://github.com/Pagefind/pagefind/blob/main/LICENSE)、[锁定包](https://github.com/OpenArkStudio/arknet/blob/main/docs/site/package-lock.json) |
| Matplotlib | 可选本地报告生成器 | [许可证](https://matplotlib.org/stable/project/license.html) |

## 保留声明与分发

- fecpp：copyright (c) 1997–1998 Luigi Rizzo、2009–2010 Jack Lloyd、2011 Billy Brumley。`include/arknet/thirdparty/fecpp.LICENSE` 与 `fecpp.hpp` 一起安装；`tests/vendor/fecpp/` 保留固定提交的原始源码和许可证，用于独立校验编码与恢复结果。
- doctest：copyright (c) 2016–2023 Viktor Kirilov，保留在 `tests/vendor/doctest/LICENSE.txt`。KCP：copyright (c) 2017 Lin Wei (skywind3000)，保留在 `tests/vendor/kcp/LICENSE`。C++ ARQ 核心由 OpenArkStudio 维护，使用 BSL-1.0。
- Nimbus／starter：copyright (c) 2025 Cloudflare, Inc.，starter 许可证保留在 [docs/site/LICENSE](https://github.com/OpenArkStudio/arknet/blob/main/docs/site/LICENSE)。

`ports/asio` 以固定校验和下载官方 Standalone Asio 1.38.2，并安装其 BSL-1.0 许可证。外部分发包提供适用的许可证／声明，以实际分发包为准。文档／报告工具不是网络库依赖。
Loading