Commit graph

252 commits

Author SHA1 Message Date
DESKTOP-RTLN3BA\$punk
4a05a114ab chore: plain Apache LICENSE, and the site and README say the plugins have shipped
- LICENSE is the plain Apache 2.0 text, without the "Portions of this
  software" preamble, so GitHub's About panel names the license. The two BSL
  folders keep their own LICENSE, which names each folder as its scope; the
  README's License section and the Terms page now name both, and the Terms
  point at the LICENSE files rather than the root one alone.
- /plugins: the eight plugins shipped in 2.2.1, with what each reads, how to
  start (download, free 30-day licence, Settings › Plugins, @ in a chat),
  third-party plugins and the registry, and why Reddit and Instagram are not
  offered.
- /pricing: 7 platforms and the web crawler, not 9; the plugin note, the
  licence and trial answers and the expiry answer describe the shipped
  plugins; third-party plugins need no licence.
- Homepage plugin band: no longer "Coming soon".
- README: a Plugins section linking /downloads for the free licence, in place
  of Star history.
2026-10-15 14:49:37 -07:00
DESKTOP-RTLN3BA\$punk
4dd3ce2f66 docs: cover the work since 2.1.0 so others can pick it up
- chat.md, overview.md: how a streamed token renders only the live reply
  (runSummaries, the 32 ms notice gap, LiveThreadRuntime, the bounded
  highlighter, memoized panels) and that the columns resize.
- model-capabilities.md, agent.md, data-model.md, 07-dev-setup.md: the two
  chat modes, their gates and defaults, where a pick is stored, the 0-id fix,
  and how to re-run the OpenRouter sweep and regenerate capabilities.json.
- RELEASE.md: the steps 2.2.0 was released by, from the bump (with its
  PowerShell form) to the tag on the merge, the Known issues, an optional
  update check and publishing with --latest; dry runs are signed.
- 06-repo-readme.md, AGENTS.md, README.md's comment: the README's structure,
  how to change it and its translations, re-checking the format table, and
  replacing the demo video.
- Stale statements fixed (the Apple agreement, opencode never shipped, three
  languages, Studio's exec(), proposal statuses, the roadmap), and each gap
  still open after the release in its doc's Known gaps, linked to #2219-#2230.
2026-10-11 17:55:51 -07:00
DESKTOP-RTLN3BA\$punk
799a683296 feat(agent): ship opencode in every installer
Every model may now choose the agent, so every build stages opencode and
ripgrep: ENABLED_BY_DEFAULT is true, and SURFSENSE_LOCAL_OPENCODE_ENABLED=0
leaves them out of one build. The docs that said installers carry no agent now
say they do, and packaging.md records the Windows stage's size (185 MB
unpacked, 44 MB as xz) and that electron-builder signs opencode and rg with the
app's inherited entitlements, whose allow-jit Bun needs.
2026-10-07 13:09:12 -07:00
DESKTOP-RTLN3BA\$punk
2327494854 docs(file-agent): propose the file agent and plan its first slice
The file-agent proposal (docs/proposals/file-agent/) covers folders and
source roots, skills and engines, editable artifacts, runtime packs, the
model ladder and evals, and the product shape: one kind of workspace whose
offer follows the selected model's measured capability. Stream 07 plans
the first slice: the agent creates a Word or PDF file in chat and refines
it through a document script it keeps, with source figures, charts and
page previews.

ADR 0039 lets model-written document scripts run without approval in
SurfSense's script runner and denies the agent's shell, superseding part
of ADR 0028. The business strategy keeps all job content open source.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-04 02:48:06 -07:00
ybai08
a4d37ce20e docs(sunset): export the purge fallback, and allow the web app's build-time cloud mode 2026-10-01 11:24:15 -05:00
ybai08
c0ac35be46 docs(sunset): say in both runbooks that the flag needs DEPLOYMENT_MODE=cloud
is_sunset_mode() is false unless DEPLOYMENT_MODE=cloud and SUNSET_MODE is truthy,
and since #2023 the web redirect has the same condition. Both runbooks read as
though SUNSET_MODE were the whole switch, and the purge runbook's fallback
command set only that one, so following it literally still refused.
2026-10-01 11:24:15 -05:00
DESKTOP-RTLN3BA\$punk
1d454b5bee docs(seo): add the B2B artifact-jobs research and its keyword data
Some checks are pending
Build and Push Docker Images / image_version (push) Waiting to run
Build and Push Docker Images / build (./docker/sandbox, cpu, ./docker/sandbox/Dockerfile, sandbox, surfsense-sandbox, ubuntu-24.04-arm, linux/arm64, arm64, , false, cpu) (push) Blocked by required conditions
Build and Push Docker Images / build (./docker/sandbox, cpu, ./docker/sandbox/Dockerfile, sandbox, surfsense-sandbox, ubuntu-latest, linux/amd64, amd64, , false, cpu) (push) Blocked by required conditions
Build and Push Docker Images / build (./surfsense_backend, cpu, ./surfsense_backend/Dockerfile, backend, surfsense-backend, ubuntu-24.04-arm, linux/arm64, arm64, , production, false, cpu) (push) Blocked by required conditions
Build and Push Docker Images / build (./surfsense_backend, cpu, ./surfsense_backend/Dockerfile, backend, surfsense-backend, ubuntu-latest, linux/amd64, amd64, , production, false, cpu) (push) Blocked by required conditions
Build and Push Docker Images / build (./surfsense_backend, cu126, ./surfsense_backend/Dockerfile, backend, surfsense-backend, ubuntu-24.04-arm, linux/arm64, arm64, -cuda126, production, true, cuda126) (push) Blocked by required conditions
Build and Push Docker Images / build (./surfsense_backend, cu126, ./surfsense_backend/Dockerfile, backend, surfsense-backend, ubuntu-latest, linux/amd64, amd64, -cuda126, production, true, cuda126) (push) Blocked by required conditions
Build and Push Docker Images / build (./surfsense_backend, cu128, ./surfsense_backend/Dockerfile, backend, surfsense-backend, ubuntu-24.04-arm, linux/arm64, arm64, -cuda, production, true, cuda) (push) Blocked by required conditions
Build and Push Docker Images / build (./surfsense_backend, cu128, ./surfsense_backend/Dockerfile, backend, surfsense-backend, ubuntu-latest, linux/amd64, amd64, -cuda, production, true, cuda) (push) Blocked by required conditions
Build and Push Docker Images / build (./surfsense_web, cpu, ./surfsense_web/Dockerfile, web, surfsense-web, ubuntu-24.04-arm, linux/arm64, arm64, , runner, false, cpu) (push) Blocked by required conditions
Build and Push Docker Images / build (./surfsense_web, cpu, ./surfsense_web/Dockerfile, web, surfsense-web, ubuntu-latest, linux/amd64, amd64, , runner, false, cpu) (push) Blocked by required conditions
Build and Push Docker Images / verify_digests (push) Blocked by required conditions
Build and Push Docker Images / create_manifest (backend, surfsense-backend, , cpu) (push) Blocked by required conditions
Build and Push Docker Images / create_manifest (backend, surfsense-backend, -cuda, cuda) (push) Blocked by required conditions
Build and Push Docker Images / create_manifest (backend, surfsense-backend, -cuda126, cuda126) (push) Blocked by required conditions
Build and Push Docker Images / create_manifest (sandbox, surfsense-sandbox, , cpu) (push) Blocked by required conditions
Build and Push Docker Images / create_manifest (web, surfsense-web, , cpu) (push) Blocked by required conditions
08-b2b-artifact-jobs.md ranks the B2B jobs an agent that creates and
edits artifacts could own, from DataForSEO keyword, clickstream and
ranked-keyword pulls. Security questionnaires and compliance documents,
contract review and redlining, and RFP responses lead; the Excel, Word
and PowerPoint agents are capabilities every job needs, not a play.

The pulls are archived under data/b2b/ beside use-cases.json, the term
mapping, and rollup.py, which regenerates the doc's tables and carries
a --self-check. data/README.md documents the files and the call shapes.

