docs: roundtable rename sweep

Sweeps README, docs/, example configs, code docstrings, report and notification subject lines, plugin catalog URL default, and stray comments in Dockerfile/entrypoint.sh/.gitignore. Adds a legacy note to docs/core/configuration.md explaining the FABLEDSCRYER_* fallback. docker-compose DB credentials intentionally left as fabledscryer to preserve the existing pgdata volume.
2026-04-13 20:16:25 -04:00
parent 55a4fac3e9
commit 0596f1d9c1
20 changed files with 166 additions and 164 deletions
@@ -1,10 +1,10 @@
-# fabledscryer-plugins / index.yaml
+# roundtable-plugins / index.yaml
 #
-# This file is the catalog index for the fabledscryer plugin repository.
+# This file is the catalog index for the roundtable plugin repository.
 # It is fetched by the app's Settings → Plugins → Plugin Catalog UI.
 #
-# Fabled Scryer reads this file from:
-#   https://git.fabledsword.com/bvandeusen/FabledScryer-plugins/raw/branch/main/index.yaml
+# Roundtable reads this file from:
+#   https://git.fabledsword.com/bvandeusen/Roundtable-plugins/raw/branch/main/index.yaml
 #
 # After adding or updating a plugin entry, commit and push — the change is
 # live immediately for anyone whose app fetches the catalog (cache TTL: 5 min).
@@ -25,7 +25,7 @@
 #
 # Download URL conventions:
 #   Gitea release assets (recommended):
-#     https://git.fabledsword.com/bvandeusen/FabledScryer-plugins/releases/download/traefik-v1.0.0/traefik.zip
+#     https://git.fabledsword.com/bvandeusen/Roundtable-plugins/releases/download/traefik-v1.0.0/traefik.zip
 #   Upload the zip as a release attachment in Gitea; paste the URL here.
 #   Source archive tarballs work too but release assets are preferred (smaller, plugin-only).

@@ -37,12 +37,12 @@ plugins:
  - name: http
    version: "1.0.0"
    description: "Synthetic HTTP endpoint monitoring — status code, response time, content match, TLS expiry"
-    author: "FabledScryer"
+    author: "Roundtable"
    license: "MIT"
    min_app_version: "0.1.0"
-    repository_url: "https://git.fabledsword.com/bvandeusen/FabledScryer-plugins"
-    homepage: "https://git.fabledsword.com/bvandeusen/FabledScryer-plugins/src/branch/main/http"
-    download_url: "https://git.fabledsword.com/bvandeusen/FabledScryer-plugins/releases/download/http-v1.0.0/http.zip"
+    repository_url: "https://git.fabledsword.com/bvandeusen/Roundtable-plugins"
+    homepage: "https://git.fabledsword.com/bvandeusen/Roundtable-plugins/src/branch/main/http"
+    download_url: "https://git.fabledsword.com/bvandeusen/Roundtable-plugins/releases/download/http-v1.0.0/http.zip"
    checksum_sha256: ""
    tags:
      - monitoring
@@ -53,12 +53,12 @@ plugins:
  - name: docker
    version: "1.0.0"
    description: "Docker container status, resource usage, and restart tracking via Docker socket"
-    author: "FabledScryer"
+    author: "Roundtable"
    license: "MIT"
    min_app_version: "0.1.0"
-    repository_url: "https://git.fabledsword.com/bvandeusen/FabledScryer-plugins"
-    homepage: "https://git.fabledsword.com/bvandeusen/FabledScryer-plugins/src/branch/main/docker"
-    download_url: "https://git.fabledsword.com/bvandeusen/FabledScryer-plugins/releases/download/docker-v1.0.0/docker.zip"
+    repository_url: "https://git.fabledsword.com/bvandeusen/Roundtable-plugins"
+    homepage: "https://git.fabledsword.com/bvandeusen/Roundtable-plugins/src/branch/main/docker"
+    download_url: "https://git.fabledsword.com/bvandeusen/Roundtable-plugins/releases/download/docker-v1.0.0/docker.zip"
    checksum_sha256: ""
    tags:
      - containers
@@ -68,12 +68,12 @@ plugins:
  - name: traefik
    version: "1.0.0"
    description: "Traefik reverse proxy metrics and access log integration"
-    author: "FabledScryer"
+    author: "Roundtable"
    license: "MIT"
    min_app_version: "0.1.0"
-    repository_url: "https://git.fabledsword.com/bvandeusen/FabledScryer-plugins"
-    homepage: "https://git.fabledsword.com/bvandeusen/FabledScryer-plugins/src/branch/main/traefik"
-    download_url: "https://git.fabledsword.com/bvandeusen/FabledScryer-plugins/releases/download/traefik-v1.0.0/traefik.zip"
+    repository_url: "https://git.fabledsword.com/bvandeusen/Roundtable-plugins"
+    homepage: "https://git.fabledsword.com/bvandeusen/Roundtable-plugins/src/branch/main/traefik"
+    download_url: "https://git.fabledsword.com/bvandeusen/Roundtable-plugins/releases/download/traefik-v1.0.0/traefik.zip"
    checksum_sha256: ""   # fill in after running: sha256sum traefik.zip
    tags:
      - proxy
