> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nextedy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# License Installation

> Learn how to install a production license for Nextedy PLANNINGBOARD and transition out of evaluation mode so your team has full editing access to the Planningboard.

## What you will achieve

By the end of this tutorial you will have:

* Placed your production license file in the correct Polarion directory
* Verified the license status in the Planningboard administration interface
* Confirmed that licensed users can drag cards, use the sidebar, and create Plans

## Prerequisites

* Planningboard is already installed on your Polarion server (see [Installation](/planningboard/getting-started/installation))
* You have access to the Polarion server file system (or can ask your system administrator)
* You have received a license file named `<PREFIX>-planningboard_lic.json` from Nextedy

<Note>
  Planningboard runs in **30-day evaluation mode** when no production license is present. In evaluation mode the board is read-only for all users — cards cannot be dragged, the sidebar is hidden, the **Create New Plan** button is not shown, and the **Show Unplanned** toggle is unavailable. View access to board content is retained.
</Note>

***

<Steps>
  <Step title="Locate your license file">
    Your license file was delivered by Nextedy when you purchased Planningboard. Its name follows the pattern:

    ```text theme={null}
    <YOURPREFIX>-planningboard_lic.json
    ```

    For example: `acme-planningboard_lic.json`.

    If you cannot find your license file, contact [support@nextedy.com](mailto:support@nextedy.com).

    ***
  </Step>

  <Step title="Copy the license file to the Polarion license directory">
    Place the license file inside the Polarion installation's `license` folder:

    ```text theme={null}
    [POLARION_INSTALL]/polarion/license/<YOURPREFIX>-planningboard_lic.json
    ```

    Replace `[POLARION_INSTALL]` with your actual Polarion installation path (for example `/opt/polarion` on Linux).

    <Warning title="Do not rename the file">
      The file name must remain exactly as delivered. Renaming the file can prevent the license from being recognized.
    </Warning>

    ***
  </Step>

  <Step title="Delete the `.config` cache directory">
    Polarion caches plugin state in a `.config` directory. You must remove it so Polarion picks up the new license on the next start.

    ```text theme={null}
    Delete: [POLARION_INSTALL]/data/workspace/.config
    ```

    <Tip title="Safe to delete">
      The `.config` directory holds only plugin discovery caches — no project data. Deleting it does not slow Polarion down and is recommended by Polarion support whenever a plugin changes.
    </Tip>

    ***
  </Step>

  <Step title="Restart the Polarion server">
    Restart your Polarion server using your organization's standard procedure. The server must fully start before you proceed.

    **What you should see:** Polarion starts normally with no errors related to Planningboard in the server log.

    ***
  </Step>

  <Step title="Verify the license in the administration interface">
    1. Log in to Polarion as an administrator.
    2. Navigate to **Administration > Nextedy PLANNINGBOARD**.
    3. Open the **Setup** (or license) page.

    You will see a color-coded status panel:

    <Frame>
      <img src="https://mintcdn.com/none-17b4493f/zUlmOSLBIQ0HyaAX/planningboard/diagrams/getting-started/licensing/diagram-1.svg?fit=max&auto=format&n=zUlmOSLBIQ0HyaAX&q=85&s=6ed89fc25349c6a7c13e4def923e00c9" alt="License status panel showing the three states: Valid (green, editing enabled), Info/Warning (blue, check the message), and Invalid (red, read-only enforced)" width="560" height="220" data-path="planningboard/diagrams/getting-started/licensing/diagram-1.svg" />
    </Frame>

    The panel also shows the full license details. The signature field is automatically redacted from the display — this is intentional and does not affect validation.

    **What you should see:** A green panel confirming the license is valid.

    <Note title="Signature redacted">
      The license signature is hidden in the UI for security. The server validates it server-side — you do not need to see it.
    </Note>

    ***
  </Step>

  <Step title="Confirm editing is available">
    Open a Planningboard page in any project. Verify the following are now visible and functional for licensed users:

    | Element                    | Expected state when licensed                            |
    | -------------------------- | ------------------------------------------------------- |
    | **Show Unplanned** button  | Visible in the toolbar                                  |
    | **Create New Plan** button | Visible                                                 |
    | Sidebar panel              | Opens when a card is clicked                            |
    | Drag and drop              | Cards can be dragged between swimlanes; changes persist |

    <Warning title="Read-only persists for unlicensed users">
      Planningboard enforces license-based access control per user. Users who do not hold a Planningboard license will still see the board in read-only mode — they can view cards and swimlanes but cannot drag, edit, or plan. This is by design to support collaboration and transparency.
    </Warning>

    ***
  </Step>
</Steps>

## License states reference

| Status     | Panel color | Meaning                                                                     |
| ---------- | ----------- | --------------------------------------------------------------------------- |
| Valid      | Green       | Production license accepted; full editing enabled for licensed users        |
| Info       | Blue        | License present but contains an informational notice; check the message     |
| Invalid    | Red         | License not recognized or expired; board reverts to read-only for all users |
| No license | —           | Evaluation mode; 30-day window; read-only for all users                     |

***

## Next steps

With a valid license installed, continue setting up your project:

* [Setup into New Projects](/planningboard/getting-started/setup-new-project) — install Planningboard into a brand-new Polarion project
* [Setup into Existing Projects](/planningboard/getting-started/setup-existing-project) — add Planningboard to a project already in use
* [Create Your First Planningboard](/planningboard/getting-started/first-planning-board) — add the widget to a LiveDoc page and run your first planning session

<Accordion title="Sources">
  **KB Articles**

  * Install Planningboard
  * How to setup Planningboard into existing projects (based on E-library template)
  * Planningboard interface & basic interactions

  **Support Tickets**

  * [#6174](https://support.nextedy.com/helpdesk/tickets/6174)

  **Source Code**

  * `viewLicense.vm`
  * `licenseReadonly.cy.ts`
  * `Config.java`
  * `PlanningBoardWidgetRenderer.java`
  * `PlanningBoardSetupService.java`
</Accordion>