Clickstream shows none of the June-August step in Google Ads volumes,
so the privacy-cluster readings in 01 and 07 are flagged for a re-pull
after mid-October. Neither doc is changed here.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-09-29 16:18:14 -07:00
Anish Sarkar
7381258aa1 docs(readme): swap the hero screenshot for desktop.png
Point every README translation and the SEO planning docs at the new
desktop screenshot. It still shows Studio open with Qwen selected, so
the alt text stays as it was. Remove the now-unused offline-studio.png
and comments-audio.webp.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-28 12:29:57 +05:30
DESKTOP-RTLN3BA\$punk
8106b767e1 docs: sync docs and plans with the model catalog work
Check the architecture pages the catalog PRs (#1899-#1902) touched against the code, correct what no longer matches, and add the Known gaps found on the way.

Fix the model catalog proposal's lines about the present, note its revisions on ADRs 0011 and 0015 and in the ADR index, update the SEO fact table for the new manifest, and mark the plugins tree in AGENTS.md as planned until it lands.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-09-23 13:42:11 -07:00
Anish Sarkar
de3a5049e7 docs: describe the local model catalog as built and fix links to its replaced files 2026-09-23 23:38:22 +05:30
DESKTOP-RTLN3BA\$punk
3313fa1448 docs: reorganize engineering docs under docs/
Move the engineering specs out of plans/ into a root docs/ folder.
architecture/ describes what is true in the code now, one doc per
feature. adr/ records decisions: 0003 is restored and 0004-0027 are
new. proposals/ holds designs not built yet: plugins and the CUDA
backend. contracts/ holds the frozen interfaces between trees, with
the fixtures their tests read. ROADMAP.md names the initiatives.

The shipped phase plans are deleted; git history keeps them. plans/
keeps business, launch and ops material only.

Also: CONTRIBUTING.md rewritten around this flow, a CODEOWNERS file,
a Docs section in AGENTS.md, scripts/check_docs.py (was
check_plan_links.py) as a pre-commit hook, the backend tests path
filter extended to docs/contracts, and the five tests that read the
contract fixtures pointed at their new path.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-09-22 21:27:26 -07:00
Anish Sarkar
a55d309e84
Merge pull request #1820 from AnishSarkar22/feat/llama-cpp
feat(llm): llama.cpp runtime: warm loads, per-layer KV pricing, one Hugging Face consent, manifest order over ranks
2026-09-23 05:18:41 +05:30
Anish Sarkar
bdc8e749db refactor(catalog): drop rank/rank_basis for manifest list order, document which fields come from GGUF headers; updated docs as well 2026-09-23 05:12:50 +05:30
Anish Sarkar
5e093b69ac fix(ui): let every installed model be used, not only the curated ones 2026-09-23 00:56:57 +05:30
Anish Sarkar
431914fae0
Merge pull request #1819 from AnishSarkar22/feat/llama-cpp
feat(local): replace Ollama with a bundled llama.cpp runtime, a curated GGUF catalog, and a hardware-aware fit estimator
2026-09-22 14:18:49 +05:30
Anish Sarkar
9d7ee9e244 docs(plans): match phase 7 to the router owning model loads 2026-09-22 14:15:03 +05:30
Anish Sarkar
e8e01d7615 docs(plans): record the header gate and what vision still needs 2026-09-22 12:32:58 +05:30
Anish Sarkar
ff650570c5 feat(llm): gate installs on one denylist, not a generated allowlist
The gate was two lists answering one question: a 152 name table generated
from the pinned libllama, and a 21 name exclusion set beside it. The table
was the only thing that could tell "llama.cpp has no builder for this yet"
from everything else, and it cost a script run at every pin bump, a datas
entry, and a file that had to ship on Windows because the symbol it reads
is not exported there.

Measured against the 1000 most downloaded GGUF repos, it bought less than
it looked like. Dropping it lets 18 of 979 install and then fail, all of
them chat architectures released in the last few weeks. That is accepted:
curated models are the default path, search is opt in, and the failure now
says so instead of telling the reader to try again shortly.

What replaces it is one denylist, grouped by what a model is rather than
by which fact named it, so a GGUF architecture and a repo pipeline tag
share the table. The tag exists because a header can be honest and still
mislead: an embedding model declares mistral3, a voice model declares
qwen3, a reranker declares qwen3. Refusing those architectures would
refuse Mistral and Qwen, so only the tag catches them. It rides along on
the listing call read_repo_facts already makes.

Measured over the same 1000 repos: 75 installs that fail become 18, with
zero refusals of a model that would have worked. The tags that mean chat
are held out by a test, since image-text-to-text alone is 28% of admitted
repos and denying it would empty the search screen.

scripts/audit_gate.py replaces the guard the generated table used to give.
A test held every denylist key against the names llama.cpp defines, which
is how granite-moe, granite-hybrid and nemotron-h were caught refusing
nothing. With no table, a misspelling now shows up in the audit as an
entry that matched no repo in the sample.
2026-09-22 12:19:56 +05:30
Thierry CH.
dfdcd1506d
Merge pull request #1817 from CREDO23/plugins
[Docs|Plugins] Plan the plugin system
2026-09-22 06:55:16 +02:00
Thierry CH.
5038eb2460 docs(plugins): plan the plugin screen and the workstream map
Settings holds install and secrets. An installed entry is a sidebar action, and the umbrella indexes the streams so they can be built in parallel.
2026-09-22 06:44:06 +02:00
Thierry CH.
9e1781a955 docs(plugins): plan catalog checks, install, and publish
A pull request is checked before merge. CI builds the tarball, and the app installs it on demand from a catalog shipped with the desktop build.
2026-09-22 06:44:06 +02:00
Thierry CH.
c19e33a358 docs(plugins): plan the worker that starts a plugin and stores what it wrote
One process per run. After it exits, document lines become notes and anything else stays on the run.
2026-09-22 06:44:06 +02:00
Thierry CH.
ee98e7ad60 docs(plugins): plan the SDK and the interpreter that runs it
Authors import a library that stays in the repo. The packaged app needs a real Python because the frozen API and worker cannot execute plugin source.
2026-09-22 06:44:06 +02:00
Thierry CH.
43baf94cc3 docs(plugins): specify how a plugin run starts and returns results
The app spawns a process with inputs and secrets, and imports a results file when it exits. The plugin does its own HTTP.
2026-09-22 06:44:06 +02:00
DESKTOP-RTLN3BA\$punk
6f59919992 feat(release): permalink downloads via unversioned asset names
GitHub's Latest badge now points at the newest 2.x release instead of
legacy v0.0.40. The legacy 0.0.x desktop resolves updates through
/releases/latest and reads latest*.yml from whatever it names, so a
legacy-update-bridge job copies v0.0.40's manifests onto every release
with a `tag: v0.0.40` key. electron-updater honours that over the
release it resolved, so those clients still land on v0.0.40 and its
/sunset redirect, and the installers still come from v0.0.40's own
assets with nothing duplicated.

Artifact names drop ${version}, which makes
/releases/latest/download/<name> a permalink the README and the site
can hardcode. Safe for auto-update: a cached download is validated by
sha512 before it is installed, and every consumer labels assets by
suffix rather than by full name.

Also corrects docs and comments that asserted the pin was permanent,
including a stale bug report in the SEO brief -- the site's hero
already resolves by tag.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-09-21 13:46:15 -07:00
Anish Sarkar
8845e626aa feat(plans): update teh llamacpp-runtime plan to match the current path 2026-09-21 20:14:43 +05:30
Anish Sarkar
a44c0b0d3f docs(local): record the fit estimator's measurements in phase 7 2026-09-21 17:02:44 +05:30
Anish Sarkar
2d91219d51 docs(local): update the README and phase 7 spec for the llama.cpp runtime
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-09-20 20:07:43 +05:30
Anish Sarkar
9c5935ceef docs(spec): close the gaps a build order found in phase 7 2026-09-19 22:20:29 +05:30
Anish Sarkar
7cac4f351d feat(spec): gate recommendations on speed, pick KV precision by fit 2026-09-19 22:03:41 +05:30
Anish Sarkar
d8f7947265 docs(spec): strip the superseded recommendation half out of 05a 2026-09-19 20:37:05 +05:30
Anish Sarkar
53985064f2 feat(spec): move rank into the variant, self-calibrate the overhead 2026-09-19 20:36:41 +05:30
Anish Sarkar
2b49c04828 feat(spec): ship Vulkan everywhere, defer CUDA to phase 8 2026-09-19 20:28:59 +05:30
Anish Sarkar
e5f6ec1f81 feat(spec): drop llmfit and Ollama from the llama.cpp plan
Phase 7 now replaces the Ollama sidecar with a packaged llama-server
and stops shipping llmfit entirely. Hardware comes from
ggml_backend_dev_memory() via ctypes; scoring moves offline to a
maintainer machine and ships as data in curated-models.json.

- 07-llamacpp-runtime: add Contracts, authoring and appendix sections;
  pin one quantization per entry, fix context at load, defer manifest
  growth and speed gating out of v1
- 05c-packaging: replace the llmfit section with llama-server staging,
  split the catalog and Hugging Face search routes, make .gguf import
  a first-class offline path
- 05b-connections: rename provider ollama -> llamacpp, note revision
  0012 rebuilds selected_models for the CHECK constraint
- 00c-data-model: rename egress destinations to model_download and
  model_search
- 00b-diagrams, frontend/01-shell, frontend/05-install-ux: follow the
  same rename and drop the scan step from the install flow
2026-09-19 15:30:22 +05:30
Anish Sarkar
c125c378ef feat(spec): update llamacpp spec 2026-09-19 14:33:46 +05:30
Anish Sarkar
33504e1a2b feat(spec): add llama.cpp runtime spec 2026-09-19 12:59:12 +05:30
CREDO23
35c83caa82 chore: drop leftover skills, plans, and unused docker extras
Clear the SEO skill dump and shipped-phase plans so they can be rebuilt later. Leave Azure compose (SearxNG, sandbox, zero-cache) and license/export contracts untouched.
2026-09-18 08:51:33 +02:00
CREDO23
bbf995931f docs: ship the 2.0 README for the local desktop app
The live page still described the hosted open-web product. Point it at the air-gapped app, the Studio still, and the 18 October export deadline.
2026-09-18 08:44:12 +02:00
DESKTOP-RTLN3BA\$punk
a96ce156b3 feat(local): pre release tweaks 2026-09-17 21:18:44 -07:00
DESKTOP-RTLN3BA\$punk
04876983e4 feat(seo): updated seo statergy
- Added a new page focused on transforming documents into professional deliverables, reflecting user demand for practical applications over academic use.
- Updated keyword research to emphasize business-oriented terms, including "private ai for business" and "secure ai for business," based on user data analysis.
- Revised existing documents to align with findings from production chat data, highlighting the shift in user intent from study to professional tasks.
- Introduced new data files for keyword ideas and overviews to support the updated strategy.
2026-09-17 16:36:27 -07:00
DESKTOP-RTLN3BA\$punk
f1bcb820f3 chore(local): synced plans 2026-09-17 15:23:27 -07:00
Anish Sarkar
6c9af98a5e git commit -m "docs(plans): move llmfit catalog expansion spec into api/05d
Relocate LLMFIT_MODEL_CATALOG_EXPANSION_SPEC.md into
plans/community-local/api/, alongside 05a-model-recommendations.md
which owns the recommendations module this spec extends, and retitle
it to match the phase-numbered convention used by its siblings.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>"
2026-09-17 20:16:15 +05:30
CREDO23
c58b4296ac Merge branch 'pr-1777' into sunset-fixes
# Conflicts:
#	surfsense_local/frontend/src/components/ui/icons.tsx
#	surfsense_local/frontend/src/features/updates/update-settings.test.tsx
#	surfsense_local/frontend/src/features/updates/update-settings.tsx
#	surfsense_web/lib/auth-utils.ts
2026-09-17 07:06:57 +02:00
DESKTOP-RTLN3BA\$punk
6b1e412151 chore: added initial readme drafts 2026-09-15 13:32:57 -07:00
DESKTOP-RTLN3BA\$punk
aeefaabcbd feat(pivot): update marketing and SEO strategies for community-local plans
- Revised marketing strategies to include a rewritten landing page, pricing, downloads, and the `/free` route, ensuring alignment with the new positioning.
- Documented decisions regarding the retention and rewriting of the `/free` page to target no-signup traffic, emphasizing its value.
- Added comprehensive keyword research and page briefs to guide the content strategy for public pages, enhancing SEO efforts across multiple markets.
- Established clear routes and content requirements for portal pages, including sunset flags and license handling.
- Created detailed specifications for competitor analysis and SERP landscape to inform future content development.
2026-09-14 22:05:40 -07:00
DESKTOP-RTLN3BA\$punk
e65cb8a718 refactor(local): update licensing and Keygen integration details in documentation
- Revised the license file format to reflect the use of self-hosted Keygen CE.
- Clarified the configuration requirements for Keygen integration.
- Updated portal documentation to specify the handling of license routes and delivery processes.
- Added notes on the implications of self-hosting Keygen, including testing and contract management.
2026-09-14 18:07:53 -07:00
Anish Sarkar
e7bccd1835 feat(sunset): add the T-0 and T+30 runbooks and the account purge script 2026-09-15 00:18:22 +05:30
Anish Sarkar
c4610e7cc9 docs(sunset): note that /sunset and /downloads share the same by-tag links 2026-09-15 00:03:24 +05:30
Thierry CH.
20c5fef6b9 docs: plan status and portal page flows 2026-09-14 19:26:15 +02:00
Anish Sarkar
57a32f506b test(mail): cover the real SMTP path against Mailpit, fix trial's 500 on Keygen failure 2026-09-14 01:05:32 +05:30