@@ -83,12 +83,12 @@ plugins:
  - name: unifi
    version: "1.0.0"
    description: "UniFi Network controller integration — WAN health, devices, clients, DPI"
-    author: "FabledScryer"
+    author: "Roundtable"
    license: "MIT"
    min_app_version: "0.1.0"
-    repository_url: "https://git.fabledsword.com/bvandeusen/FabledScryer-plugins"
-    homepage: "https://git.fabledsword.com/bvandeusen/FabledScryer-plugins/src/branch/main/unifi"
-    download_url: "https://git.fabledsword.com/bvandeusen/FabledScryer-plugins/releases/download/unifi-v1.0.0/unifi.zip"
+    repository_url: "https://git.fabledsword.com/bvandeusen/Roundtable-plugins"
+    homepage: "https://git.fabledsword.com/bvandeusen/Roundtable-plugins/src/branch/main/unifi"
+    download_url: "https://git.fabledsword.com/bvandeusen/Roundtable-plugins/releases/download/unifi-v1.0.0/unifi.zip"
    checksum_sha256: ""
    tags:
      - network
@@ -98,12 +98,12 @@ plugins:
  - name: ups
    version: "1.0.0"
    description: "UPS monitoring via NUT (Network UPS Tools) with Ansible shutdown automation"
-    author: "FabledScryer"
+    author: "Roundtable"
    license: "MIT"
    min_app_version: "0.1.0"
-    repository_url: "https://git.fabledsword.com/bvandeusen/FabledScryer-plugins"
-    homepage: "https://git.fabledsword.com/bvandeusen/FabledScryer-plugins/src/branch/main/ups"
-    download_url: "https://git.fabledsword.com/bvandeusen/FabledScryer-plugins/releases/download/ups-v1.0.0/ups.zip"
+    repository_url: "https://git.fabledsword.com/bvandeusen/Roundtable-plugins"
+    homepage: "https://git.fabledsword.com/bvandeusen/Roundtable-plugins/src/branch/main/ups"
+    download_url: "https://git.fabledsword.com/bvandeusen/Roundtable-plugins/releases/download/ups-v1.0.0/ups.zip"
    checksum_sha256: ""
    tags:
      - ups
@@ -1,12 +1,12 @@
 # Plugin System Overview

-Plugins extend Fabled Scryer with new data sources, UI pages, scheduled tasks, and dashboard widgets. Only enabled plugins are imported — disabled or unlisted plugins have zero runtime overhead.
+Plugins extend Roundtable with new data sources, UI pages, scheduled tasks, and dashboard widgets. Only enabled plugins are imported — disabled or unlisted plugins have zero runtime overhead.

 ---

 ## How Plugins Are Loaded

-Plugin loading happens in step 9 of `create_app()`, after all core blueprints and tasks are registered. The entrypoint is `load_plugins(app)` in `fabledscryer/core/plugin_manager.py`.
+Plugin loading happens in step 9 of `create_app()`, after all core blueprints and tasks are registered. The entrypoint is `load_plugins(app)` in `roundtable/core/plugin_manager.py`.

 For each plugin listed as `enabled: true` in the `PLUGINS` config:

@@ -57,7 +57,7 @@ description: "Does a thing"

 # Optional
 author: "Your Name"
-min_app_version: "0.1.0"   # Minimum Fabled Scryer version required
+min_app_version: "0.1.0"   # Minimum Roundtable version required

 # Default config — merged with user overrides at runtime
 # Access at runtime via: app.config["PLUGINS"]["myplugin"]["my_setting"]
@@ -90,7 +90,7 @@ def setup(app):
 Returns a list of `ScheduledTask` objects. Return `[]` if the plugin has no background tasks. Called after `setup()`, so any app references set in `setup()` are available.

 ```python
-from fabledscryer.core.scheduler import ScheduledTask
+from roundtable.core.scheduler import ScheduledTask

 def get_scheduled_tasks():
    app = _app
@@ -154,7 +154,7 @@ A plugin can contribute a dashboard widget by:
 1. Adding a `GET /widget` route to its blueprint that returns an HTMX HTML fragment
 2. The dashboard template polling that endpoint with HTMX

-The dashboard (`fabledscryer/templates/dashboard/index.html`) currently includes the Traefik widget conditionally based on `traefik_enabled`. To add a new plugin widget, the dashboard route and template both need to be updated to detect and render the new widget. See the Traefik widget implementation as a reference.
+The dashboard (`roundtable/templates/dashboard/index.html`) currently includes the Traefik widget conditionally based on `traefik_enabled`. To add a new plugin widget, the dashboard route and template both need to be updated to detect and render the new widget. See the Traefik widget implementation as a reference.

 ---

@@ -46,7 +46,7 @@ config:

 ## Step 3: Define Models (if needed)

-If your plugin stores data, define SQLAlchemy models using the shared `Base` from `fabledscryer.models.base`.
+If your plugin stores data, define SQLAlchemy models using the shared `Base` from `roundtable.models.base`.

 ```python
 # plugins/myplugin/models.py
