Skip to content

Commit 8f50802

Browse files
author
Chris Lo
authored
docs: Finish FAQ and update messaging
1 parent 5a221e0 commit 8f50802

File tree

1 file changed

+47
-31
lines changed

1 file changed

+47
-31
lines changed

Diff for: README.md

+47-31
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
1-
<h1 align="center">
2-
<img src="img/banner.svg" alt="tracecat">
3-
</h1>
4-
51
<div align="center">
6-
<p>
7-
The open source + AI-native Tines alternative.
8-
</p>
2+
<h2>
3+
Open source AI-native Tines alternative
4+
</h2>
5+
<img src="img/banner.svg" alt="tracecat">
96
</div>
107

11-
[Tracecat](https://tracecat.com) is an open-source workflow automation and case management platform. We are building the features of Tines / Torq / Palo Alto XSOAR using:
8+
</br>
9+
10+
[Tracecat](https://tracecat.com) is an open source automation platform for security teams. We're building the features of Tines / Torq / Palo Alto XSOAR with:
1211

1312
- Enterprise-grade open source tools
1413
- Open source AI infra and GPT models
14+
- Event-driven data transforms
1515
- [Practioner-obsessed UI/UX](#faq)
1616

17-
It's designed to be simple but powerful. Try out our [tutorial](https://docs.tracecat.com) and build your first SOAR automation with AI analysts *in minutes*.
17+
It's designed to be simple but powerful. Try out our [tutorial](https://docs.tracecat.com) and deploy your first AI workflow in 15 minutes.
1818

19-
Tracecat is also Cloud agnostic and deploys anywhere that supports Docker.
19+
Build AI-assisted workflows, enrich alerts, and close cases fast.
2020

21-
## Get started
21+
## Getting started
2222

23-
Help Mario automate away false positives from his pizza shop.
23+
Help Mario, the L1 analyst and part-time pizza chef, automatically flag malicious pizza orders (e.g. pineapple pizza).
2424

2525
## Features
2626

@@ -56,6 +56,8 @@ Tracecat is **not** a 1-to-1 mapping of Tines. Our aim is to give technical team
5656

5757
## Installation
5858

59+
Tracecat is Cloud agnostic and deploys anywhere that supports Docker.
60+
5961
- [x] Authentication
6062
- [x] Supabase
6163
- [ ] Auth.js
@@ -68,20 +70,27 @@ Tracecat is **not** a 1-to-1 mapping of Tines. Our aim is to give technical team
6870

6971
## Is Tracecat enterprise ready?
7072

71-
Yes and no.
72-
73-
Can already scale beyond Tines' free tier, but for enterprise (100+ employees).
73+
Yes and no. Tracecat comes in two versions:
74+
- Embedded: runs on a single instance and scales vertically
75+
- Distributed: scales horizontally with self-healing / resillience
7476

7577
- [x] Embedded architecture (single instance)
7678
- [x] Flunk: homegrown workflow engine based on Flink
7779
- [x] LanceDB
78-
- [x] Tantivy
7980
- [x] Polars
81+
- [x] Tantivy
8082
- [ ] Distributed architecture
8183
- [ ] Apache Flink
8284
- [ ] LanceDB / Lantern
8385
- [ ] Quickwit
8486

87+
Tracacat embedded already offers more than Tines' free tier (3 workflows, 500 workflow runs daily).
88+
It is designed to run automation workflows, store event logs, and run search queries with *extreme* efficiency on a single instance (e.g. EC2, laptop).
89+
You can theorically build and run as many workflows as your RAM, CPU, and network capacity allows.
90+
We don't recommend using Tracecat for enterprise use-cases until Tracecat distributed is released.
91+
92+
If you'd like to stress test Tracecat, please ping us on [Discord](https://discord.gg/n3GF4qxFU8) and we can help you get started!
93+
8594
## Status
8695

8796
- [x] Public Alpha: Anyone can sign up over at [tracecat.com](https://tracecat.com) but go easy on us, there are kinks and we are just getting started.
@@ -92,18 +101,16 @@ We're currently in Public Alpha.
92101

93102
## Community & Support
94103

95-
Join us in building a new, more open kind of automation platform.
104+
Join us in building a newer, more open, kind of automation platform.
96105

97106
- [Tracecat Discord](https://discord.gg/n3GF4qxFU8) for hanging out with the community
98107
- [GitHub issues](https://github.com/TracecatHQ/tracecat/issues)
99108

100109
## Integrations
101110

102-
We are working hard to reach core feature parity with Tines. In the meantime, integrations and OOTB automations will be prioritized according to user feedback.
103-
104-
If you've got suggestions, please let us know on Discord! Any help is welcome :)
111+
We are working hard to reach core feature parity with Tines. Integrations and out-of-the-box automations will be prioritized according to user feedback. If you've got any suggestions, please let us know on Discord 🦾.
105112

106-
Here are just a few integrations we have planned:
113+
Here are just a few integrations on our roadmap:
107114

108115
- [ ] Slack
109116
- [ ] Microsoft Teams
@@ -121,15 +128,11 @@ Looking to report a security vulnerability? Please don't post about it in GitHub
121128

122129
### What does it mean to be "practioner-obsessed"?
123130

124-
Core features, user-interfaces, and day-to-day workflows are based on existing best-practices from [best-in-class security teams](https://medium.com/brexeng/elevating-security-alert-management-using-automation-828004ad596c).
125-
126-
We won't throw in a Clippy chatbot just for the sake of it.
131+
Core features, user-interfaces, and day-to-day workflows are based on existing best-practices from [best-in-class security teams](https://medium.com/brexeng/elevating-security-alert-management-using-automation-828004ad596c). We won't throw in a Clippy chatbot just for the sake of it.
127132

128133
### What does AI-native mean?
129134

130-
AI isn't magic.
131-
132-
At Tracecat we want to build boring AI that integrates with existing workflows, but with a modern UI/UX and robust data engineering.
135+
We believe the most useful AI is "boring AI" (e.g. summarization, semantic search, data enrichment, labelling) that integrates with existing workflows, but with modern UI/UX and robust data engineering. Here are a few ways we are doing this:
133136

134137
### Does the world really need another SOAR?
135138

@@ -139,15 +142,28 @@ At Tracecat we want to build boring AI that integrates with existing workflows,
139142

140143
### Tracecat is a venture-backed start up. Why build open source?
141144

142-
We believe LLMs are a **must-have** technology for defenders.
145+
- We love using and building open source tools.
146+
- Existing "AI" security products hide behind demo-ware, sales calls, and white papers. We want to build in the open: open community, open tutorials, and open vision.
147+
- Create safe space for practioners to experiment with open source AI models in their own isolated environments.
143148

144149
## Contributing
145150

146-
## Open source vs paid
151+
Whether it's big or small, we love contributions.
152+
There's plenty of opportunity for new integrations and bug fixes.
153+
The best way to get started is to ping us on Discord!
147154

148-
Like our favorite data orchestration platforms Apache Airflow and Prefect, we plan to keep our codebase open source. This includes enterprise features such as SSO and multi-tenancy.
155+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
156+
<!-- prettier-ignore-start -->
157+
<!-- markdownlint-disable -->
158+
159+
<!-- markdownlint-restore -->
160+
<!-- prettier-ignore-end -->
161+
162+
<!-- ALL-CONTRIBUTORS-LIST:END -->
163+
164+
## Open source vs paid
149165

150-
We plan to grow through Tracecat Cloud for small-to-mid sized teams. Moreover, deploying, maintaining, and debugging a self-hosted distributed system for >1,000 person enteprises is not easy. We plan to charge a good sum for that service 💸.
166+
The Tracecat codebase is 100% open source under Apache-2.0. This includes (soon-to-be-built) enterprise features such as SSO and multi-tenancy. We offer a paid Cloud version for small-to-mid sized teams. Moreover, we plan to charge service fees to enterprises that want to deploy and maintain a self-hosted distributed version of Tracecat.
151167

152168
## License
153169

0 commit comments

Comments
 (0)