API-only mode #111

Closed
opened 2026-06-09 09:09:07 +00:00 by ian · 0 comments
Owner

To avoid over-burdening the main spothole.app server, it's likely in future that I will move to requesting that owners of client software with heavy usage run their own spothole server. As these client owners may not want a full web-based cluster that users may stumble upon, it would be nice to have an "API-only" mode. This should be controlled by a flag in the config file that allows the use of the web UI. If set false, the server should only expose the API endpoints, the OpenAPI spec page, and a minimal HTML page at the root which just shows basic server info like version & owner, an explanation that the web UI is disabled, and points users to the OpenAPI spec page.

To avoid over-burdening the main spothole.app server, it's likely in future that I will move to requesting that owners of client software with heavy usage run their own spothole server. As these client owners may not want a full web-based cluster that users may stumble upon, it would be nice to have an "API-only" mode. This should be controlled by a flag in the config file that allows the use of the web UI. If set false, the server should only expose the API endpoints, the OpenAPI spec page, and a minimal HTML page at the root which just shows basic server info like version & owner, an explanation that the web UI is disabled, and points users to the OpenAPI spec page.
ian added this to the 1.4 milestone 2026-06-09 09:09:12 +00:00
ian self-assigned this 2026-06-09 09:09:13 +00:00
ian closed this issue 2026-06-09 09:38:21 +00:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
ian/spothole#111
No description provided.