Ship third-party license notices for everything in the installer
メンテナーはふだん 1 日以内に返信
@Cedric921 がすでに取り組んでいます。
2026年10月6日 から。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 42/100
- issue の種類
- 機能追加
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- electron, python, typescript
調査の方向性
Read CONTRIBUTING.md, docs/architecture/about.md and docs/architecture/packaging.md; inspect electron-builder.yml and the listed fetch/build scripts to trace shipped artifacts. Start with about-settings.test.tsx and the license-generation test, then run the frontend and Electron tests and typecheck as listed. Done means generated notices for shipped dependencies are available offline in the app, the About documentation is updated, and the known-gap entry is removed.
索引モデルが issue の本文から書いたものです。
説明
The gap
docs/architecture/about.md lists this under Known gaps:
No third-party license notices ship with the app. Generating them needs the frontend's npm dependencies, the Python sidecars' packages and the bundled native binaries collected at build time.
Why it matters
Settings › About has a License section that says SurfSense is Apache 2.0 and links the repository's LICENSE. That is SurfSense's own licence. The installer also ships hundreds of other people's work — the renderer's npm tree, two frozen Python binaries, llama-server, sd-server, audio.cpp and the eSpeak-ng it phonemises through, and the embedding, voice and Docling parser packs — and none of their notices reach the user's machine.
Most of those licences (MIT, BSD, Apache 2.0) require the notice to travel with the binary. A user who wants to know what is in the app they installed, or a company deciding whether they may deploy it, has nowhere to look and no file to point at.
Where
surfsense_local/electron/electron-builder.yml— theextraResourceslist is the inventory of what actually ships:backend/api,backend/worker,frontend/dist,models,llamacpp,sdcpp,audiocpp. Anything not there does not need a notice; anything there does.surfsense_local/frontend/src/features/about/about-settings.tsx— the License section, around theabout_license_titleblock, is where a notices surface would sit.surfsense_local/frontend/src/features/about/about-links.ts— every URL here must also passelectron/src/main/external-url.ts's allowlist, or the click does nothing. A link to a notices page on GitHub is insideMODSetter/SurfSenseand so already allowed; a link anywhere else is not.surfsense_local/backend/scripts/build_binaries.pyand thescripts/fetchers beside it (fetch_embedding_model.py,fetch_bundled_voice.py,fetch_docling_models.py) are where each bundled artefact enters the build, and so where its notice can be collected.
Collect, do not add a dependency. pnpm licenses list --json ships with pnpm (the tree is pinned to [email protected]) and covers both npm trees. Python distribution metadata carries the licence and the classifier, readable from the environment uv sync already builds. The native binaries are fetched by pinned-version scripts that can fetch the licence file alongside the binary.
What done looks like
- A user can read the notices for everything that shipped, from the running app, offline. The app is offline by default and the notices describe what is on this machine, so a link to the web is a weaker answer than a bundled file — but it is yours to choose, with the reason in the PR.
- The notices are produced by the build from the pinned versions, not written by hand. A hand-maintained list is wrong the first time a dependency moves.
- A dependency added to any of the three trees appears in the notices without anyone remembering to do anything.
- Say what you did about the parts that resist automation: a native binary whose release carries no licence file, and a model pack, whose weights have licences of their own.
- Update
docs/architecture/about.md— the What it shows list describes the License line — and delete the Known gaps line in the same PR.
What not to change
The four rows in about-links.ts are constrained by external-url.ts, which drops anything outside surfsense.com, github.com/MODSetter/SurfSense and the Discord invite. Do not widen that allowlist to make a link work; it is an egress boundary, described in egress.
How to verify
surfsense_local/frontend/src/features/about/about-settings.test.tsx covers the About pane. Write the failing test first, on whichever half you start with: that the pane offers the notices, and that the generator produces an entry for a known dependency.
cd surfsense_local/frontend
pnpm test
cd ../electron
pnpm test
pnpm typecheck
Before you start
Read CONTRIBUTING.md, the about doc and the packaging doc, which is where the build's shape is described. Interface strings in surfsense_local follow the translate skill described in AGENTS.md — note that licence text itself is not interface text and is not translated. UI work follows the frontend-workflow skill. This is a big one; comment here with the approach you mean to take before you write much of it, and open your PR against dev, not main.
- 主要言語
- Python
- スター
- 16.3k
- フォーク
- 1.6k
- 平均マージ
- 19時間 14分
- マージ済み PR（30日）
- 252
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
MODSetter/SurfSense のほかの issue
-
Security Scan: stop flagging pinned hashes and test fixtures on release PRs対応中かも @karthikeya1220 が 15 日前に担当しました。 オープンcode quality security
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
MODSetter/SurfSense#2225 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 73/100
メンテナーはふだん 1 日以内に返信
-
Laptop werkt nietオープンbug
難易度 1/5 1時間未満 初心者へのやさしさ 1/100
MODSetter/SurfSense#2369 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
backend bug desktop
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
MODSetter/SurfSense#2366 · コメント 5 件 ·
メンテナーはふだん 1 日以内に返信
-
[bug] 直接把桌面上的这个文件拖进去オープンbug
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
MODSetter/SurfSense#2345 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
MODSetter/SurfSense の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
-
Validate finite output clamping limits in StepPredictor.prepare_clamping_params to prevent silent NaN/Inf propagation対応中かも @muskan-creates352 が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
mllam/neural-lam#848 ·
メンテナーはふだん 2 日以内に返信
-
infra
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
fab-geocommuns/RNB-coeur#1166 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
deepspeedai/DeepSpeed#8951 ·
メンテナーはふだん 2 日以内に返信