> ## 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.

# Installation

> Install Nextedy PLANNINGBOARD as a standard Polarion extension: deploy the plugin folder, clear the plugin cache, restart, and verify the administration pages.

## What you will achieve

By the end of this tutorial you will have:

* The `com.nextedy.planningboard` plugin deployed on your Polarion server
* The plugin cache cleared and Polarion restarted so the extension is recognized
* The **Nextedy PLANNINGBOARD** administration section available, with the Setup and License pages accessible

## Prerequisites

* A running Polarion server with a [version still supported by Nextedy](https://support.nextedy.com/support/solutions/articles/48001270876-what-polarion-versions-do-you-support-)
* Administrator access to the Polarion server filesystem and web interface
* The Planningboard distribution archive (`nextedy_planningboard.zip`) downloaded from [nextedy.com/nextedy-planningboard](https://www.nextedy.com/nextedy-planningboard/)
* Optionally, a valid license file (`*-planningboard_lic.json`) from Nextedy — Planningboard also runs in trial mode without one

<Note>
  You can install and evaluate Planningboard without a license file. Unlicensed users can view boards in read-only mode but cannot drag cards, use the sidebar, or create Plans. See [License Installation](/planningboard/getting-started/licensing) for adding a license after the initial install.
</Note>

<Frame>
  <img src="https://mintcdn.com/none-17b4493f/zUlmOSLBIQ0HyaAX/planningboard/diagrams/getting-started/installation/diagram-1.svg?fit=max&auto=format&n=zUlmOSLBIQ0HyaAX&q=85&s=dd68f9d00345704e03e7a4b6b714c5a1" alt="Installation flow: deploy the plugin into extensions/, delete the .config plugin cache, restart Polarion, then verify in Administration" style={{ width: "680px", maxWidth: "100%" }} width="680" height="140" data-path="planningboard/diagrams/getting-started/installation/diagram-1.svg" />
</Frame>

<Steps>
  <Step title="Deploy the plugin files">
    Unpack the downloaded `nextedy_planningboard.zip`. Inside you will find a folder named `com.nextedy.planningboard`.

    Copy this entire folder into your Polarion extensions directory:

    ```text theme={null}
    [POLARION_INSTALL]/polarion/extensions/
    ```

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

    <Warning title="Do not rename the plugin folder">
      Polarion locates the plugin by the folder name `com.nextedy.planningboard`. Renaming it prevents the server from loading the extension.
    </Warning>
  </Step>

  <Step title="Delete the configuration cache">
    This step is critical. Remove the cached Polarion configuration directory so Polarion detects the new plugin on the next startup:

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

    Delete the entire `.config` directory (not just its contents). Polarion regenerates it on the next startup. The `.config` cache holds only plugin-discovery data — it contains no project configuration or work items.

    <Warning title="Do not skip this step">
      Failing to delete `[POLARION_INSTALL]/data/workspace/.config` is the most common cause of installation problems. If you skip it, the **Nextedy PLANNINGBOARD** Setup and License pages appear empty with no content. This step is required for both fresh installations and updates to a newer version.
    </Warning>
  </Step>

  <Step title="Restart the Polarion server">
    Restart Polarion so it rebuilds its plugin registry from the updated `extensions/` folder:

    * **Linux**: `systemctl restart polarion` or the Polarion-provided startup script
    * **Windows**: restart the Polarion service through the Services management console

    Wait for Polarion to fully start — this can take several minutes depending on your server and the number of installed extensions.
  </Step>

  <Step title="Verify the Setup page loads">
    After Polarion restarts, log in as an administrator and navigate to:

    **Administration > Nextedy PLANNINGBOARD > Setup**

    You should see the Setup page render with content — the installed version with an up-to-date indicator, and the demo-template controls. This confirms the plugin loaded successfully and the configuration cache was rebuilt during startup.

    <Tip title="Empty Setup page = cache issue">
      If the Setup page loads but shows no content, the `.config` directory was not fully removed in the previous step. Stop Polarion, delete `.config` again, and restart.
    </Tip>
  </Step>

  <Step title="Verify the license page">
    Navigate to **Administration > Nextedy PLANNINGBOARD > License** to check your license status. The page shows the license details (type, expiry, named- and server-user counts), with the signature field redacted for security.

    If you have not applied a production license, the page indicates evaluation/trial mode and Planningboard remains usable read-only. To apply a license, see [License Installation](/planningboard/getting-started/licensing).

    <Note title="Named-user licensing">
      Planningboard editing access is seat-based: it is granted to users assigned to the `nextedy_planningboard_users` group. Configure named users from the same License page — see [License Installation](/planningboard/getting-started/licensing).
    </Note>
  </Step>
</Steps>

## Troubleshooting

If the **Nextedy PLANNINGBOARD** section — or its Setup/License content — does not appear after installation:

1. Stop Polarion
2. Delete the cache directory: `[POLARION_INSTALL]/data/workspace/.config`
3. Restart Polarion

This forces Polarion to reinitialize the extension configuration and usually resolves recognition issues. If the Administration entry is missing entirely, confirm the `com.nextedy.planningboard` folder is present under `polarion/extensions/` and was not renamed.

## Post-installation checklist

| Item                              | How to verify                                                                              |
| --------------------------------- | ------------------------------------------------------------------------------------------ |
| Plugin deployed to `extensions/`  | `com.nextedy.planningboard` present in `[POLARION_INSTALL]/polarion/extensions/`           |
| `.config` deleted and regenerated | Folder reappears after restart                                                             |
| Polarion restarted successfully   | Server log shows a clean startup                                                           |
| Setup page loads with content     | **Administration > Nextedy PLANNINGBOARD > Setup** renders the version + template controls |
| License page shows status         | **Administration > Nextedy PLANNINGBOARD > License** loads with license details            |

## Next steps

With the server plugin installed, choose your setup path:

* **Evaluate quickly** — use the demo project: open **Administration > Nextedy PLANNINGBOARD > Setup**, then create a project from the **Nextedy PLANNINGBOARD Demo** template.
* **Set up a new project** — [Setup into New Projects](/planningboard/getting-started/setup-new-project)
* **Set up an existing project** — [Setup into Existing Projects](/planningboard/getting-started/setup-existing-project)
* **Add or manage a license** — [License Installation](/planningboard/getting-started/licensing)
* **Build your first board** — [Create Your First Planningboard](/planningboard/getting-started/first-planning-board)

<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**

  * `Config.java`
  * `PlanningBoardWidgetRenderer.java`
  * `PlanningBoardSetupService.java`
  * `Item.java`
  * `viewLicense.vm`
</Accordion>