Skip to content

sbplugin: Starboard's API through STARBOARD_API_SOCKET when given (DASH-482) - #37

Merged
TheMightyTRex merged 1 commit into
mainfrom
plugin-api-reach
Nov 19, 2026
Merged

TheMightyTRex merged 1 commit into
mainfrom
plugin-api-reach

Conversation

@TheMightyTRex

Copy link
Copy Markdown
Owner

Starboard part: TheMightyTRex/starboard issue 202 (DASH-482). Plug-ins on their own internal network, such as Disk forecast and Download summary, cannot reach Starboard, which runs on the server's own network. Starboard now keeps a Unix socket in each active plug-in's run folder and gives it as STARBOARD_API_SOCKET (/run/starboard/api.sock).

  • _shared/sbplugin.py: starboard() sends its request through the socket when the file is there, with the path from STARBOARD_API and the plug-in's key; a refusal raises HTTPError as urlopen does. Without the socket (an older Starboard) it calls STARBOARD_API over HTTP as before.
  • Every copy of the shared helper is updated (tools/make_examples.py, and the six folders it does not write). Remote access and Picture shrinker keep their own copies; both are on the lan network, which reaches Starboard over HTTP since pull request 201 in Starboard.
  • tests/test_api_socket.py: the socket is used when given, a refusal raises, and HTTP is used without it.
  • help/developers/plug-in-api.md: a line in the rules.

No version numbers or images changed: the plug-ins need a new version and image build to carry this to servers, which waits for the owner's OK.

🤖 Generated with Claude Code

…SH-482)

A plug-in on its own internal network, such as Disk forecast or Download
summary, has no route to Starboard, which runs on the server's own network.
Starboard now keeps a socket in the plug-in's run folder; starboard() uses it
when it is there and STARBOARD_API over HTTP otherwise, so older Starboards
still work. Every copy of the shared helper is updated.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@TheMightyTRex
TheMightyTRex merged commit 985c491 into main Nov 19, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant