vrr/SurfSense
2
0
Fork 0
mirror of https://github.com/MODSetter/SurfSense.git synced 2026-10-21 05:05:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
SurfSense/docs/architecture/about.md

2.5 KiB
Raw Permalink Blame History

About

Settings › About, in the dialog's App group, shows which build is running and where to get help: the version, the update controls, links and the license. Bug reports and Copy system info are in Settings › Report issue (issue reports).

Code: surfsense_local/frontend/src/features/about/, surfsense_local/electron/src/main/about/, surfsense_local/electron/src/main/external-url.ts

What it shows

  • The version, from app.getVersion() in the main process, read through window.surfsense.about.details(). The same call returns the OS, architecture, and the Electron, Chromium and Node versions.
  • The update controls (updates), which moved here from General.
  • Your data: the folder that holds models, workspaces and settings, ~/.surfsense, which the install folder does not, with Open folder to show it in the file manager. Main returns the path only to the app's own window, through window.surfsense.about.dataFolder(), and opens it with shell.openPath (data-folder-ipc.ts). It is not part of the details Copy system info puts in a report, since it names the user's home folder.
  • Links: release notes for the running version (/releases/tag/v<version>), the docs on surfsense.com, the GitHub repository, and the Discord invite.
  • The license line, Apache 2.0, linking to LICENSE on GitHub.

Links

Every link opens in the OS browser, only on a click, through shell:open-external. The main process opens only surfsense.com, the MODSetter/SurfSense repository on GitHub, and the Discord invite, and drops anything else (egress). A link added here that falls outside that list does nothing until the list grows.

Outside the desktop app there is no bridge: the version, release notes and data folder rows are hidden, and the remaining links are plain anchors.

Known gaps

  • The app does not show its third-party license notices. They are generated at build time and ship as resources/licenses/THIRD_PARTY_NOTICES.json and .txt (packaging), but nothing in Settings › About opens them yet.
  • The app writes no log files, so there is no logs folder to open. This run's output is kept in memory and shown in Report issue (issue reports), and is gone once the app quits.