Commencer ici
Si vous n'avez besoin que de la vue d'ensemble, lisez les pages ci-dessous dans l'ordre : ce qu'est MarlinSpike, comment le lancer, comment la chaîne d'analyse est structurée, et où la base de code se dirige à mesure que la famille de dépôts se scinde.
Démarrage
Positionnement produit, commandes de démarrage rapide, flux de travail principal et parcours documentaire pour les nouveaux opérateurs.
Ouvrir la page OpérateursDéploiement
Configuration Docker Compose, guide proxy inverse, données persistantes, mises à jour, sauvegardes et notes de déploiement distant.
Ouvrir la page IntervenantsArchitecture
La chaîne d'analyse en cinq stages, la frontière d'artefact de rapport, la couverture protocolaire, les exports et les constats alignés sur les standards.
Ouvrir la page DéveloppeursFamille de dépôts
Comment le dépôt suite, l'atelier, le moteur, les plugins et les moteurs Rust sont scindés en dépôts de composants faisant autorité.
Ouvrir la pageCarte de la documentation
Le wiki est organisé autour des docs de projet réellement vérifiées, pas de catégories marketing inventées. Chaque page ci-dessous a un fil de source claire qui remonte jusqu'au dépôt.
| Page | Ce qu'elle couvre | Docs source principales |
|---|---|---|
| Démarrage | Identité produit, démarrage rapide, flux de travail et parcours de lecture principal. | README.md, INSTALL.md |
| Déploiement | Docker, proxy inverse, volumes persistants, mises à jour, sauvegardes, déploiement distant, capture live. | INSTALL.md |
| Architecture | Chaîne d'analyse en cinq stages, frontière d'artefact de rapport, couverture de détection, exports et flux opérateur. | README.md |
| Famille de dépôts | Dépôt suite, dépôts de composants, modèle subtree et état de transition. | docs/repo-family.md, CONTRIBUTING.md |
| Extensibilité | Moteurs Rust, plugins Python, packs de règles YAML et attentes de compatibilité. | docs/extensibility-contracts.md |
| Presets | Ce que le dépôt public fournit ou non pour les bibliothèques de captures locales. | presets/README.md, README.md |
| Contribution | Guide PR ciblé, vérifications locales, helpers subtree et règles de gestion des données. | CONTRIBUTING.md |
| Versions | Historique du moteur, versioning de l'interface web, piste live-viewer et faits marquants récents. | releases.md, releases-live.md |
Comment lire le projet
Le dépôt a plus de sens quand on garde quatre idées en vue :
- MarlinSpike est d'abord orienté triage d'incident, pas un visualiseur de paquets généraliste. Le trafic passif entre, la sortie orientée intervenant sort.
- L'artefact de rapport est central. L'atelier le lit, les plugins l'étendent, et les équipes peuvent l'archiver ou le déplacer ailleurs.
- Le modèle opérationnel normal est un hôte temporaire partagé avec une URL partagée, pas un client desktop lourd mono-utilisateur.
- La base de code se scinde intentionnellement en une famille de dépôts pour que le dépôt suite puisse vendorer une combinaison connue pour fonctionner de moteur, atelier, plugins et moteurs Rust.