forked from OpenCTI-Platform/docs
-
Notifications
You must be signed in to change notification settings - Fork 1
/
mkdocs.yml
234 lines (226 loc) · 7.74 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
site_name: OpenCTI Documentation
site_description: Documentation about OpenCTI, the next-generation Cyber Threat Intelligence platform.
site_author: Filigran
site_url: https://docs.opencti.io
copyright: © 2024 Filigran. All rights reserved
repo_name: GitHub
repo_url: https://github.com/OpenCTI-Platform/opencti
edit_uri: https://github.com/OpenCTI-Platform/docs/blob/main/docs/
# Theming
theme:
name: material
custom_dir: overrides
logo: assets/logo.png
features:
- navigation.tabs
- navigation.path
- navigation.footer
- navigation.expand
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- search.highlight
palette:
scheme: filigran
font:
text: IBM Plex Sans
code: Roboto Mono
# CSS
extra_css:
- assets/css/custom.css
# Extra
extra:
version:
provider: mike
analytics:
provider: google
property: G-DB4K9LZPDZ
generator: false
social:
- icon: fontawesome/brands/github
link: https://github.com/OpenCTI-Platform
- icon: fontawesome/brands/medium
link: https://blog.filigran.io
- icon: fontawesome/brands/slack
link: https://community.filigran.io
- icon: fontawesome/brands/linkedin
link: https://linkedin.com/company/filigran
- icon: fontawesome/brands/twitter
link: https://twitter.com/FiligranHQ
- icon: fontawesome/brands/facebook
link: https://facebook.com/FiligranHQ
# Plugins
plugins:
- mike:
alias_type: symlink
canonical_version: latest
- search
- git-committers:
repository: OpenCTI-Platform/docs
branch: main
- git-revision-date-localized:
enable_creation_date: true
type: timeago
- glightbox
# Extensions
markdown_extensions:
- attr_list
- md_in_html
- tables
- admonition
- def_list
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.details
- pymdownx.superfences
- pymdownx.smartsymbols
- pymdownx.critic
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
- pymdownx.betterem
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.highlight:
use_pygments: true
anchor_linenums: true
line_spans: __span
pygments_lang_class: false
auto_title: false
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.snippets:
url_download: true
# Page tree
nav:
- Home: 'index.md'
- Deployment & Setup:
- Platform:
- Overview: deployment/overview.md
- Installation: deployment/installation.md
- Configuration: deployment/configuration.md
- Authentication: deployment/authentication.md
- Upgrade: deployment/upgrade.md
- Breaking changes: deployment/breaking-changes.md
- Ecosystem:
- Connectors: deployment/connectors.md
- Integrations: deployment/integrations.md
- Other resources: deployment/resources.md
- Advanced:
- Platform managers: deployment/managers.md
- Clustering: deployment/clustering.md
- Indices and rollover: deployment/rollover.md
- On-premise map server: deployment/map.md
- Troubleshooting: deployment/troubleshooting.md
- User Guide:
- Getting started: usage/getting-started.md
- Foundations:
- Data model: usage/data-model.md
- Nested objects: usage/nested.md
- Containers: usage/containers.md
- Deduplication: usage/deduplication.md
- Reliability and confidence: usage/reliability-confidence.md
- Meaning of dates: usage/dates.md
- Explore knowledge:
- Overview: usage/overview.md
- Search for knowledge: usage/search.md
- Explore by entity types:
- Analysis: usage/exploring-analysis.md
- Cases: usage/exploring-cases.md
- Events: usage/exploring-events.md
- Observations: usage/exploring-observations.md
- Threats: usage/exploring-threats.md
- Arsenal: usage/exploring-arsenal.md
- Techniques: usage/exploring-techniques.md
- Entities: usage/exploring-entities.md
- Locations: usage/exploring-locations.md
- Pivot and investigate: usage/pivoting.md
- Create knowledge:
- Automated import: usage/import-automated.md
- Import from files: usage/import-files.md
- Manual creations: usage/manual-creation.md
- Analyst workbench: usage/workbench.md
- Enrich knowledge:
- Inferences and reasoning: usage/inferences.md
- Enrichment connectors: usage/enrichment.md
- Merge objects: usage/merging.md
- Ask AI: usage/ask-ai.md
- Act on knowledge:
- Case management: usage/case-management.md
- Notifications and alerting: usage/notifications.md
- Background tasks: usage/background-tasks.md
- Dashboards:
- Custom dashboards: usage/dashboards.md
- Share custom dashboards: usage/dashboards-share.md
- Widget creation: usage/widgets.md
- Tips for widget creation: usage/tips-widget-creation.md
- Workflows and assignation: usage/workflows.md
- Indicators lifecycle: usage/indicators-lifecycle.md
- Automation: usage/automation.md
- Delete and restore knowledge: usage/delete-restore.md
- Sharing and exports:
- Native feeds: usage/feeds.md
- Manual export: usage/export.md
- Administration:
- Introduction: administration/introduction.md
- Enterprise edition: administration/enterprise.md
- Data management:
- Merging and de-duplication: administration/merging.md
- CSV Mappers: administration/csv-mappers.md
- Platform settings:
- Parameters: administration/parameters.md
- Security:
- Policies: administration/policies.md
- Users and RBAC: administration/users.md
- Data segregation:
- Marking restriction: administration/segregation.md
- Organization segregation: administration/organization-segregation.md
- Customization:
- Entity types: administration/entities.md
- Rules engine: administration/reasoning.md
- Notifiers:
- Custom notifiers: administration/notifiers.md
- Notifier samples: administration/notifier-samples.md
- Retention policies: administration/retentions.md
- Decay rules: administration/decay-rules.md
- Taxonomies: administration/ontologies.md
- Activity:
- Overview: administration/audit/overview.md
- Events: administration/audit/events.md
- Configuration: administration/audit/configuration.md
- Activity triggers: administration/audit/triggers.md
- File indexing: administration/file-indexing.md
- Support package: administration/support-package.md
- Reference:
- Data:
- Data model: reference/data-model.md
- Data Intelligence: reference/data-intelligence.md
- Taxonomy: reference/taxonomy.md
- APIs and feeds:
- GraphQL API: reference/api.md
- Filters:
- Filters knowledge: reference/filters.md
- Filter migration for 5.12: reference/filters-migration.md
- Data Streaming: reference/streaming.md
- Deployment and stack:
- Usage telemetry: reference/usage-telemetry.md
- FIPS 140-2 installation: reference/fips.md
- Development:
- Prerequisites:
- Ubuntu: development/environment_ubuntu.md
- Windows: development/environment_windows.md
- Platform: development/platform.md
- Python library: development/python.md
- Connectors: development/connectors.md
- Playground: development/api-usage.md