# Orangescrum documentation

> Guides, references and API documentation for Orangescrum Cloud and the Community Edition.

> For the complete documentation index, see [llms.txt](https://helpdesk.orangescrum.com/llms.txt).

Source: https://helpdesk.orangescrum.com/guide

---
## Cloud

The hosted edition at orangescrum.com

- [Orangescrum Cloud](https://helpdesk.orangescrum.com/guide/cloud/get-started/introduction.md)
- [Quickstart](https://helpdesk.orangescrum.com/guide/cloud/get-started/quickstart.md)
- [Workspace tour](https://helpdesk.orangescrum.com/guide/cloud/get-started/workspace-tour.md)
- [Invite your team](https://helpdesk.orangescrum.com/guide/cloud/get-started/invite-your-team.md)
- [Editions](https://helpdesk.orangescrum.com/guide/cloud/plans/editions.md)
- [Plans and limits](https://helpdesk.orangescrum.com/guide/cloud/plans/plans-and-limits.md)
- [Feature matrix](https://helpdesk.orangescrum.com/guide/cloud/plans/feature-matrix.md)
- [Manage your subscription](https://helpdesk.orangescrum.com/guide/cloud/plans/manage-subscription.md)
- [Create a project](https://helpdesk.orangescrum.com/guide/cloud/projects/create-a-project.md)
- [Project settings](https://helpdesk.orangescrum.com/guide/cloud/projects/project-settings.md)
- [Project templates](https://helpdesk.orangescrum.com/guide/cloud/projects/project-templates.md)
- [Programs](https://helpdesk.orangescrum.com/guide/cloud/projects/programs.md)
- [Create tasks](https://helpdesk.orangescrum.com/guide/cloud/tasks/create-tasks.md)
- [Task details](https://helpdesk.orangescrum.com/guide/cloud/tasks/task-details.md)
- [Subtasks and dependencies](https://helpdesk.orangescrum.com/guide/cloud/tasks/subtasks-and-dependencies.md)
- [Checklists](https://helpdesk.orangescrum.com/guide/cloud/tasks/checklists.md)
- [Custom fields and statuses](https://helpdesk.orangescrum.com/guide/cloud/tasks/custom-fields-and-statuses.md)
- [Import and export](https://helpdesk.orangescrum.com/guide/cloud/tasks/import-and-export.md)
- [Kanban board](https://helpdesk.orangescrum.com/guide/cloud/views/kanban-board.md)
- [Gantt chart](https://helpdesk.orangescrum.com/guide/cloud/views/gantt-chart.md)
- [Milestones](https://helpdesk.orangescrum.com/guide/cloud/views/milestones.md)
- [Project calendar](https://helpdesk.orangescrum.com/guide/cloud/views/calendar.md)
- [Agile overview](https://helpdesk.orangescrum.com/guide/cloud/agile/overview.md)
- [Backlog](https://helpdesk.orangescrum.com/guide/cloud/agile/backlog.md)
- [Sprints](https://helpdesk.orangescrum.com/guide/cloud/agile/sprints.md)
- [Epics and features](https://helpdesk.orangescrum.com/guide/cloud/agile/epics-and-features.md)
- [Reports](https://helpdesk.orangescrum.com/guide/cloud/agile/reports.md)
- [Time tracking](https://helpdesk.orangescrum.com/guide/cloud/time/time-tracking.md)
- [Timesheets and approvals](https://helpdesk.orangescrum.com/guide/cloud/time/timesheets-and-approvals.md)
- [Resource management](https://helpdesk.orangescrum.com/guide/cloud/time/resource-management.md)
- [Budget and cost](https://helpdesk.orangescrum.com/guide/cloud/time/budget-and-cost.md)
- [Test Case Manager](https://helpdesk.orangescrum.com/guide/cloud/quality/test-case-manager.md)
- [Defects](https://helpdesk.orangescrum.com/guide/cloud/quality/defects.md)
- [Integrations](https://helpdesk.orangescrum.com/guide/cloud/integrations/overview.md)
- [Git sync](https://helpdesk.orangescrum.com/guide/cloud/integrations/git-sync.md)
- [Azure DevOps](https://helpdesk.orangescrum.com/guide/cloud/integrations/azure-devops.md)
- [Google Workspace](https://helpdesk.orangescrum.com/guide/cloud/integrations/google-workspace.md)
- [Users and roles](https://helpdesk.orangescrum.com/guide/cloud/admin/users-and-roles.md)
- [Teams and business units](https://helpdesk.orangescrum.com/guide/cloud/admin/teams-and-business-units.md)
- [Security](https://helpdesk.orangescrum.com/guide/cloud/admin/security.md)
- [Audit trail](https://helpdesk.orangescrum.com/guide/cloud/admin/audit-trail.md)

## Self-hosted

Run the Enterprise edition on your own infrastructure

- [Self-hosted Orangescrum](https://helpdesk.orangescrum.com/guide/self-hosted/get-started/introduction.md)
- [Prerequisites](https://helpdesk.orangescrum.com/guide/self-hosted/get-started/prerequisites.md)
- [Architecture](https://helpdesk.orangescrum.com/guide/self-hosted/get-started/architecture.md)
- [Deployment options](https://helpdesk.orangescrum.com/guide/self-hosted/install/deployment-options.md)
- [Install](https://helpdesk.orangescrum.com/guide/self-hosted/install/installer.md)
- [Configuration](https://helpdesk.orangescrum.com/guide/self-hosted/install/configuration.md)
- [Backup](https://helpdesk.orangescrum.com/guide/self-hosted/operate/backup.md)
- [Migrate to a new server](https://helpdesk.orangescrum.com/guide/self-hosted/operate/migration.md)
- [Upgrade](https://helpdesk.orangescrum.com/guide/self-hosted/operate/upgrade.md)
- [Troubleshooting](https://helpdesk.orangescrum.com/guide/self-hosted/operate/troubleshooting.md)
- [Licence and versions](https://helpdesk.orangescrum.com/guide/self-hosted/admin/licence.md)
- [Security](https://helpdesk.orangescrum.com/guide/self-hosted/admin/security.md)

## Community

The free, self-hosted AGPL edition

- [Community Edition](https://helpdesk.orangescrum.com/guide/community/get-started/introduction.md)
- [What's included](https://helpdesk.orangescrum.com/guide/community/get-started/whats-included.md)
- [Requirements](https://helpdesk.orangescrum.com/guide/community/get-started/requirements.md)
- [Install with Docker](https://helpdesk.orangescrum.com/guide/community/install/docker.md)
- [Manual install](https://helpdesk.orangescrum.com/guide/community/install/manual.md)
- [Install wizard](https://helpdesk.orangescrum.com/guide/community/install/install-wizard.md)
- [Configuration](https://helpdesk.orangescrum.com/guide/community/install/configuration.md)
- [Projects](https://helpdesk.orangescrum.com/guide/community/usage/projects.md)
- [Tasks](https://helpdesk.orangescrum.com/guide/community/usage/tasks.md)
- [Time entry](https://helpdesk.orangescrum.com/guide/community/usage/time-entry.md)
- [Labels](https://helpdesk.orangescrum.com/guide/community/usage/labels.md)
- [Users and roles](https://helpdesk.orangescrum.com/guide/community/usage/users-and-roles.md)
- [Upgrade](https://helpdesk.orangescrum.com/guide/community/operate/upgrade.md)
- [Backup and restore](https://helpdesk.orangescrum.com/guide/community/operate/backup-and-restore.md)
- [Troubleshooting](https://helpdesk.orangescrum.com/guide/community/operate/troubleshooting.md)
- [Licence](https://helpdesk.orangescrum.com/guide/community/project/licence.md)
- [Contributing](https://helpdesk.orangescrum.com/guide/community/project/contributing.md)
- [Moving to Cloud](https://helpdesk.orangescrum.com/guide/community/project/upgrade-to-cloud.md)

## API

Developer API — REST over HTTPS

- [Developer API](https://helpdesk.orangescrum.com/guide/api/introduction.md)
- [Authentication](https://helpdesk.orangescrum.com/guide/api/authentication.md)
- [Conventions](https://helpdesk.orangescrum.com/guide/api/conventions.md)
- [Errors](https://helpdesk.orangescrum.com/guide/api/errors.md)
- [Rate limits](https://helpdesk.orangescrum.com/guide/api/rate-limits.md)
- [Validate developer API authentication](https://helpdesk.orangescrum.com/guide/api/endpoints/developer/validate.md)
- [Create a new project](https://helpdesk.orangescrum.com/guide/api/endpoints/projects/projects-create.md)
- [Get project details](https://helpdesk.orangescrum.com/guide/api/endpoints/projects/projects-detail.md)
- [List projects](https://helpdesk.orangescrum.com/guide/api/endpoints/projects/projects-list.md)
- [Search projects](https://helpdesk.orangescrum.com/guide/api/endpoints/projects/projects-search.md)
- [Update a project](https://helpdesk.orangescrum.com/guide/api/endpoints/projects/projects-update.md)
- [Create a new task](https://helpdesk.orangescrum.com/guide/api/endpoints/tasks/tasks-create.md)
- [Get task details](https://helpdesk.orangescrum.com/guide/api/endpoints/tasks/tasks-detail.md)
- [List tasks](https://helpdesk.orangescrum.com/guide/api/endpoints/tasks/tasks-list.md)
- [Search tasks](https://helpdesk.orangescrum.com/guide/api/endpoints/tasks/tasks-search.md)
- [Update a task](https://helpdesk.orangescrum.com/guide/api/endpoints/tasks/tasks-update.md)
- [Create a new timelog](https://helpdesk.orangescrum.com/guide/api/endpoints/timelogs/timelogs-create.md)
- [Get timelog details](https://helpdesk.orangescrum.com/guide/api/endpoints/timelogs/timelogs-detail.md)
- [List timelogs](https://helpdesk.orangescrum.com/guide/api/endpoints/timelogs/timelogs-list.md)
- [Search timelogs](https://helpdesk.orangescrum.com/guide/api/endpoints/timelogs/timelogs-search.md)
- [Update a timelog](https://helpdesk.orangescrum.com/guide/api/endpoints/timelogs/timelogs-update.md)
- [Get user details](https://helpdesk.orangescrum.com/guide/api/endpoints/users/users-detail.md)
- [List users](https://helpdesk.orangescrum.com/guide/api/endpoints/users/users-list.md)
- [Create a test case](https://helpdesk.orangescrum.com/guide/api/endpoints/test-cases/test-cases-create.md)
- [Delete or archive a test case](https://helpdesk.orangescrum.com/guide/api/endpoints/test-cases/test-cases-delete.md)
- [Get a test case](https://helpdesk.orangescrum.com/guide/api/endpoints/test-cases/test-cases-detail.md)
- [List test cases](https://helpdesk.orangescrum.com/guide/api/endpoints/test-cases/test-cases-list.md)
- [Update a test case](https://helpdesk.orangescrum.com/guide/api/endpoints/test-cases/test-cases-update.md)
- [Create a test scenario](https://helpdesk.orangescrum.com/guide/api/endpoints/test-scenarios/test-scenarios-create.md)
- [Delete or archive a test scenario](https://helpdesk.orangescrum.com/guide/api/endpoints/test-scenarios/test-scenarios-delete.md)
- [Get a test scenario](https://helpdesk.orangescrum.com/guide/api/endpoints/test-scenarios/test-scenarios-detail.md)
- [List test scenarios](https://helpdesk.orangescrum.com/guide/api/endpoints/test-scenarios/test-scenarios-list.md)
- [Update a test scenario](https://helpdesk.orangescrum.com/guide/api/endpoints/test-scenarios/test-scenarios-update.md)
- [Add a step to a test case](https://helpdesk.orangescrum.com/guide/api/endpoints/test-steps/test-steps-create.md)
- [Delete or archive a test step](https://helpdesk.orangescrum.com/guide/api/endpoints/test-steps/test-steps-delete.md)
- [List the steps of a test case](https://helpdesk.orangescrum.com/guide/api/endpoints/test-steps/test-steps-list.md)
- [Reorder the steps of a test case](https://helpdesk.orangescrum.com/guide/api/endpoints/test-steps/test-steps-reorder.md)
- [Update a test step](https://helpdesk.orangescrum.com/guide/api/endpoints/test-steps/test-steps-update.md)
- [Create a defect](https://helpdesk.orangescrum.com/guide/api/endpoints/defects/defects-create.md)
- [Get a defect](https://helpdesk.orangescrum.com/guide/api/endpoints/defects/defects-detail.md)
- [Link a defect to testing entities](https://helpdesk.orangescrum.com/guide/api/endpoints/defects/defects-link.md)
- [List defects](https://helpdesk.orangescrum.com/guide/api/endpoints/defects/defects-list.md)
- [Update a defect](https://helpdesk.orangescrum.com/guide/api/endpoints/defects/defects-update.md)
- [Update a defect's status](https://helpdesk.orangescrum.com/guide/api/endpoints/defects/defects-status.md)
- [Add a checklist item](https://helpdesk.orangescrum.com/guide/api/endpoints/checklist/work-items-checklist-items-add.md)
- [Add a group to a work item from a template](https://helpdesk.orangescrum.com/guide/api/endpoints/checklist/work-items-checklist-groups-add-from-template.md)
- [Attach a catalogue group to a work item](https://helpdesk.orangescrum.com/guide/api/endpoints/checklist/work-items-checklist-groups-add.md)
- [Complete/uncomplete a checklist item](https://helpdesk.orangescrum.com/guide/api/endpoints/checklist/work-items-checklist-items-complete.md)
- [Create a checklist template](https://helpdesk.orangescrum.com/guide/api/endpoints/checklist/checklists-templates-create.md)
- [Create a custom checklist group](https://helpdesk.orangescrum.com/guide/api/endpoints/checklist/checklists-groups-create.md)
- [Create a custom group on a work item](https://helpdesk.orangescrum.com/guide/api/endpoints/checklist/work-items-checklist-groups-create-custom.md)
- [Delete a checklist group](https://helpdesk.orangescrum.com/guide/api/endpoints/checklist/checklists-groups-delete.md)
- [Delete a checklist item](https://helpdesk.orangescrum.com/guide/api/endpoints/checklist/work-items-checklist-items-delete.md)
- [Delete a checklist template](https://helpdesk.orangescrum.com/guide/api/endpoints/checklist/checklists-templates-delete.md)
- [Delete a work-item checklist group](https://helpdesk.orangescrum.com/guide/api/endpoints/checklist/work-items-checklist-groups-delete.md)
- [List checklist groups](https://helpdesk.orangescrum.com/guide/api/endpoints/checklist/checklists-groups-list.md)
- [List checklist templates](https://helpdesk.orangescrum.com/guide/api/endpoints/checklist/checklists-templates-list.md)
- [Read a work item checklist](https://helpdesk.orangescrum.com/guide/api/endpoints/checklist/work-items-checklist-detail.md)
- [Read company checklist configuration](https://helpdesk.orangescrum.com/guide/api/endpoints/checklist/checklists-config.md)
- [Rename a work-item checklist group](https://helpdesk.orangescrum.com/guide/api/endpoints/checklist/work-items-checklist-groups-rename.md)
- [Reorder a work item checklist groups](https://helpdesk.orangescrum.com/guide/api/endpoints/checklist/work-items-checklist-groups-reorder.md)
- [Update a checklist group](https://helpdesk.orangescrum.com/guide/api/endpoints/checklist/checklists-groups-update.md)
- [Update a checklist item label](https://helpdesk.orangescrum.com/guide/api/endpoints/checklist/work-items-checklist-items-update.md)
- [Update a checklist template](https://helpdesk.orangescrum.com/guide/api/endpoints/checklist/checklists-templates-update.md)

## MCP

Connect AI assistants to Orangescrum

- [MCP / AI Connect](https://helpdesk.orangescrum.com/guide/mcp/introduction.md)
- [Quickstart](https://helpdesk.orangescrum.com/guide/mcp/quickstart.md)
- [Client setup](https://helpdesk.orangescrum.com/guide/mcp/clients.md)
- [Tools](https://helpdesk.orangescrum.com/guide/mcp/tools.md)
- [Prompts](https://helpdesk.orangescrum.com/guide/mcp/prompts.md)
- [Troubleshooting](https://helpdesk.orangescrum.com/guide/mcp/troubleshooting.md)

