Skip to content

Added troubleshooting page for license check failures#429

Open
zzzeebra wants to merge 1 commit into
mainfrom
docs/license-server-troubleshooting
Open

Added troubleshooting page for license check failures#429
zzzeebra wants to merge 1 commit into
mainfrom
docs/license-server-troubleshooting

Conversation

@zzzeebra
Copy link
Copy Markdown

Summary

Adds a new docs page documenting how License Server client failures manifest in ThingsBoard PE logs, and how to fix each canonical error code.

The existing what-is-license-server.mdx only vaguely says the client "may shut down the ThingsBoard instance" — leaving operators to debug INVALID_LICENSE_SECRET(101), INVALID_LICENSE_CHECK_SECRET(107), CONNECTION_ERROR(400), and PKIX/SSL failures from scratch. This page lists each mode with a concrete recovery procedure.

Changes

  • New page docs/license-server/troubleshooting:
    • The new ERROR-banner format *** LICENSE CHECK FAILED ({code} - code {n}) *** and a grep example to locate it across logs.
    • A canonical error-code table.
    • Per-code recovery instructions (101, 107, 400, PKIX, GENERAL_ERROR).
    • Container exit-code explanation (JVM -1 → POSIX 255).
    • Docker Compose restart: on-failure recommendation that avoids the infinite-restart-loop symptom.
  • Linkback added at the end of the Prerequisites section in what-is-license-server.mdx (right where the "may shut down" mention is).
  • Sidebar: new Troubleshooting group in the License Server sidebar.

Companion PR

Backend PR introducing the ERROR banner the page references: thingsboard/thingsboard-pe#4799.

Test plan

  • npm run build clean (3818 pages, no errors related to the new content)
  • Manual review of grep example, error-code descriptions, restart-policy snippet against the actual log output captured during backend verification

…ures

New page listing canonical License Server client errors
(INVALID_LICENSE_SECRET 101, INVALID_LICENSE_CHECK_SECRET 107,
CONNECTION_ERROR 400, PKIX SSL trust failure, GENERAL_ERROR) with
diagnostic steps and per-code recovery instructions. Documents the
new ERROR banner format, container exit code semantics, and the
docker-compose restart: on-failure recommendation that avoids the
infinite restart loop on unresolved license errors.

Linked from the prerequisites section of what-is-license-server.mdx
where the "may shut down" behavior was previously only vaguely
mentioned. Added a Troubleshooting group to the License Server
sidebar.
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