Skip to content

docs: document mid2/offlineKeyV2 + JNA troubleshooting for License Checker 2.3.1 backport (v23)#5820

Open
mcollovati wants to merge 4 commits into
v23from
docs/license-checker-2.3.1-offline-key-v23
Open

docs: document mid2/offlineKeyV2 + JNA troubleshooting for License Checker 2.3.1 backport (v23)#5820
mcollovati wants to merge 4 commits into
v23from
docs/license-checker-2.3.1-offline-key-v23

Conversation

@mcollovati

@mcollovati mcollovati commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Updates the license documentation for the License Checker 2.3.1 backport, which brings mid2/offlineKeyV2 support to Vaadin 23.6.

Changes

  • articles/configuration/licenses.adoc:
    • Document the mid2/offlineKeyV2 offline key format (the page previously covered only the legacy mid/offlineKey), badged since V23.6, including the offlineKeyV2 home-directory path and a note that 23.6+ accepts both formats.
    • Add a troubleshooting entry for "Detected an offline license version 1, but version 2 is required": it can appear with a valid V1 key when the V1 machine ID cannot be computed — commonly a blocked/failed JNA native library — with a mvn -X / ./gradlew --debug diagnosis tip.

Docs issue: #5817
Related License Checker issue: vaadin/license-checker-vaadin10#245

@mcollovati
mcollovati force-pushed the docs/license-checker-2.3.1-offline-key-v23 branch from 2c9950b to ab2d13e Compare July 17, 2026 05:06
…1 backport

mid2/offlineKeyV2 support was backported to Vaadin 23.6. Document the V2
key format alongside the legacy mid/offlineKey: add the offlineKeyV2 home
directory path, a since-V23.6 note that both formats are accepted, and
clarify that the logs show a mid2 on 23.6+ while the license-checker-machineid
command still prints the legacy mid.
Vaadin 23.6 ships License Checker 2.3.1, whose 'Detected an offline
license version 1, but version 2 is required' message can appear even
with a valid version 1 key when the version 1 machine ID cannot be
computed -- commonly because the JNA native library is blocked or fails
to load. Document how to confirm the real cause with mvn -X and the two
ways to resolve it.
- Add JNA and OSHI to the Vaadin.Abbr exceptions.
- Wrap version-specific offline-key and troubleshooting content in
  Vaadin.Versions = NO/YES, matching the pattern used elsewhere in the docs.
@mcollovati
mcollovati force-pushed the docs/license-checker-2.3.1-offline-key-v23 branch from ab2d13e to 84f343a Compare July 17, 2026 05:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant