Skip to content

Replace Rotom with RotomNG throughout the docs - #53

Open
comstud wants to merge 1 commit into
mainfrom
comstud/rotom-ng
Open

Replace Rotom with RotomNG throughout the docs#53
comstud wants to merge 1 commit into
mainfrom
comstud/rotom-ng

Conversation

@comstud

@comstud comstud commented Aug 15, 2026

Copy link
Copy Markdown

RotomNG is the Go rewrite of the original Node.js Rotom. Devices and Dragonite talk to it unchanged (same websocket protocol, same default ports), but the config format, HTTP API and Prometheus metrics differ, so every install/update instruction needed reworking.

  • rotom/index: RotomNG intro, listener table, links to the RotomNG repo docs, callout pointing at the migration page
  • rotom/config: replace the "under construction" stub with a full TOML reference generated from configs/rotom-ng.toml.example and the defaults in apps/rotom-ng/app/config/config.go
  • rotom/migration: new page covering the og-to-ng conversion script, config key mapping, API/metric renames and UI changes
  • setup/docker: rotom-ng service, ghcr.io/unownhash/rotomng/rotom-ng image, TOML config bind mount, TOML config snippet
  • setup/standard: Go 1.26 + Bun prereqs, clone RotomNG, build with make, run ./rotom-ng, pm2 name rotom-ng, updated update script
  • dragonite/config, index, terminology: RotomNG naming; Dragonite's [rotom] keys are unchanged, only the descriptions

Note the web UI does not send X-Rotom-Secret, so http_listener.secret protects the API but leaves the UI unable to load data. That caveat replaces the old "Rotom has no authentication" wording.

RotomNG is the Go rewrite of the original Node.js Rotom. Devices and
Dragonite talk to it unchanged (same websocket protocol, same default
ports), but the config format, HTTP API and Prometheus metrics differ,
so every install/update instruction needed reworking.

- rotom/index: RotomNG intro, listener table, links to the RotomNG repo
  docs, callout pointing at the migration page
- rotom/config: replace the "under construction" stub with a full TOML
  reference generated from configs/rotom-ng.toml.example and the
  defaults in apps/rotom-ng/app/config/config.go
- rotom/migration: new page covering the og-to-ng conversion script,
  config key mapping, API/metric renames and UI changes
- setup/docker: rotom-ng service, ghcr.io/unownhash/rotomng/rotom-ng
  image, TOML config bind mount, TOML config snippet
- setup/standard: Go 1.26 + Bun prereqs, clone RotomNG, build with
  make, run ./rotom-ng, pm2 name rotom-ng, updated update script
- dragonite/config, index, terminology: RotomNG naming; Dragonite's
  [rotom] keys are unchanged, only the descriptions

Note the web UI does not send X-Rotom-Secret, so http_listener.secret
protects the API but leaves the UI unable to load data. That caveat
replaces the old "Rotom has no authentication" wording.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@github-actions

github-actions Bot commented Aug 15, 2026

Copy link
Copy Markdown

Deploy Preview ready!

Name Link
🔨 Latest commit c47a599
🔍 Latest deploy log https://github.com/UnownHash/docs/actions/runs/31894865772
😎 Deploy Preview Url https://aea9f40a.unownhash.pages.dev
🌳 Environment preview

@Fabio1988
Fabio1988 requested review from Fabio1988 and jfberry August 15, 2026 17:30
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