@@ -55,7 +55,7 @@ import uuid
 from datetime import datetime
 from sqlalchemy import String, Float, DateTime
 from sqlalchemy.orm import Mapped, mapped_column
-from fabledscryer.models.base import Base
+from roundtable.models.base import Base


 class MyPluginMetric(Base):
@@ -79,7 +79,7 @@ Generate the initial migration:
 # From the project root
 alembic --config alembic.ini revision \
    --autogenerate \
-    --head=fabledscryer@head \
+    --head=roundtable@head \
    --branch-label=myplugin \
    -m "myplugin initial"
 ```
@@ -106,8 +106,8 @@ Keep task logic in a separate file so `__init__.py` stays clean.
 # plugins/myplugin/scheduler.py
 from __future__ import annotations
 import logging
-from fabledscryer.core.scheduler import ScheduledTask
-from fabledscryer.core.alerts import record_metric
+from roundtable.core.scheduler import ScheduledTask
+from roundtable.core.alerts import record_metric

 logger = logging.getLogger(__name__)

@@ -174,8 +174,8 @@ async def _fetch_value(url: str) -> float:
 ```python
 # plugins/myplugin/routes.py
 from quart import Blueprint, current_app, render_template
-from fabledscryer.auth.middleware import require_role
-from fabledscryer.models.users import UserRole
+from roundtable.auth.middleware import require_role
+from roundtable.models.users import UserRole
 from .models import MyPluginMetric

 myplugin_bp = Blueprint("myplugin", __name__, template_folder="templates")
@@ -215,7 +215,7 @@ Templates live in `plugins/myplugin/templates/myplugin/` (the extra nesting avoi
 ```html
 {# plugins/myplugin/templates/myplugin/index.html #}
 {% extends "base.html" %}
-{% block title %}My Plugin — Fabled Scryer{% endblock %}
+{% block title %}My Plugin — Roundtable{% endblock %}
 {% block content %}
 <div class="page-title">My Plugin</div>
 {% for row in rows %}
@@ -283,7 +283,7 @@ On next startup, the plugin will be loaded, its migrations applied, and its blue
 `record_metric()` is how plugins feed data into the alert pipeline. Any metric you write here can be the target of an alert rule created in the UI.

 ```python
-from fabledscryer.core.alerts import record_metric
+from roundtable.core.alerts import record_metric

 # Must be inside an active transaction
 async with session.begin():
@@ -302,11 +302,11 @@ async with session.begin():

 ## Auth in Routes

-Use the `@require_role` decorator from `fabledscryer.auth.middleware`:
+Use the `@require_role` decorator from `roundtable.auth.middleware`:

 ```python
-from fabledscryer.auth.middleware import require_role
-from fabledscryer.models.users import UserRole
+from roundtable.auth.middleware import require_role
+from roundtable.models.users import UserRole

@myplugin_bp.get("/admin-only")
@require_role(UserRole.admin)
@@ -325,13 +325,13 @@ Role hierarchy: `admin > operator > viewer`. Requiring `viewer` grants access to

 ## Publishing to the Catalog

-The official plugin catalog is hosted at `https://git.fabledsword.com/bvandeusen/FabledScryer-plugins`. Anyone can submit a plugin by opening a pull request — first-party and third-party plugins are treated identically by the catalog system.
+The official plugin catalog is hosted at `https://git.fabledsword.com/bvandeusen/Roundtable-plugins`. Anyone can submit a plugin by opening a pull request — first-party and third-party plugins are treated identically by the catalog system.

 ### Repo layout

 ```
-fabledscryer-plugins/
-├── index.yaml          ← catalog index — the only file Fabled Scryer fetches
+roundtable-plugins/
+├── index.yaml          ← catalog index — the only file Roundtable fetches
 ├── myplugin/
 │   ├── plugin.yaml
 │   ├── __init__.py
@@ -381,7 +381,7 @@ myplugin.zip
 Generate the zip and its checksum:

 ```bash
-cd fabledscryer-plugins
+cd roundtable-plugins
 zip -r myplugin.zip myplugin/
 sha256sum myplugin.zip   # paste this into index.yaml checksum_sha256
 ```