Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
276 commits
Select commit Hold shift + click to select a range
31c0318
[docs]Target page, first version
Jipegien May 2, 2024
7c5c0db
[docs]Expectation page, first version
Jipegien May 2, 2024
6ef1b2d
Page drafting and typo correction in all other pages
Lhorus6 May 2, 2024
7ab8364
[docs]Channel page, first version
Jipegien May 4, 2024
988b6f2
[docs]Media pressure page, first version
Jipegien May 4, 2024
9b39a84
[docs]Injects page, second version
Jipegien May 4, 2024
a98a6bc
[docs]Inject page, fix
Jipegien May 4, 2024
7314c4e
[docs]Inject page, fix2
Jipegien May 4, 2024
69025a8
[docs]Assets page, second version
Jipegien May 4, 2024
484b945
[docs]Adding screenshots to main pages
Jipegien May 5, 2024
e6df9e8
[docs]Adding screenshots to main pages, fix
Jipegien May 5, 2024
3021005
Review "Scenario"
Lhorus6 May 8, 2024
adc1730
Review "Scenario"
Lhorus6 May 8, 2024
28fc2ff
Review "Scenario and simulation"
Lhorus6 May 11, 2024
4d49ec7
[docs] Review multiple pages
Lhorus6 May 14, 2024
e658aa8
[docs] Sanitize
SamuelHassine May 13, 2024
ea2d6ce
[deployment] Refactor deployment documentation
SamuelHassine May 14, 2024
21f35b6
[deployment] Add architecture
SamuelHassine May 14, 2024
7aa520a
[deployment] Finish docs
SamuelHassine May 15, 2024
7931511
[deployment] Add Tanium config and packages
SamuelHassine May 17, 2024
dd3b022
[docs] Update JS documentation tracker
richard-julien May 22, 2024
46b78f6
[docs] Fix rabbitmq config
guillaumejparis May 23, 2024
ff8205d
[deployment] Change repositories
SamuelHassine May 24, 2024
fd2ac78
[deployment] Adjust default configs for SMTP
SamuelHassine May 28, 2024
8d23f1e
[docs] Add doc policies (#22)
savacano28 Jun 14, 2024
22ce667
[docs] Enhance the docs for agents
SamuelHassine Jun 18, 2024
e4eb8e9
[docs] Re-add image
SamuelHassine Jun 18, 2024
3750da1
[docs] Add rabbitmq management port
guillaumejparis Jun 18, 2024
21c53ae
[docs] Fix broken images in policies (#26)
savacano28 Jul 2, 2024
91e1ff6
[docs] Introducing OpenBAS Agent
Christian-DONGMO Jul 5, 2024
a1abb31
[docs] Adding import xls documentation
Dimfacion Jul 23, 2024
3db1d3a
[docs] fix following PR comments
Dimfacion Jul 24, 2024
7394569
[docs] Fix following PR comments
Dimfacion Jul 24, 2024
4452414
[docs] Adding import xls documentation
Dimfacion Jul 25, 2024
c1e24af
[docs] Change docker-compose to docker compose to avoid invalid mount…
RomuDeuxfois Aug 5, 2024
c9ba690
[docs] Add payload documentation (#31)
RomuDeuxfois Aug 5, 2024
d06d990
[docs] Add challenge & lesson documentation (#27)
RomuDeuxfois Aug 5, 2024
3e17293
[docs] Add community contributions section with help chart section
ialejandro Aug 21, 2024
6fedfde
[docs] Improve agent documentation
RomuDeuxfois Aug 22, 2024
075fb51
[dos] Add dynamic filters doc
RomuDeuxfois Aug 22, 2024
60c5225
Adding inject test and test in bulk informations
johanah29 Aug 23, 2024
46a22ad
[docs] Adding inject test and test in bulk informations
johanah29 Aug 26, 2024
16a5a23
Add replay tests infos in Injects page
johanah29 Sep 9, 2024
544264c
[deployment] Introduce new documentation for executors config
SamuelHassine Sep 17, 2024
e3f877e
[docs] Change home resources
SamuelHassine Sep 17, 2024
d040141
[docs] Command Details in execution traces (#37)
damgouj Sep 18, 2024
fd33718
Add replay tests infos in Injects page #36
johanah29 Sep 19, 2024
0341eb8
[deployement] fix executors docs refs to opencti
guillaumejparis Sep 25, 2024
9e73edf
[docs] Add configuration infos for ssl and proxy (#1218)
damgouj Sep 27, 2024
9ee61dc
[docs] Add expiration time in expectations page
johanah29 Oct 3, 2024
a77d48b
[docs] Update expectation validation mode
savacano28 Oct 3, 2024
6b46bf2
[docs] Add infos for executors installation
damgouj Oct 14, 2024
2813879
[docs] Update documentation for variables (#38)
savacano28 Oct 18, 2024
419c58a
[docs] Update configuration of rabbitmq
Dimfacion Oct 24, 2024
3d62eba
[docs] add simulation report page with images
MarineLeM Oct 21, 2024
56ce777
Merge pull request #48 from OpenBAS-Platform/docs/simulation-report
MarineLeM Oct 24, 2024
940506f
[docs] Update OpenBAS x OpenCTI integration
RomuDeuxfois Oct 29, 2024
d299882
[docs] Update dashboard documentation
RomuDeuxfois Oct 29, 2024
5f2b800
[docs] Add gmail example for IMAP & SMTP
RomuDeuxfois Nov 4, 2024
c7dd3a0
[docs] Add AWS IAM Role documentation
Dimfacion Nov 7, 2024
dca46ff
[docs] Remove caldera for main installation
RomuDeuxfois Nov 13, 2024
5c73f44
[docs] Add explanation on payloads (#57, #55)
RomuDeuxfois Nov 19, 2024
970c359
[docs] Improv collectors documentation
RomuDeuxfois Nov 25, 2024
67f6d31
[docs] Add user documentation
savacano28 Nov 29, 2024
135fa83
[docs] Adding doc for chaining injects (#51)
Dimfacion Dec 10, 2024
7508860
[docs] Changing the custom css to have a wider doc (#68)
Dimfacion Dec 10, 2024
87d0ad0
[docs] Update documentation for payloads
savacano28 Dec 11, 2024
06cb488
Migrate config renovate.json (#75)
renovate[bot] Jan 3, 2025
a3677d6
[doc] Update documentation for endpoints and agents
savacano28 Jan 8, 2025
71365e7
[docs] Improv ecosystem documentation
RomuDeuxfois Jan 9, 2025
50e35c7
[docs] Removing the caldera collector
RomuDeuxfois Jan 13, 2025
0637398
[docs] Removed bad mentions of Caldera
RomuDeuxfois Jan 13, 2025
1a1ef36
[docs] Add infos for Windows agent installation
damgouj Jan 17, 2025
e5190ca
[deployment] Add the CrowdStrike executor documentation (#76)
SamuelHassine Jan 18, 2025
9a51825
[docs] Add documents documentation
RomuDeuxfois Jan 20, 2025
b547e85
Adding api documentation issue/43 (#82)
heditar Jan 20, 2025
6a71dd7
[docs] Update doc for feature generating scenario openCTI - openBAS
savacano28 Jan 21, 2025
e399511
[doc] housekeeping
antoinemzs Jan 23, 2025
8e66ce3
[docs] Add warning on inject tests
RomuDeuxfois Jan 24, 2025
5b190a5
[docs] Remove section on mitigations
RomuDeuxfois Jan 27, 2025
0676ea8
[docs] Upgrading recommended versions
Dimfacion Jan 28, 2025
940665d
[docs] Add agent troubleshooting
RomuDeuxfois Jan 28, 2025
2222f1b
adding AssetRule Documentation (#81)
heditar Jan 29, 2025
510df63
[docs] Remove section on skills
RomuDeuxfois Jan 30, 2025
04d2fe5
[docs] add emphasis on configuring rabbitmq postgres minio (#89)
antoinemzs Jan 31, 2025
06679dc
[docs]Add infos on targeted teams (#97)
johanah29 Feb 3, 2025
3c84f9c
Manual inject expectation doc issue/101 (#101)
heditar Feb 6, 2025
8f63c33
[docs] Add manual build
RomuDeuxfois Feb 7, 2025
965f45b
[doc] Explain UUID on injectors and collectors
RomuDeuxfois Feb 7, 2025
392db3c
[docs] Add collectors development explanation
RomuDeuxfois Feb 7, 2025
1157225
[docs] add traces and inject status documentation (#62)
MarineLeM Feb 10, 2025
78f6caa
[docs] Add missing images for enterprise activation
nfillot Feb 20, 2025
898f516
[docs] Add taxonomies
RomuDeuxfois Feb 21, 2025
82fb61b
[docs] Add Injectors development section (docs/#108)
RomuDeuxfois Feb 25, 2025
eaf1ac2
[docs] Upgrading caldera version
Dimfacion Feb 26, 2025
483cb09
Improve documentation on challenges
johanah29 Feb 28, 2025
29694e0
[docs] Update channels.md
clr2of8 Mar 3, 2025
546a751
[docs] Update media_pressure.md
clr2of8 Mar 3, 2025
0bffa0b
[docs] Update collectors.md
clr2of8 Mar 3, 2025
2a013f0
[docs] add openbas.xtm.opencti.api_url in configuration (#2468)
MarineLeM Mar 4, 2025
78d9603
[docs] add documentation on Telemetry (#656)
MarineLeM Mar 5, 2025
d0af2b8
[docs] Update documentation for feature Scenario from OCTI
savacano28 Mar 5, 2025
bf815e6
[docs] New agent installation mode
damgouj Mar 10, 2025
a8a5af1
[README] Add upgrade command
RomuDeuxfois Mar 17, 2025
149235c
[docs] add findings documentation (#124)
guillaumejparis Mar 17, 2025
ece36c4
[docs] Remove token
SamuelHassine Mar 17, 2025
baa5ff1
[docs] Add doc for import/export injects (#119)
savacano28 Mar 17, 2025
7c89fcc
[docs] Add GUI for agent standard installation
damgouj Mar 18, 2025
5a0989f
[docs] Add details for Windows "Service Logon" policy
damgouj Mar 18, 2025
42f3e44
[docs] Fixing bad property name and aligning with other pages
Dimfacion Mar 18, 2025
a45ea2c
[docs] Documented the expectation traces details feature (#133)
impolitepanda Mar 31, 2025
993cbc4
[docs] Add documentation on auto translation
johanah29 Mar 31, 2025
402d778
[docs] Add new Crowdstrike subprocessor for Windows
guillaumejparis Apr 3, 2025
be21de8
[docs] Add details for Crowdstrike host group and properties
damgouj Apr 3, 2025
9b5f97f
[docs]Update of the atomic testing section (#137)
johanah29 Apr 3, 2025
fedc228
[docs] Add documentation for output parsers and findings (#130)
savacano28 Apr 4, 2025
7edbb95
Update translations doc
johanah29 Apr 8, 2025
e6852da
[docs] Install intercom
SamuelHassine Apr 13, 2025
2a253a2
[docs] Fix default CS register interval
damgouj Apr 22, 2025
232efe2
[docs] Findings in different level (#140)
MarineLeM Apr 23, 2025
9c9b598
[docs] add inject.execution.threshold.minutes explanation (#2801)
MarineLeM Apr 23, 2025
9f40db2
[docs] Add managed architectures for agents/implants
damgouj Apr 24, 2025
591f617
[docs] Add custom dashboard (#144)
RomuDeuxfois Apr 24, 2025
cf9cbb4
[docs] Update documentation for atomic testings/injects overview and …
savacano28 Apr 24, 2025
e472515
[docs] license lock EE executors (#2838)
MarineLeM Apr 28, 2025
4cf2a04
[docs] Add elastic configuration
RomuDeuxfois May 6, 2025
5fb0ea0
[docs] Update some assets
RomuDeuxfois May 13, 2025
e7cdd5d
[docs] Adding doc on healthcheck key
Dimfacion May 20, 2025
d536ba1
[docs] add docs for pagination + screen refresh (#2663)
antoinemzs May 20, 2025
9b156ee
[docs] Add status and source details to payloads list view (#64)
savacano28 May 22, 2025
24cf415
[docs] Update description for sources in Payloads (#64)
savacano28 May 26, 2025
f96463b
doc notifications issue/149 (#149)
heditar May 26, 2025
142708e
[docs] add instructions for setting up a dev env in linux
antoinemzs May 28, 2025
b1e91eb
[docs] Change chatbot
SamuelHassine May 31, 2025
1c691ba
[docs] Adapt chatbot context
SamuelHassine May 31, 2025
2e52bde
[docs] scenario assistant (#160)
MarineLeM Jun 2, 2025
3951c41
[tools] Improve readme and add IDEA run config
antoinemzs Jun 3, 2025
63b2830
[docs] Add documentation on agentless endpoints (#161)
johanah29 Jun 3, 2025
0cc9bee
[docs] don't send people to the caldera repo but to the docker one
antoinemzs Jun 3, 2025
2c3c2b1
[docs] Update architecture img
RomuDeuxfois Jun 6, 2025
efcee45
[docs] Remove caldera agent from the overview
RomuDeuxfois Jun 6, 2025
24926cd
[docs] scenario assistant - ai (#3042)
MarineLeM Jun 24, 2025
1502c63
[docs] targeted asset argument doc (#3327)
MarineLeM Jun 24, 2025
cb0b990
[docs] Add detection remediation into payloads and injects (#171)
savacano28 Jul 7, 2025
b65ecc5
[docs] Add CVE notion into taxonomies and findings (#171)
savacano28 Jul 7, 2025
a33932f
[docs] Add remediations as feature EE (#171)
savacano28 Jul 7, 2025
56f4419
[docs] Add docs for custom dashboards and widgets (#168)
damgouj Jul 15, 2025
6627e2d
[docs] Add XTM Hub scenarios libray (#182)
jbanety Jul 21, 2025
cecd374
[docs] Add attribute extra trusted self-signed certs
damgouj Jul 22, 2025
a9f6b8f
[docs] Change tanium URL to tanium API url
RomuDeuxfois Jul 22, 2025
81bf1d6
[docs] Change tanium URL
RomuDeuxfois Jul 23, 2025
15054db
[docs] Improv Tanium documentation
RomuDeuxfois Jul 23, 2025
b17bcaf
[docs]Add documentation on vulnerable Expectation (#172)
johanah29 Jul 28, 2025
745b810
[docs] Improv elastic search documentation (#183)
RomuDeuxfois Jul 29, 2025
c965e89
[docs] Fix link to packages to the "live" (not permalink) url
antoinemzs Jul 31, 2025
b0166a0
[collectors] improve collector dev docs
antoinemzs Aug 4, 2025
02786ad
[docs] Improv elastic search documentation
RomuDeuxfois Aug 7, 2025
7b91731
[docs] Add endpoint/agent attributes explanation (#169)
damgouj Aug 12, 2025
f60e0bc
[docs] Update the link to training / academy
SamuelHassine Aug 18, 2025
ba366d1
[usage] Add proper AV exclusions documentation for runtimes folder
SamuelHassine Aug 21, 2025
5dac5a5
[usage] Enhance note on AV exclusions
SamuelHassine Aug 21, 2025
bcc1e73
[usage] Update agent installation doc
SamuelHassine Aug 23, 2025
6ab4b95
[docs] Documentation on time filters to custom dashboard (#164)
johanah29 Aug 25, 2025
5ce880c
[docs] Improv tanium documentation
RomuDeuxfois Aug 27, 2025
12fa9af
[docs] Fix deployment doc & MacOS agent information
SamuelHassine Aug 30, 2025
f857797
[docs] Improv tanium documentation (#191)
RomuDeuxfois Aug 30, 2025
1e48592
[docs] Improv agent troubleshooting
RomuDeuxfois Sep 11, 2025
3eb230a
[docs] add XTM Hub configuration (#199)
Kroustille Sep 18, 2025
d916df6
[docs] Add permissions documentation (#196)
camrrx Sep 23, 2025
eb927e8
[docs] Add StarterPack doc (#3527)
gabriel-peze Sep 24, 2025
39b6e17
[docs] Improve clone repository command (#200)
damgouj Sep 26, 2025
d3cedc4
[docs] Improv inject expectation doc
RomuDeuxfois Sep 29, 2025
4a16b04
[docs] Import/Export payloads (#207)
RomuDeuxfois Sep 29, 2025
a2d5082
[docs] Add both nmap & nuclei documentation (#173)
RomuDeuxfois Sep 30, 2025
19ecba1
[docs] add default dashboard info (#3531)
MarineLeM Oct 1, 2025
3f36509
[XTMH] doc: add registration and one click deploy documentation (#202)
Kroustille Oct 3, 2025
c2ad2d6
[docs] add XTM Hub connectivity collector configuration (#201)
Kroustille Oct 3, 2025
0ee42cb
[docs] Add SMTP service state listener doc (#3527)
gabriel-peze Oct 9, 2025
8039dd0
[docs] add docs for connector (OpenAEV-Platform/openaev#3705)
antoinemzs Oct 10, 2025
c21ee22
[agent] add curl requirement
guillaumejparis Oct 13, 2025
89b2c9f
Update enterprise.md
Jermain-N Oct 15, 2025
9613a22
[docs] Add documentation for Detection remediation with Ariane (#3668…
EvaE-Filigran Oct 16, 2025
60b755f
[docs] Improve Importing Injects into a Scenario (#4167) (#217)
EvaE-Filigran Oct 16, 2025
8a641d0
[docs] Rename OpenBAS to OpenAEV (#210)
RomuDeuxfois Oct 22, 2025
c2113ac
[docs] Improve RBAC documentation
camrrx Oct 24, 2025
34a26b7
[docs] Start breaking changes documentation
gabriel-peze Oct 27, 2025
ef99136
[docs] Update breaking changes renaming
guillaumejparis Oct 28, 2025
31af362
[docs] Adding banner to the docs for 2.0.0
Dimfacion Oct 28, 2025
9bb47c4
[docs] Fixing url redirection and some bad naming
Dimfacion Oct 28, 2025
20426be
[docs] Fixing url redirection again
Dimfacion Oct 29, 2025
7dfed77
[docs] Update breaking changes with rabbitmq queue renaming
Dimfacion Oct 29, 2025
4d86470
[docs] feat(generation-scenario-octi): remove documentation for gener…
savacano28 Nov 12, 2025
92bf76e
[docs] feat(security-coverage): add documentation for security covera…
savacano28 Nov 21, 2025
5f51bb6
[docs] Improv Getting Started
RomuDeuxfois Nov 27, 2025
545a40d
[docs] Change header level for SAML2 section
RomuDeuxfois Dec 9, 2025
ca50d33
[docs] Introduce full XTM deployment links
SamuelHassine Dec 12, 2025
f3ad36e
[docs] feat(scv): add domains documentation (#236)
GaetanSantucci Dec 15, 2025
59456b6
[docs] SentinelOne executor (#231)
damgouj Dec 15, 2025
64d7da3
[docs] Update OpenAEV agent documentation
RomuDeuxfois Dec 15, 2025
6a15d52
[docs] feat(security-coverage): update creation injects
savacano28 Dec 19, 2025
51018fb
[docs] feat(openaev-agent): improv requirements
RomuDeuxfois Jan 12, 2026
bea5785
[docs] feat(composer): integration manager (#4312)
MarineLeM Jan 14, 2026
5cc8d55
Add domain widget comportment information
GaetanSantucci Jan 23, 2026
286e143
[docs] feat(composer) : adding doc on conf for encryption
Dimfacion Jan 26, 2026
b71ed5b
[docs] feat(catalog) improve catalog doc
camrrx Feb 3, 2026
0b615ba
[docs] chore(workflows): Check MkDocs URIs
RomuDeuxfois Feb 3, 2026
d030e73
[docs] feat(expectation): improv documentation
RomuDeuxfois Feb 3, 2026
3e32cce
[docs] chore: add breaking changes banner
guillaumejparis Feb 4, 2026
0321597
[docs] Migrate assistant
SamuelHassine Feb 14, 2026
61f5986
[doc] feat(stix): add artifacts informations (3511)
gabriel-peze Feb 18, 2026
2c8bb57
[docs] Update actions/checkout action to v6
renovate[bot] Feb 25, 2026
9b00c0e
docs: fix ~58 typos, grammar errors, and inconsistencies across 30 fi…
Copilot Feb 26, 2026
ea7eab4
[docs] chore(breaking-changes): add 2.2.0 breaking changes (#255)
RomuDeuxfois Mar 3, 2026
32b1edc
[docs]: add certificate validation guide for server-side enforcement …
RomuDeuxfois Mar 3, 2026
81c40c9
[docs]: Expand capabilities section in users and RBAC documentation
damians-filigran Mar 4, 2026
2ff6671
[docs] Palo Alto Cortex executor (#256)
damgouj Mar 6, 2026
080723d
[docs] feat(agent): add proxy documentation (#276)
gabriel-peze Mar 25, 2026
5ff55f5
[docs] Deprecated URL
damgouj Mar 30, 2026
702d45e
[docs] chore(clean-info): clean info log from mkdocs
RomuDeuxfois Mar 31, 2026
34ea434
[docs] feat(installation): add troubleshooting section for Docker Com…
RomuDeuxfois Mar 31, 2026
bb3956b
[docs] fix default value for LOGGING_LEVEL_IO_OPENAEV
RomuDeuxfois Mar 31, 2026
84d11ea
[docs] Document the "Migrate" button in Integration Manager (#282)
RomuDeuxfois Apr 17, 2026
d90e925
[docs] Enhance Inject Result Clarity & Actionability (#284)
RomuDeuxfois Apr 21, 2026
9e66825
[docs] Enhance Inject Result Clarity & Actionability (#284)
DeniseMonreale Apr 24, 2026
53eb33c
[docs] feat(csrf): add breaking change for csrf (#287)p
gabriel-peze Apr 27, 2026
5ca1cb7
[docs] feat(threat-arsenal): add doc on threat arsenal (#4458)
MarineLeM May 7, 2026
6fde469
fix(docs): correct misleading implant cleanup statement across third-…
Copilot May 7, 2026
9ef7089
[docs] fix(screenshots): replace outdated OpenBAS branding in agents …
Copilot May 13, 2026
207988a
[docs] add breakglass local account section when SSO is enabled (#281)
RomuDeuxfois May 21, 2026
f93b926
[docs] fix: adding agent specific role and permissions (#297)
heditar May 28, 2026
cf58557
[docs] fix(5962): add max simultaneous jobs configuration (#5962)
gabriel-peze May 28, 2026
046a1a4
[docs] add group mapping and tenant assignment documentation
RomuDeuxfois May 29, 2026
f7c8b2c
[docs] update executor configuration to UI-based (Catalog)
DeniseMonreale Jun 1, 2026
6cd9a7e
[docs] add multi-tenancy administration guide (#280)
RomuDeuxfois Jun 3, 2026
53709a5
[docs] Add AWS Auth OpenSearch (#304)
damgouj Jun 4, 2026
8b83f1c
chore: align with Filigran Conventional Commits & label conventions (…
SamuelHassine Jun 7, 2026
11c0bd6
chore: align CI PR-title check & complete issue templates (#309) (#310)
SamuelHassine Jun 7, 2026
f2af692
chore(renovate): emit Conventional Commits titles (#311) (#312)
SamuelHassine Jun 7, 2026
aefabb1
chore: align issue templates across repositories (#313) (#314)
SamuelHassine Jun 7, 2026
a79b877
chore: audit & align issue templates (#315) (#316)
SamuelHassine Jun 7, 2026
70969c6
chore(dependabot): emit Conventional Commits titles (#317) (#318)
SamuelHassine Jun 7, 2026
03d9de2
chore: finalize issue templates (scoped titles + ordering) (#319) (#320)
SamuelHassine Jun 7, 2026
68089db
docs: clarify primary type labels are issues-only (PRs use ownership …
SamuelHassine Jun 7, 2026
aa7d4de
docs: restrict pull request labels to ownership only (filigran team /…
SamuelHassine Jun 7, 2026
c6196c7
docs: define the allowed pull request label set (ownership, vibe-code…
SamuelHassine Jun 7, 2026
04f0b9a
docs: document audit logging (#293)
Dimfacion Jun 8, 2026
ec50adc
[docs] fix(5962): add max number of pending job (#5962)
camrrx Jun 9, 2026
768a908
docs(multi-tenancy): add multi-tenancy under feature-flag
RomuDeuxfois Jun 11, 2026
f483ed5
docs: migrate documentation repo into monorepo
laugiov Jun 13, 2026
deae582
docs: update repository references and fix broken link after migration
laugiov Jun 13, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
38 changes: 38 additions & 0 deletions docs/.github/ISSUE_TEMPLATE/1-bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Bug report
about: Create a bug report to help us improve OpenAEV
title: 'fix(scope): '
labels: needs triage, bug
assignees: ''
type: bug

---

## Description

<!-- Please provide a clear and concise description of the bug. -->

## Environment

1. OS: { e.g. macOS 14, Windows 11, Ubuntu 22.04, etc. }
2. Version: { e.g. 1.2.3 }
3. Other environment details:

## Reproducible steps

Steps to create the smallest reproducible scenario:
1. { e.g. Run ... }
2. { e.g. Click ... }
3. { e.g. Error ... }

## Expected output

<!-- Please describe what you expected to happen. -->

## Actual output

<!-- Please describe what actually happened. -->

## Additional information

<!-- Any additional information, including logs or screenshots if you have any. -->
29 changes: 29 additions & 0 deletions docs/.github/ISSUE_TEMPLATE/2-feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Feature request
about: Suggest a new feature or capability for OpenAEV
title: 'feat(scope): '
labels: needs triage, feature
assignees: ''
type: feature

---

## Use case

<!-- Please describe the use case for which you need a solution. -->

## Current workaround

<!-- Please describe how you currently solve or work around this problem. -->

## Proposed solution

<!-- Please describe the solution you would like to be provided. -->

## Additional information

<!-- Any additional information, including logs or screenshots if you have any. -->

## If the feature request is approved, would you be willing to submit a PR?

Yes / No (help can be provided if you need assistance submitting a PR)
22 changes: 22 additions & 0 deletions docs/.github/ISSUE_TEMPLATE/3-documentation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Documentation request
description: Request new or improved documentation for OpenAEV.
title: "docs: "
labels:
- needs triage
- documentation
body:
- type: textarea
id: request-details
attributes:
label: Documentation request
description: "Please explain what you want to document or clarify."
placeholder: "Describe the missing documentation, unclear section, or new topic you would like to see covered."
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional context
description: "Any links, screenshots or references that help."
validations:
required: false
28 changes: 28 additions & 0 deletions docs/.github/ISSUE_TEMPLATE/4-question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Question
about: Ask a question about OpenAEV
title: ''
labels: needs triage, question
assignees: ''

---

## Prerequisites

- [ ] I read the documentation and didn't find anything relevant to my problem.
- [ ] I went through old GitHub issues and couldn't find anything relevant.
- [ ] I searched the web and didn't find anything relevant.

## Description

<!-- Please provide a clear and concise description of your question. -->

## Environment

1. OS: { e.g. macOS 14, Windows 11, Ubuntu 22.04, etc. }
2. Version: { e.g. 1.2.3 }
3. Other environment details:

## Additional information

<!-- Any additional information, including logs or screenshots if you have any. -->
1 change: 1 addition & 0 deletions docs/.github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
132 changes: 132 additions & 0 deletions docs/.github/LABELS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
# Title & Label Taxonomy

This document is the **source of truth** for how commits, pull requests and issues
are titled and labeled in this repository. It is shared across all Filigran
repositories (FiligranHQ, OpenCTI-Platform, OpenAEV-Platform, XTM-One-Platform,
OpenGRC-Platform) so the whole ecosystem stays consistent.

The machine-readable companion — each shared label's exact name, color and
description — lives in [`.github/labels.yml`](labels.yml). Keep the two in sync
when adding or renaming a shared label.

## 1. Title convention (Conventional Commits)

Every commit, pull request and issue title follows the
[Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/)
specification, with a GitHub issue reference appended:

```
type(scope?)!?: description (#issue)
```

- `type` is one of: `feat`, `fix`, `chore`, `docs`, `style`, `refactor`, `perf`,
`test`, `build`, `ci`, `revert`.
- `scope` is optional — a **lowercase** noun in parentheses naming the affected
area, e.g. `feat(api):`, `fix(frontend):`, `docs(connectors):`. The scope
**replaces** the old `[backend]` / `[frontend]` / `[component]` bracket
prefixes, which are **discontinued**.
- `!` is optional and marks a breaking change (e.g. `feat(api)!: ...`), optionally
with a `BREAKING CHANGE:` footer.
- `description` **starts with a lowercase letter** and has **no trailing period**.
Preserve acronyms and proper nouns: `OpenCTI`, `OpenAEV`, `XTM One`, `OpenGRC`,
`STIX`, `LLM`, `Docker`, `Redis`.
- `(#issue)` is a **required reference on pull request titles** (the PR title
becomes the squash-merge commit, so the reference lands on `master`/`main`).
Issue titles omit it (the issue *is* the reference).

Enforcement is preventive and lives at the organization (enterprise) level; the
[`FiligranHQ/filigran-ci-tools` `pr-title-check`](https://github.com/FiligranHQ/filigran-ci-tools/tree/main/actions/pr-title-check)
action validates the same format. **Renovate** pull requests are exempt.

**Examples**

```
feat(connectors): add CrowdStrike Falcon endpoint security integration (#1234)
fix(frontend): correct file context limit handling (#1235)
docs: update deployment guide (#1236)
chore(ci): migrate dependency management to uv (#1237)
feat(api)!: remove deprecated v1 endpoints (#1238)
```

## 2. Type label (issues only — one per issue)

The title `type` maps to a primary type label. **Primary type labels are applied
to issues only:**

| Title prefix | Type label | Color |
|--------------|-----------------|--------|
| `feat:` | `feature` | indigo |
| `fix:` | `bug` | red |
| `docs:` | `documentation` | blue |

On issues, also set the GitHub **Type** field to match (`feat:` → `Feature`,
`fix:` → `Bug`, every other type → `Task`).

`chore:`, `style:`, `ci:`, `build:`, `perf:`, `refactor:`, `test:` and `revert:`
are valid types; they do not each require a dedicated label (use a repository
area/scope label where useful). `security` is a **label** (applied on top of the
type, e.g. a `fix:` that closes a vulnerability), not a title type.

> **Pull request labels are restricted to a small allowed set.** A pull request
> carries only:
>
> - exactly **one ownership label — `filigran team` or `community`**;
> - optionally **`vibe-coded`** — an AI-assisted change the author reviews before
> requesting others' review;
> - **language** labels (`javascript`, `python`, `java`, `go`, `rust`,
> `typescript`, …) and the **`dependencies`** label, both applied automatically
> by GitHub/Renovate.
>
> Every other label — primary **type** labels, **area/scope** labels and
> **workflow/triage** labels — is **issue-only** and must **never** be added to a
> pull request; remove any that appear. The PR's `type:` title prefix and its
> linked issue already convey the type and the affected area.

## 3. Workflow & ownership labels

- **Triage**: `needs triage`, `needs more info`, `solved`, `duplicate`,
`wontfix`, `question`.
- **Severity / size**: `critical`, `epic`, `tiny`, `regression`,
`breaking-change`.
- **Ownership**: `filigran team`, `community`, `community support`,
`filigran support`, `partner support`, `enterprise edition`.
- **Security**: `security`.
- **PR review**: `vibe-coded` (an AI-assisted pull request the author reviews
before requesting others' review).
- **CLA**: `cla:pending`, `cla:signed`, `cla:exempt`.
- **Automation**: `dependencies`, `javascript`, `python`, `java`, `do not merge`.

See [`.github/labels.yml`](labels.yml) for the exact colors and descriptions.

## 4. Area / scope labels (optional, may have several)

On top of the shared labels above, repositories define their own area/scope
labels (e.g. `frontend`, `backend`, `connector: <name>`, `collector: <name>`,
`agents`, `authentication`). They add routing context and an issue may carry
more than one. They are **issue-only** — like type and workflow labels, they are
**not** added to pull requests (a PR carries only ownership, `vibe-coded` and the
automatic language / `dependencies` labels). They are not listed in `labels.yml`.

All label names are **lowercase**. Repository-specific labels use a neutral grey
color (`ededed`); only the shared labels above carry color, so the common
taxonomy stands out consistently across every Filigran repository.

## 5. Deprecated labels — do not use

- `enhancement` — use `feature`.
- `feature request` / `feature-request` — use `feature` (+ `needs triage`).
- `improvement` / `nice-to-have` — use `feature` + area labels.

## 6. Quick checklist for a new issue / PR

- [ ] Title follows `type(scope?)!?: description` (lowercase, no trailing period)
- [ ] Pull request titles end with the `(#issue)` reference
- [ ] **Issues only:** exactly one primary type label (`feature` / `bug` /
`documentation`) matches the title prefix, and the GitHub **Type** field
(Feature / Bug / Task) is set to match
- [ ] **Pull requests:** one ownership label (`filigran team` / `community`),
optionally `vibe-coded` and the automatic language / `dependencies` labels —
and **no other label** (type, area/scope and workflow labels are issue-only)
- [ ] Issues: area labels added where useful
- [ ] No deprecated labels
- [ ] Commits are signed and the PR is linked to an issue
38 changes: 38 additions & 0 deletions docs/.github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<!--
Thank you very much for your pull request! We as a community driven project
depend on support and contributions like this.

Title convention (Conventional Commits + GitHub reference):
type(scope?): description (#issue)
Types: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert.
See .github/LABELS.md for the full taxonomy.
-->

### Proposed changes

*
*

### Related issues

<!-- This PR must be linked to an issue. Use a closing keyword. -->
* Closes #

### How to test this PR

<!-- Please give example or instructions for the reviewer to test this PR. -->

### Checklist

- [ ] The PR title follows the Conventional Commits convention `type(scope?): description (#issue)`
- [ ] I signed my commits
- [ ] This PR is linked to an issue
- [ ] I consider the submitted work as finished
- [ ] I tested the code for its functionality
- [ ] I added/updated the relevant documentation
- [ ] Where necessary, I refactored code to improve the overall quality

### Further comments

<!-- If this is a relatively large or complex change, kick off the discussion by
explaining why you chose the solution you did and what alternatives you considered. -->
18 changes: 18 additions & 0 deletions docs/.github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
version: 2
updates:
- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "weekly"
open-pull-requests-limit: 0
commit-message:
prefix: "chore"
include: "scope"
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
open-pull-requests-limit: 0
commit-message:
prefix: "chore"
include: "scope"
Loading
Loading