# Collabase - [User guide (98 pages)](https://collabase.ch/docs/_llms/en/user-guide.md): Documentation for User guide. ## Guides ### Welcome - [Collabase documentation](https://collabase.ch/docs/index.md): Guides and reference for Collabase, the collaboration platform from Switzerland: getting started, HERMES project management, administration, security and the API. - [Introduction](https://collabase.ch/docs/introduction.md): What Collabase is, who it is for, which apps it includes and how you start with a proof of concept. - [Why Collabase exists](https://collabase.ch/docs/about/story.md): How Collabase grew from an open-core project into proprietary software of Infometis AG, and where the platform is heading: quality engineering at its core. - [Collabase glossary](https://collabase.ch/docs/glossary.md): Every Collabase term in one place, from Space and Permission Scheme to Object Type and SCIM, with a short definition and a link to the full guide. ### Getting started guide - [Getting started with Collabase](https://collabase.ch/docs/getting-started/overview.md): Your first steps in Collabase: sign in, open a Space, create a project and tasks, write your first page in Collabase Docs and set up your profile. - [Introduction to Collabase](https://collabase.ch/docs/getting-started/introduction.md): What Collabase is and how it is organised: Spaces, apps such as Collabase Docs and Projects, members and roles. The starting point for new users. - [Sign in to Collabase](https://collabase.ch/docs/getting-started/sign-in.md): How to sign in to Collabase for the first time, set your own password, and sign in with Google, Microsoft Entra ID, SAML single sign-on or LDAP. - [Open and create a Space](https://collabase.ch/docs/getting-started/spaces.md): How to find your Spaces in Collabase, switch between them, and create a new Space with a name, visibility, apps and members. - [Invite members to a Space](https://collabase.ch/docs/getting-started/invite-members.md): How to add colleagues or whole groups to a Collabase Space and choose their role: Space Admin, Manager, Member or Viewer. - [Create your first project](https://collabase.ch/docs/getting-started/projects.md): How to create a project in Collabase Projects, start from a project template, and add project members with the Owner, Member or Viewer role. - [Create and edit tasks](https://collabase.ch/docs/getting-started/tasks.md): How to create a task in Collabase Projects, fill in status, assignee, priority and due date, add subtasks and comments, and link related tasks. - [Board and backlog basics](https://collabase.ch/docs/getting-started/boards.md): How to work with the Kanban board in Collabase Projects, filter your own tasks, prioritise the backlog and move tasks into a sprint. - [Write your first page in Collabase Docs](https://collabase.ch/docs/getting-started/docs-pages.md): How to create a page in Collabase Docs, use the editor and slash commands, start from a template, and restore an earlier version of a page. - [Find content with search](https://collabase.ch/docs/getting-started/search.md): How to use Collabase search to find tasks, pages, Registry objects, test cases and automations across every Space you have access to. - [Set up your profile and notifications](https://collabase.ch/docs/getting-started/profile.md): How to set your name, avatar and language in Collabase, choose which notifications you receive, get an email digest and change your password. ### HERMES project management - [HERMES project management guide](https://collabase.ch/docs/hermes/overview.md): HERMES project management with Collabase: phases, milestones, roles, scenarios and outcomes of HERMES 2022, and how to run a HERMES project in Collabase. - [Introduction to HERMES project management](https://collabase.ch/docs/hermes/introduction.md): What HERMES 2022 is: the Swiss federal project management method, its publisher, current edition, traditional and agile approach, and where it is used. - [HERMES phases](https://collabase.ch/docs/hermes/phases.md): The HERMES 2022 phase model: Initiation, Concept, Implementation, Deployment, Execution and Closure, and how to plan HERMES phases in Collabase. - [HERMES phase Initiation](https://collabase.ch/docs/hermes/initiation.md): The HERMES Initiation phase: project initiation order, study, solution variants, next steps decision and execution release, and how to run it in Collabase. - [HERMES phase Concept](https://collabase.ch/docs/hermes/concept.md): The HERMES Concept phase in the traditional approach: situation analysis, solution requirements, concepts, solution architecture, procurement and phase release. - [HERMES phase Implementation](https://collabase.ch/docs/hermes/implementation.md): The HERMES Implementation phase in the traditional approach: develop or configure the solution, integrate, test, preliminary acceptance and phase release. - [HERMES phase Deployment](https://collabase.ch/docs/hermes/deployment.md): The HERMES Deployment phase in the traditional approach: deployment measures, migration, activation, launch of operation, acceptance and closure phase release. - [HERMES phase Execution (agile)](https://collabase.ch/docs/hermes/execution.md): The HERMES Execution phase in the agile approach: iterations, increments, prioritised solution requirements, optional release milestones and closure phase release. - [HERMES phase Closure](https://collabase.ch/docs/hermes/closure.md): The HERMES Closure phase: check the project documentation, hand over to the core organization, archive, remove the legacy system and complete the project. - [HERMES milestones and decisions](https://collabase.ch/docs/hermes/milestones.md): HERMES milestones as quality gates: project initiation release, execution release, phase release, release, acceptance and project closure, and how to approve them in Collabase. - [HERMES roles and project organization](https://collabase.ch/docs/hermes/roles.md): HERMES roles: project sponsor, project manager, user representative, partner groups user, developer and operator, hierarchy levels, and how to map roles in Collabase. - [HERMES scenarios and modules](https://collabase.ch/docs/hermes/scenarios-and-modules.md): The five HERMES standard scenarios, the twelve standard modules, the mandatory modules, user-defined scenarios, and how to turn a scenario into a Collabase project template. - [HERMES outcomes and document templates](https://collabase.ch/docs/hermes/outcomes.md): HERMES outcomes: documents and states, minimum required documents such as study, project management plan and execution order, and HERMES document templates in Collabase Docs. - [Set up HERMES in Collabase](https://collabase.ch/docs/hermes/collabase-setup.md): Step-by-step setup of HERMES project management in Collabase: workflows, task types, HERMES fields, project templates per scenario, risk and decision registers, approvals. ## Administration ### Install and run - [Installation](https://collabase.ch/docs/installation.md): Set up Collabase on your server in a few minutes. You need Docker and a Linux server — the installer handles the rest. - [Installation on Kubernetes](https://collabase.ch/docs/installation-kubernetes.md): Run Collabase in your Kubernetes cluster with the official Helm chart. - [Installation on Docker Swarm](https://collabase.ch/docs/installation-swarm.md): Run Collabase as a Docker Swarm stack with managed secrets and rolling updates. - [First Login](https://collabase.ch/docs/first-run.md): What to do after Collabase is installed — your first login, initial setup, and next steps. - [Desktop app](https://collabase.ch/docs/desktop-app.md): Install Collabase as a desktop application on macOS, Windows, and Linux. ### Members and access - [Users groups](https://collabase.ch/docs/admin/users-groups.md): Invite users, assign roles, organize teams into groups, and set up automated provisioning with SCIM. - [Identity providers](https://collabase.ch/docs/admin/identity-providers.md): Let your team sign in to Collabase with their existing company accounts. Configure OAuth, SAML SSO, LDAP, and SCIM under Admin → Identity Providers. - [Security policies](https://collabase.ch/docs/admin/security-policies.md): Control how long a sign-in stays valid, lock out repeated failed logins, and let named people sign in with a password when SSO is enforced. ### AI - [Ai configuration](https://collabase.ch/docs/admin/ai-configuration.md): Connect Collabase to an AI provider, enable semantic search, and understand what each provider can and cannot do. - [Ai costs](https://collabase.ch/docs/admin/ai-costs.md): Which model to run CollabaseAI on, how many tokens a single question actually uses, and what that adds up to on an instance with 100 users. ### Time tracking - [Time Tracking — Admin Setup](https://collabase.ch/docs/admin/time-tracking.md): Admin setup guide for the Time Tracking module in Collabase — accounts, teams, billing rules, holiday schemes, workload plans, and worklog attributes. ### Operations - [Hosting](https://collabase.ch/docs/admin/hosting.md): An overview of how Collabase runs on your server — what services are included, what they do, and what resources they use. - [Sizing & Scaling](https://collabase.ch/docs/admin/scaling.md): How much RAM and CPU Collabase needs for your team, and how to spread it across separate servers as you grow. - [File storage](https://collabase.ch/docs/admin/file-storage.md): Where Collabase stores uploaded files, and how to switch from local disk to S3-compatible object storage. - [Backup](https://collabase.ch/docs/admin/backup.md): How to back up your Collabase data and restore it when needed. There is no built-in backup UI — backups are run from the command line. - [Updates](https://collabase.ch/docs/admin/updates.md): How to update Collabase to a new version. The update script handles everything automatically. - [Troubleshooting](https://collabase.ch/docs/admin/troubleshooting.md): Solutions to the most common issues with a Collabase installation — database, authentication, email, AI, file uploads, and migrations. ## Security and privacy ### Security and privacy - [Security and privacy](https://collabase.ch/docs/security/overview.md): Collabase security and data protection at a glance: privacy policy, processing of personal data, security statement and how to report a vulnerability. - [Security statement](https://collabase.ch/docs/security/statement.md): How Collabase is secured: Swiss hosting or self-hosted operation, SSO and access control, encryption, backups, release cadence, security patches and AI data flow. - [Processing of personal data](https://collabase.ch/docs/security/data-protection.md): Which personal data Collabase stores as an application, who is the controller, where the data lives, what leaves your server and how to deactivate or delete accounts. ## API Reference ### Overview - [API Reference](https://collabase.ch/docs/api/introduction.md): The Collabase REST API — integrate and automate your Collabase instance. ### Pages - [Create page](https://collabase.ch/docs/api/pages/create-page.md): Create a new document or blog page within a space. ### Work Items - [Move work item](https://collabase.ch/docs/api/tasks/move-work-item.md): Move a work item and its sub-items to another project, with an explicit status mapping. ### Meetings - [Meetings API](https://collabase.ch/docs/api/meetings/overview.md): Plan meetings, keep agendas and record decisions from another system through /api/v1/meetings, with the same rights as in Collabase. - [List meetings](https://collabase.ch/docs/api/meetings/list-meetings.md): Page through the meetings your token owner is invited to: today, upcoming, past or series occurrences. - [Create meeting](https://collabase.ch/docs/api/meetings/create-meeting.md): Create a draft meeting with the token owner as organizer; plan it afterwards to send the invitations. - [Get meeting](https://collabase.ch/docs/api/meetings/get-meeting.md): Read one meeting with its organizer, series, settings and the actions the token owner may take on it. - [Update meeting](https://collabase.ch/docs/api/meetings/update-meeting.md): Change a meeting's title, time, place or settings; a planned meeting sends updated invitations afterwards. - [Delete meeting](https://collabase.ch/docs/api/meetings/delete-meeting.md): Delete a draft or cancelled one-off meeting with everything in it; meetings that reached a calendar stay. #### Lifecycle - [Plan meeting](https://collabase.ch/docs/api/meetings/lifecycle/plan-meeting.md): Announce a draft meeting: it becomes planned and every participant receives the calendar invitation. - [Start meeting](https://collabase.ch/docs/api/meetings/lifecycle/start-meeting.md): Move a planned meeting to running, so outcomes, decisions and poll results can be recorded. - [Close meeting](https://collabase.ch/docs/api/meetings/lifecycle/close-meeting.md): End a running meeting: it becomes read-only, open polls close and the meeting note is queued. - [Reopen meeting](https://collabase.ch/docs/api/meetings/lifecycle/reopen-meeting.md): Move a closed meeting back to running for a correction; the reopening is recorded in the audit log. - [Cancel meeting](https://collabase.ch/docs/api/meetings/lifecycle/cancel-meeting.md): Call off a draft or planned meeting; everyone who holds it in a calendar receives a cancellation. #### Participants - [List participants](https://collabase.ch/docs/api/meetings/participants/list-participants.md): Read who is invited to a meeting, with role and invitation answer, plus answer counts and the token owner's rights. - [Invite participant](https://collabase.ch/docs/api/meetings/participants/invite-participant.md): Invite a member or an external guest to a meeting; in a planned meeting the invitation goes out shortly after. - [Update participant](https://collabase.ch/docs/api/meetings/participants/update-participant.md): Change a participant's role, or record the answer an external guest gave by mail or phone. - [Remove participant](https://collabase.ch/docs/api/meetings/participants/remove-participant.md): Remove someone from a meeting; in a planned meeting they receive a cancellation shortly after. - [Respond to invitation](https://collabase.ch/docs/api/meetings/participants/respond-to-invitation.md): Record the token owner's own answer to a meeting invitation: accepted, tentative or declined. #### Agenda - [Get agenda](https://collabase.ch/docs/api/meetings/agenda/get-agenda.md): Read a meeting's agenda sections and items in order, with their outcomes, links and the token owner's rights. - [Create agenda section](https://collabase.ch/docs/api/meetings/agenda/create-section.md): Add a section at the end of a meeting's agenda to group related agenda items. - [Update agenda section](https://collabase.ch/docs/api/meetings/agenda/update-section.md): Rename an agenda section, saved against the version you read so a concurrent rename is never lost. - [Delete agenda section](https://collabase.ch/docs/api/meetings/agenda/delete-section.md): Remove an agenda section; its items stay on the agenda without a section. - [Move agenda section](https://collabase.ch/docs/api/meetings/agenda/move-section.md): Reorder a meeting's agenda by placing a section after another one, or first. - [Create agenda item](https://collabase.ch/docs/api/meetings/agenda/create-item.md): Add an item at the end of an agenda section, or of the agenda items without a section. - [Update agenda item](https://collabase.ch/docs/api/meetings/agenda/update-item.md): Change an agenda item's title, description, owner, estimate or notes, saved against the version you read. - [Delete agenda item](https://collabase.ch/docs/api/meetings/agenda/delete-item.md): Remove an item from a meeting's agenda; decisions taken on it stay, without the item. - [Move agenda item](https://collabase.ch/docs/api/meetings/agenda/move-item.md): Reorder an agenda item within its section or move it into another section of the same meeting. #### Outcomes - [List outcomes](https://collabase.ch/docs/api/meetings/outcomes/list-outcomes.md): Read every outcome of a meeting with its type, text, responsible person, due date and linked work item. - [Record outcome](https://collabase.ch/docs/api/meetings/outcomes/create-outcome.md): Record an information or task outcome on an agenda item while the meeting runs. - [Update outcome](https://collabase.ch/docs/api/meetings/outcomes/update-outcome.md): Change an outcome's text, responsible person or due date while the meeting runs, saved against the version you read. - [Delete outcome](https://collabase.ch/docs/api/meetings/outcomes/delete-outcome.md): Remove an outcome while the meeting runs; a work item already made from it stays where it is. #### Decisions - [List meeting decisions](https://collabase.ch/docs/api/meetings/decisions/list-decisions.md): Read the decisions taken in one meeting, oldest first, and whether the token owner may record more right now. - [Record decision](https://collabase.ch/docs/api/meetings/decisions/record-decision.md): Record a decision in a running meeting, optionally with decision makers, the agenda item and a closed poll. - [Update decision](https://collabase.ch/docs/api/meetings/decisions/update-decision.md): Reword a valid decision or change its decision makers, saved against the version you read. - [Supersede decision](https://collabase.ch/docs/api/meetings/decisions/supersede-decision.md): Replace a valid decision with a new one in the same meeting; the old decision points at its successor. - [Revoke decision](https://collabase.ch/docs/api/meetings/decisions/revoke-decision.md): Mark a valid decision as revoked; it stays in the register with its new status. - [Search decision register](https://collabase.ch/docs/api/meetings/decisions/decision-register.md): Search decisions across every meeting the token owner may read, newest first, filtered and paginated. #### Polls - [List polls](https://collabase.ch/docs/api/meetings/polls/list-polls.md): Read a meeting's polls with turnout, the token owner's own vote and, once closed, the result. - [Create poll](https://collabase.ch/docs/api/meetings/polls/create-poll.md): Prepare a poll for a meeting as a draft: yes/no/abstain, single or multiple choice, or a scale. - [Update poll](https://collabase.ch/docs/api/meetings/polls/update-poll.md): Change a draft poll's question, answers, audience or deadline, saved against the version you read. - [Open poll](https://collabase.ch/docs/api/meetings/polls/open-poll.md): Open a draft poll for voting in a planned or running meeting; its question and answers are fixed from then on. - [Close poll](https://collabase.ch/docs/api/meetings/polls/close-poll.md): End voting in an open poll now; the result becomes visible and the poll never reopens. #### Series - [Create series](https://collabase.ch/docs/api/meetings/series/create-series.md): Turn a draft or planned one-off meeting into the first occurrence of a recurring series with an iCalendar rule. - [Change series rule](https://collabase.ch/docs/api/meetings/series/change-series-rule.md): Change or end a series' recurrence rule from a start date on, with a dry run that reports which occurrences it cancels. - [Get series](https://collabase.ch/docs/api/meetings/series/get-series.md): Read a meeting series with its rule and one page of its occurrences, oldest first. ### Test Management - [List projects](https://collabase.ch/docs/api/test-management/list-projects.md): Return all test projects in a space that your API key has access to. - [Create project](https://collabase.ch/docs/api/test-management/create-project.md): Create a new test project inside a space. - [Create test case](https://collabase.ch/docs/api/test-management/create-test-case.md): Create a new test case inside a test project. - [Create test run](https://collabase.ch/docs/api/test-management/create-test-run.md): Start a new test run and automatically enrol all ready test cases. ### Automation - [List automations](https://collabase.ch/docs/api/automation/list-automations.md): Return all automations accessible to the authenticated user. - [Create automation](https://collabase.ch/docs/api/automation/create-automation.md): Create a new automation. - [Get automation](https://collabase.ch/docs/api/automation/get-automation.md): Retrieve a single automation by ID. - [Update automation](https://collabase.ch/docs/api/automation/update-automation.md): Update an automation's name, description, or flow graph. - [Delete automation](https://collabase.ch/docs/api/automation/delete-automation.md): Permanently delete an automation and all its execution history. - [Toggle automation](https://collabase.ch/docs/api/automation/toggle-automation.md): Enable or disable an automation. - [Trigger automation](https://collabase.ch/docs/api/automation/trigger-automation.md): Manually trigger an automation by its ID. - [Webhook trigger](https://collabase.ch/docs/api/automation/webhook-trigger.md): Fire a WEBHOOK-type automation by sending a POST request to its unique URL. - [List connectors](https://collabase.ch/docs/api/automation/list-connectors.md): Return metadata for all installed automation connectors. - [List templates](https://collabase.ch/docs/api/automation/list-templates.md): Browse public automation templates. - [Approval wait-state](https://collabase.ch/docs/api/automation/approval.md): Check and resolve an automation approval gate via its one-time token. #### Executions - [List executions](https://collabase.ch/docs/api/automation/executions/list-executions.md): Get the 50 most recent execution records for an automation. #### Connections - [List connections](https://collabase.ch/docs/api/automation/connections/list-connections.md): List all connector connections accessible to the authenticated user. - [Create connection](https://collabase.ch/docs/api/automation/connections/create-connection.md): Store credentials for a connector as a reusable named connection. - [Test connection](https://collabase.ch/docs/api/automation/connections/test-connection.md): Verify that a saved connection's credentials are valid. ### SCIM 2.0 - [SCIM 2.0 Provisioning](https://collabase.ch/docs/api/scim/overview.md): Automatically manage your users and groups from Okta, Microsoft Entra ID (Azure AD), or Google Workspace. - [Managing Users via SCIM](https://collabase.ch/docs/api/scim/users.md): How user accounts are created, updated, and deactivated automatically via the API. - [Managing Groups via SCIM](https://collabase.ch/docs/api/scim/groups.md): How groups and their members are synchronized automatically via the API. ### Health - [Health check](https://collabase.ch/docs/api/health.md): Check whether your Collabase instance is running. ## Developer ### Building Extensions - [WASM Plugins](https://collabase.ch/docs/developer/wasm.md): Deploy sandboxed, ultra-fast backend logic and event processors via WebAssembly. ## Release Notes ### Releases - [Release notes](https://collabase.ch/docs/changelog/overview.md): Release notes for Collabase, published here from version 1.0 onwards. > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [English / User guide (98 pages)](https://collabase.ch/docs/_llms/en/user-guide.md): Documentation for English / User guide. - [German (31 pages)](https://collabase.ch/docs/_llms/de.md): Documentation for German. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.