main
md 78 lines 3.66 KB
Rendered Raw
1 <h1 align="center">
2
3 <a href="https://www.socfortress.co"><img src="frontend/src/assets/images/socfortress_logo_default_dark.svg" width="300" height="200"></a>
4
5 SOCFortress CoPilot
6
7 [![Medium](https://img.shields.io/badge/Medium-12100E?style=for-the-badge&logo=medium&logoColor=white)](https://socfortress.medium.com/)
8 [![YouTube Channel Subscribers](https://img.shields.io/youtube/channel/subscribers/UC4EUQtTxeC8wGrKRafI6pZg)](https://www.youtube.com/@taylorwalton_socfortress/videos)
9 [![Discord Shield](https://discordapp.com/api/guilds/871419379999469568/widget.png?style=shield)](https://discord.gg/UN3pNBzaEQ)
10 [![GitHub Sponsors](https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#EA4AAA)](https://github.com/sponsors/taylorwalton)
11
12 [![Get in Touch](https://img.shields.io/badge/📧%20Get%20in%20Touch-Friendly%20Support%20Awaits!-blue?style=for-the-badge)](https://www.socfortress.co/contact_form.html)
13
14 </h1>
15
16 <h4 align="center">
17
18 [SOCFortress CoPilot](https://www.socfortress.co) focuses on providing a single pane of glass for all your security operations needs. Simplify your open source security stack with a single platform focused on making open source security tools easier to use and more accessible.
19
20 ![demo_timeline](frontend/src/assets/images/copilot_gif.gif)
21
22 ## Table of contents
23
24 - [Getting Started](#getting-started)
25 - [Install / Upgrade](#install--upgrade)
26 - [Connectors](#connectors)
27 - [Help](#help)
28 - [License](#license)
29 - [Sponsoring](#sponsoring)
30
31 ## Getting started
32
33 📚 **Documentation:** https://docs.socfortress.co
34
35 CoPilot's true power comes from the ability to integrate with your existing security stack. We have built-in integrations with the following tools:
36
37 - [Wazuh](https://wazuh.com/)
38 - [Graylog](https://www.graylog.org/)
39 - [Velociraptor](https://docs.velociraptor.app/)
40 - [Grafana](https://grafana.com/)
41 - [InfluxDB](https://www.influxdata.com/)
42
43 ❗️ **Note:** CoPilot is currently in beta. We are actively working on adding more integrations and features. If you have any suggestions or feedback, please let us know!
44
45 ### Install / Upgrade
46
47 All install + upgrade instructions live in the docs site (so the README doesn’t drift):
48
49 - **Docs home:** https://docs.socfortress.co
50 - **Install / Upgrade:** https://docs.socfortress.co/getting-started/install-upgrade
51 - (Source file) [`docs/getting-started/install-upgrade.mdx`](docs/getting-started/install-upgrade.mdx)
52
53 Quick upgrade reminder (from your CoPilot directory):
54
55 ```bash
56 docker compose pull
57 docker compose up -d
58 ```
59
60 ## Connectors
61
62 CoPilot is designed to be a single pane of glass for your security operations. Think of it as a hub for all your security tools. CoPilot Connectors are the glue that binds your security tools to CoPilot. We take advantage of the APIs and webhooks provided by your security tools to provide a seamless integration.
63
64 ## Help
65
66 You can reach us on [Discord](https://discord.gg/UN3pNBzaEQ) or by [📧](mailto:info@socfortress.co) if you have any question, issue or idea!
67
68 Check out our full video tutorial series on [![YouTube](https://img.shields.io/badge/YouTube-%23FF0000.svg?style=for-the-badge&logo=YouTube&logoColor=white)](https://www.youtube.com/watch?v=qQbex2zAhWI&list=PLB6hQ_WpB6U0e5oSLXJMcxmSzz7n3zvD-&ab_channel=TaylorWalton)
69
70 ## License
71
72 The contents of this repository is available under [AGPL-3.0 license](LICENSE.txt).
73
74 ## Sponsoring
75
76 If you like this project and want to support it, you can consider becoming a sponsor to help us continue maintaining it and adding new features.
77
78 [![GitHub Sponsors](https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#EA4AAA)](https://github.com/sponsors/taylorwalton)