Documentation
Everything you need to run Iskue: from the first docker compose up to a distributed cluster, plus guides for administrators and everyday users.
Getting started
- Overview — Architecture and deployment overview of Iskue: Spring Boot backend, React SPA, PostgreSQL 16, optional Citus cluster, and where your data lives.
- Install: single host — Step-by-step single-host installation of Iskue with Docker Compose: environment setup, first admin, TLS reverse proxy, and data locations.
- Install: cluster — Deploy Iskue on a Citus distributed Postgres cluster with two application replicas behind nginx, in development and production variants.
- Upgrade — Upgrade Iskue on a single host or a Citus cluster: backups, the append-only Flyway chain, rolling restarts, schema-version checks and rollback.
- Configuration — Complete environment-variable reference for Iskue: core, mail, SSO, dev flags and rate limits, with real defaults from the backend configuration.
- Troubleshooting — Operator troubleshooting for Iskue: startup guards, 401/403/429, SSE behind proxies, Swagger 404, CORS, port conflicts and Flyway failures.
Administration
- Administration — Admin guide for Iskue: first-admin bootstrap, global and project roles, user management, permission schemes, audit log, rate limiting and admin UI areas.
- Single sign-on — Configure OIDC single sign-on with Google and Microsoft (Azure AD) for Iskue, and manage TOTP two-factor authentication for local accounts.
- Email — Enable SMTP delivery in Iskue, choose which events send mail via notification schemes, and manage per-user digests, mutes and customer email.
- Backup & restore — Back up and restore an Iskue single-host deployment: pg_dump of the issuehub database, the attachments volume, restore order and cluster notes.
- Permissions — How Iskue layers global roles, project roles and permission-scheme grants, plus custom roles, groups, and notification schemes routing in-app and email.
- Screens & fields — The ticket-type catalogue, per-type CREATE/EDIT screens, conditional rules, cascading selects, custom fields, field schemes and ticket templates.
- Plugins — Extend Iskue with sandboxed GraalJS plugin scripts: installation, hooks, the add-label action vocabulary, execution budgets and isolation guarantees.
Using Iskue
- Projects & workflows — Create Iskue projects, choose a workflow template, edit statuses and transitions, add transition rules, and map ticket types to per-type workflows.
- Tickets & boards — User guide to tickets and boards in Iskue: creating tickets, sub-tickets and rollup, watching, comments, the kanban board, backlog ranking, sprints and the sheet view.
- Automation — Build event-driven and scheduled automation in Iskue: triggers, conditions, actions, smart values, run history, sweep budgets, global rules and auditing.
- Reports & dashboards — Every Iskue report explained — burndown, velocity, flow metrics, workload — plus CSV exports, dashboard gadgets, sharing and the sprint roadmap.
- Service desk & portal — Run a service desk on Iskue: token-authenticated customer portal, request forms, queues, customer email, knowledge base, CSAT and SLA policies.
- TQL reference — TQL reference for Iskue: grammar, operators, every field, date arithmetic, custom-field queries, ORDER BY, saved filters, subscriptions and scoping.
Integrations
- API & webhooks — Integrate with Iskue: JWT-authenticated REST API, signed outbound webhooks, Slack and Git integrations, CSV export/import and the Jira importer.
- Migrating from Jira — Move projects from Jira Cloud or Data Center into Iskue with the live importer, or use CSV import/export. What maps, what does not, and every cap.