| 1 | site_name: SOCFortress CoPilot Docs |
| 2 | site_description: User guide and developer/AI-agent documentation for SOCFortress CoPilot |
| 3 | site_url: https://socfortress.github.io/CoPilot/ |
| 4 | repo_url: https://github.com/socfortress/CoPilot |
| 5 | edit_uri: edit/main/ |
| 6 | |
| 7 | # Optional: show a link to the repo in the header like many MkDocs sites |
| 8 | repo_name: socfortress/CoPilot |
| 9 | |
| 10 | # Use pretty URLs (/user/overview/) instead of .html pages. |
| 11 | use_directory_urls: true |
| 12 | |
| 13 | theme: |
| 14 | name: material |
| 15 | language: en |
| 16 | logo: assets/brand/logo.png |
| 17 | favicon: assets/brand/favicon.ico |
| 18 | font: |
| 19 | text: IBM Plex Sans |
| 20 | code: JetBrains Mono |
| 21 | palette: |
| 22 | - scheme: slate |
| 23 | primary: custom |
| 24 | accent: custom |
| 25 | features: |
| 26 | - navigation.instant |
| 27 | - navigation.instant.progress |
| 28 | - navigation.sections |
| 29 | - navigation.expand |
| 30 | - navigation.tracking |
| 31 | - navigation.path |
| 32 | - navigation.top |
| 33 | - navigation.indexes |
| 34 | - toc.follow |
| 35 | - content.code.copy |
| 36 | - search.suggest |
| 37 | - search.highlight |
| 38 | |
| 39 | plugins: |
| 40 | - search |
| 41 | |
| 42 | extra: |
| 43 | generator: false |
| 44 | social: |
| 45 | - icon: fontawesome/brands/github |
| 46 | link: https://github.com/socfortress/CoPilot |
| 47 | - icon: fontawesome/solid/globe |
| 48 | link: https://www.socfortress.co |
| 49 | - icon: fontawesome/brands/youtube |
| 50 | link: https://www.youtube.com/@taylorwalton_socfortress |
| 51 | - icon: fontawesome/brands/medium |
| 52 | link: https://medium.com/@socfortress |
| 53 | - icon: fontawesome/brands/linkedin |
| 54 | link: https://www.linkedin.com/company/socfortressmdr/ |
| 55 | |
| 56 | markdown_extensions: |
| 57 | - admonition |
| 58 | - attr_list |
| 59 | - md_in_html |
| 60 | - pymdownx.details |
| 61 | - pymdownx.superfences |
| 62 | - pymdownx.tabbed: |
| 63 | alternate_style: true |
| 64 | - toc: |
| 65 | permalink: true |
| 66 | - tables |
| 67 | - def_list |
| 68 | - footnotes |
| 69 | |
| 70 | extra_css: |
| 71 | - stylesheets/socfortress-theme.css |
| 72 | - stylesheets/extra.css |
| 73 | |
| 74 | nav: |
| 75 | - Home: index-mkdocs.md |
| 76 | - Getting Started: [] |
| 77 | - User Guide: |
| 78 | - Overview: user/overview.md |
| 79 | - Quickstart (Operators): user/operators-quickstart.md |
| 80 | - Quickstart (Admins/Engineers): user/admins-quickstart.md |
| 81 | - Customer Provisioning (Tenancy): user/customer-provisioning.md |
| 82 | - Features by Area: user/features.md |
| 83 | - CoPilot ↔ Shuffle Integration (Admin/Operator): user/shuffle-integration.md |
| 84 | - Navigation Guide (UI): user/navigation.md |
| 85 | - UI Guide (mirrors menu): |
| 86 | - Start here: user/ui/README.md |
| 87 | - Overview: user/ui/overview.md |
| 88 | - Incident Management: |
| 89 | - Incident Management: user/ui/incident-management.md |
| 90 | - Sources: user/ui/incident-sources.md |
| 91 | - Alerts: user/ui/incident-alerts.md |
| 92 | - Cases: user/ui/incident-cases.md |
| 93 | - Case Templates: user/ui/incident-case-templates.md |
| 94 | - Alerting → Shuffle (notifications): user/ui/alerting-shuffle.md |
| 95 | - Alerts: |
| 96 | - Alerts: user/ui/alerts.md |
| 97 | - SIEM: user/ui/alerts-siem.md |
| 98 | - Event Search: user/ui/siem-event-search.md |
| 99 | - MITRE ATT&CK: user/ui/alerts-mitre.md |
| 100 | - Atomic Red Team: user/ui/alerts-atomic-red-team.md |
| 101 | - Event Sources (Admin): user/ui/siem-event-sources.md |
| 102 | - Artifacts: user/ui/artifacts.md |
| 103 | - Customers: user/ui/customers.md |
| 104 | - Agents: |
| 105 | - Agents: user/ui/agents.md |
| 106 | - Groups: user/ui/agents-groups.md |
| 107 | - Sysmon Config: user/ui/agents-sysmon-config.md |
| 108 | - Detection Rules: user/ui/agents-detection-rules.md |
| 109 | - CoPilot Actions: user/ui/agents-copilot-actions.md |
| 110 | - Vulnerability Overview: user/ui/agents-vulnerability-overview.md |
| 111 | - Patch Tuesday: user/ui/agents-patch-tuesday.md |
| 112 | - SCA Overview: user/ui/agents-sca-overview.md |
| 113 | - Report Creation: |
| 114 | - Report Creation: user/ui/report-creation.md |
| 115 | - General Reports: user/ui/report-general.md |
| 116 | - Vulnerability Reports: user/ui/report-vulnerability.md |
| 117 | - SCA Reports: user/ui/report-sca.md |
| 118 | - Healthcheck: user/ui/healthcheck.md |
| 119 | - Indices: |
| 120 | - Indices: user/ui/indices.md |
| 121 | - Index Management: user/ui/indices-management.md |
| 122 | - Snapshot & Restore: user/ui/indices-snapshots.md |
| 123 | - Graylog: |
| 124 | - Graylog: user/ui/graylog.md |
| 125 | - Management: user/ui/graylog-management.md |
| 126 | - Metrics: user/ui/graylog-metrics.md |
| 127 | - Pipelines: user/ui/graylog-pipelines.md |
| 128 | - Threshold Alerts: user/ui/alerts-graylog-threshold.md |
| 129 | - Tag-Based Access Control (Tag RBAC): user/ui/tag-access.md |
| 130 | - Connectors: user/ui/connectors.md |
| 131 | - External Services: |
| 132 | - External Services: user/ui/external-services.md |
| 133 | - 3rd Party Integrations: user/ui/external-third-party-integrations.md |
| 134 | - Network Connectors: user/ui/external-network-connectors.md |
| 135 | - Singul App Auth: user/ui/external-singul-app-auth.md |
| 136 | - Scheduler: user/ui/scheduler.md |
| 137 | - Customer Portal: user/ui/customer-portal.md |
| 138 | - Videos (Playlist): user/videos.md |
| 139 | - Developer / AI Agent Docs: |
| 140 | - Start Here: developer/start-here.md |
| 141 | - Architecture: architecture/ARCHITECTURE.md |
| 142 | - Map: architecture/MAP.md |
| 143 | - Deployment: architecture/DEPLOYMENT.md |
| 144 | - Data Flows: architecture/DATA_FLOWS.md |
| 145 | - Database Schema: architecture/DATABASE_SCHEMA.md |
| 146 | - Adding a Connector: integrations/ADDING_A_CONNECTOR.md |