Jira setup walkthrough
Install the Vindex Forge app on Jira Cloud, verify the connection, and see your first scored story. The whole flow is four steps and usually takes under five minutes.
Before you begin
- A Jira Cloud instance (Jira Software or Jira Work Management)
- Site administrator access — project admin is not sufficient
- Permission to install Forge apps from the Atlassian Marketplace
- A Vindex account (or create one during registration)
The walkthrough
Confirm you have site admin
In Jira, open Settings → User management. Your account must be listed as a Site admin. Forge apps write to site-level storage, so project-level permissions will not get you past install.
Install from the Atlassian Marketplace
Open the Atlassian Marketplace and search for Vindex. Click Get it now, choose the Jira Cloud site, and confirm the install.
The Forge runtime takes a few seconds to register the app. Once it finishes, the Vindex Issue Panel becomes available on every Jira issue view.
Link the app to your Vindex account
On first use, the Forge app registers your Jira Cloud ID with Vindex. If you already have a Vindex account, the link happens automatically using the shared secret stored in Forge storage. If you don't, you'll be prompted to create one at vindex.io/register.
The shared secret is generated per-installation and never leaves the Forge environment. Vindex uses it to authenticate every callback it sends back to your Jira instance.
Test a story — and re-score on demand
Open any story. The Vindex Issue Panel appears in the right-hand sidebar. On the first open, Vindex evaluates the story asynchronously and the panel populates within a few seconds.
After you edit the story, you can either wait for the next automatic evaluation (triggered on save) or press Re-score in the panel to request a fresh score immediately.
Upgrades and re-installs
Forge apps upgrade automatically when a new version is published. The shared secret stored in Forge storage is preserved across upgrades, so Vindex keeps recognising your instance without any manual re-registration.
If you uninstall and reinstall the Forge app, a new secret is generated. The first call to Vindex after re-install will re-register the instance against your existing company record, preserving your score history.
Troubleshooting
The Issue Panel is empty on every story
Open the panel once to trigger the first evaluation. Scoring runs asynchronously; give it a few seconds on the first view. If it stays empty after 30 seconds, check the browser console for permission errors.
Scores stopped updating after an admin change
If the original installing admin left your org, the app continues to run but cannot be reconfigured. Any current site admin can press Re-score to force a fresh evaluation; no re-install is needed.
The Vindex panel doesn't appear at all
Confirm the app is installed at Settings → Apps → Manage apps. If it is installed but the panel is hidden, project admins can re-enable the panel under Project settings → Features.