# Cymph

> Documentation for Cymph,the Incident Response Readiness Platform.

## Docs

- [Signing up to Cymph](https://docs.cymph.io/getting-started/signup.md)
- [Navigating the Cymph platform](https://docs.cymph.io/getting-started/navigating.md)
- [Creating your first playbook](https://docs.cymph.io/getting-started/first_playbook.md)
- [Playbook Management System](https://docs.cymph.io/key-features/kms.md)
- [Mind Maps](https://docs.cymph.io/key-features-explained/mindmaps.md)
- [Playbook Editor](https://docs.cymph.io/key-features/editor.md)
- [Playbook Hub](https://docs.cymph.io/key-features-explained/playbook-hub.md)
- [Playbook Insights](https://docs.cymph.io/key-features/playbook-insights.md)
- [Executions](https://docs.cymph.io/key-features/executions.md)
- [Workspaces](https://docs.cymph.io/key-features/workspaces.md): Create and manage workspaces within your organisation
- [Cymph AI](https://docs.cymph.io/key-features/cymph-ai.md)
- [Home & Your Tasks](https://docs.cymph.io/key-features/home.md)
- [Create a playbook](https://docs.cymph.io/howto/create_playbook.md)
- [Import playbooks](https://docs.cymph.io/howto/import_playbook.md)
- [Execute playbooks](https://docs.cymph.io/howto/execute-playbooks.md)
- [Playbook templates](https://docs.cymph.io/howto/playbook-templates.md)
- [Filters](https://docs.cymph.io/how-tos/filter-playbooks.md)
- [Modify playbook settings](https://docs.cymph.io/howto/modify-playbook-properties.md)
- [Share playbooks](https://docs.cymph.io/howto/share_playbooks.md)
- [Perform actions on a playbook](https://docs.cymph.io/howto/playbook_actions.md)
- [Manage presets](https://docs.cymph.io/how-tos/create-and-manage-presets.md)
- [Manage ensembles](https://docs.cymph.io/howto/ensembles.md)
- [Asset management](https://docs.cymph.io/howto/asset_actions.md)
- [Deploy playbooks](https://docs.cymph.io/how-tos/deploy-playbooks.md)
- [GitHub backup](https://docs.cymph.io/how-tos/github-backup.md)
- [Integrations overview](https://docs.cymph.io/integrations/overview.md): How Cymph connects to the systems you already run — and what each connector reads and writes.
- [Manage integrations](https://docs.cymph.io/integrations/manage.md): Create, test, edit, and delete integrations in a workspace.
- [GitHub](https://docs.cymph.io/integrations/content/github.md): Import playbooks from GitHub repositories and commit playbook backups back to them.
- [GitLab](https://docs.cymph.io/integrations/content/gitlab.md): Fetch playbooks and repository content from GitLab SaaS or a self-managed instance.
- [GitBook](https://docs.cymph.io/integrations/content/gitbook.md): Fetch documentation pages and spaces from GitBook.
- [SharePoint](https://docs.cymph.io/integrations/content/sharepoint.md): Import playbooks from SharePoint documents, and publish playbook documentation back to a site.
- [Confluence](https://docs.cymph.io/integrations/content/confluence.md): Fetch pages and spaces from Atlassian Confluence.
- [Wazuh](https://docs.cymph.io/integrations/detection/wazuh.md): Read Wazuh detection rules and enrolled agents to scope presets and import assets.
- [Microsoft Sentinel](https://docs.cymph.io/integrations/detection/microsoft-sentinel.md): Read Sentinel analytics rules and map their MITRE ATT&CK techniques.
- [Splunk Enterprise Security](https://docs.cymph.io/integrations/detection/splunk-es.md): Read Splunk ES correlation searches and map their MITRE ATT&CK techniques.
- [AWS](https://docs.cymph.io/integrations/cloud/aws.md): Discover AWS resources and import them as Cymph assets.
- [Azure](https://docs.cymph.io/integrations/cloud/azure.md): Discover Azure resources and Entra ID identities, and import them as Cymph assets.
- [Cortex XSOAR](https://docs.cymph.io/integrations/automation/cortex-xsoar.md): Deploy playbooks to a Palo Alto Cortex XSOAR instance.
- [n8n](https://docs.cymph.io/integrations/automation/n8n.md): Deploy playbooks to an n8n instance as workflows.
- [StackStorm](https://docs.cymph.io/integrations/automation/stackstorm.md): Deploy playbooks to a StackStorm instance.
- [Splunk SOAR](https://docs.cymph.io/integrations/automation/splunk-soar.md): Import playbooks from a Splunk SOAR instance into Cymph.
- [JIRA](https://docs.cymph.io/integrations/ticketing/jira.md): Push playbook steps into JIRA as issues.
- [ServiceNow](https://docs.cymph.io/integrations/ticketing/servicenow.md): Connect Cymph to a ServiceNow instance.
- [DFIR-IRIS](https://docs.cymph.io/integrations/ticketing/dfir-iris.md): Read DFIR-IRIS cases and push playbook steps into a case as tasks.
- [Slack](https://docs.cymph.io/integrations/notifications/slack.md): Send execution and task notifications from Cymph into a Slack channel.
- [Account settings](https://docs.cymph.io/settings/account.md)
- [Security settings](https://docs.cymph.io/settings/security-setting.md)
- [Notification settings](https://docs.cymph.io/settings/notifications.md)
- [Language settings](https://docs.cymph.io/settings/language-settings.md)
- [Update your password](https://docs.cymph.io/settings/update_password.md)
- [Leave your organisation](https://docs.cymph.io/settings/leave_org.md)
- [Create an organisation](https://docs.cymph.io/settings/create_org.md)
- [Delete your account](https://docs.cymph.io/settings/delete_account.md)
- [API Access](https://docs.cymph.io/settings/api-access.md)
- [User Management](https://docs.cymph.io/administration/user_management.md)
- [User roles](https://docs.cymph.io/administration/user_roles.md)
- [Manage members](https://docs.cymph.io/administration/manage_members.md)
- [Invite members](https://docs.cymph.io/administration/invite_members.md)
- [Edit your organisation details](https://docs.cymph.io/administration/edit_org.md)
- [Team management](https://docs.cymph.io/administration/team_management.md)
- [Organisation management](https://docs.cymph.io/administration/organisation_management.md): Create and manage organisations from the on-premises administrator account.
- [Deployment models](https://docs.cymph.io/deployment/models.md): The two ways to run Cymph, and who is responsible for what in each.
- [Managed cloud tenant](https://docs.cymph.io/deployment/managed-cloud-tenant.md): A dedicated Cymph instance hosted and operated by Cymph, configured by you.
- [Architecture](https://docs.cymph.io/deployment/self-hosted/architecture.md): The services, ports and data stores that make up a self-hosted Cymph deployment.
- [Requirements](https://docs.cymph.io/deployment/self-hosted/requirements.md): Hardware, software and prerequisites for a self-hosted Cymph deployment.
- [Installation](https://docs.cymph.io/deployment/self-hosted/installation.md): Install Cymph on your own infrastructure with Docker Compose.
- [TLS certificates](https://docs.cymph.io/deployment/self-hosted/tls-certificates.md): Supply, mount and renew the TLS certificates that serve a self-hosted Cymph deployment.
- [Licensing](https://docs.cymph.io/deployment/self-hosted/licensing.md): Upload and manage the license for a self-hosted Cymph deployment.
- [Backup & restore](https://docs.cymph.io/deployment/self-hosted/backup-restore.md): Back up and restore a self-hosted Cymph deployment using Docker volume snapshots.
- [Upgrades](https://docs.cymph.io/deployment/self-hosted/upgrades.md): Update a self-hosted Cymph deployment to a newer release.
- [Common issues](https://docs.cymph.io/deployment/self-hosted/troubleshooting.md): Diagnose a self-hosted Cymph deployment that will not start or is not reachable.
- [Resetting the administrator password](https://docs.cymph.io/deployment/self-hosted/reset-admin-password.md): Recover a forgotten or locked on-premises administrator account.
- [Networking](https://docs.cymph.io/deployment/networking.md): Firewall, allowlisting and egress information for Cymph deployments.
- [SMTP](https://docs.cymph.io/deployment/settings/smtp.md): Configure outbound e-mail for notifications and account recovery.
- [AI configuration](https://docs.cymph.io/deployment/settings/ai.md): Enable and configure the AI provider for a self-hosted deployment.
- [Single sign-on](https://docs.cymph.io/deployment/settings/sso.md): Configure Google, GitHub and Entra ID sign-in for a self-hosted deployment.
- [Playbook Hub & Explore](https://docs.cymph.io/deployment/settings/hub-explore.md): Enable or disable the public Playbook Hub and in-app Explore section.
- [Security architecture](https://docs.cymph.io/security/architecture.md): How Cymph is deployed, where the trust boundaries sit, and how tenant data is separated.
- [Authentication & access control](https://docs.cymph.io/security/authentication-access-control.md): Sign-in methods, multi-factor authentication, session handling and the permission model.
- [Data protection](https://docs.cymph.io/security/data-protection.md): Where Cymph data lives, how sensitive data is encrypted, and who holds the keys.
- [Audit & logging](https://docs.cymph.io/security/audit-logging.md): Review administrative and product activity in the Audit Logs page.
- [AI & data usage](https://docs.cymph.io/security/ai-data-usage.md): Which Cymph features use AI, what data reaches a model, and how the provider is configured.
- [General troubleshooting tips](https://docs.cymph.io/troubleshooting/general.md)
- [I cannot login](https://docs.cymph.io/troubleshooting/cannot_login.md)
- [I have problem registering](https://docs.cymph.io/troubleshooting/registering.md)
- [Reporting a bug](https://docs.cymph.io/troubleshooting/bug_reporting.md)

## OpenAPI Specs

- [openapi](https://docs.cymph.io/api-reference/openapi.json)