Skip to content

Commit

Permalink
Feature/50 added documentation to docsy
Browse files Browse the repository at this point in the history
  • Loading branch information
RabbITCybErSeC authored and MaartendeKruijf committed Feb 22, 2024
1 parent bc5b33b commit 070ae78
Show file tree
Hide file tree
Showing 25 changed files with 3,161 additions and 1,062 deletions.
55 changes: 0 additions & 55 deletions doc/controller.md

This file was deleted.

111 changes: 0 additions & 111 deletions doc/database.md

This file was deleted.

86 changes: 0 additions & 86 deletions doc/soarca-application-design.md

This file was deleted.

13 changes: 13 additions & 0 deletions documentation/content/en/docs/FAQ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Frequently asked questions
linkTitle: FAQ
weight: 21
---


## General questions

### Does SOARCA have a GUI?

SOARCA currently does not feature a GUI for tracking the progress on playbook execution. Too edit [CACAO v2.0](https://docs.oasis-open.org/cacao/security-playbooks/v2.0/security-playbooks-v2.0.html) playbooks, consider using the [CACAO Roaster](https://github.com/opencybersecurityalliance/cacao-roaster) project.

48 changes: 48 additions & 0 deletions documentation/content/en/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,51 @@ linkTitle: Docs
menu: {main: {weight: 20}}
weight: 20
---


{{% alert title="Warning" color="warning" %}}
SOARCA is currently in its **alpha release**, with ongoing active development aimed at expanding its integration capabilities and enhancing its functionalities. You can track our progress and upcoming milestones at the provided location.

We warmly welcome contributions to our repository. You can find the guidelines for contributing [here](/docs/contribution-guidelines).
{{% /alert %}}


SOARCA, an open-source SOAR (Security Orchestration, Automation and Response) tool developed by TNO, is designed to be vendor-agnostic, allowing integrate with various systems and technologies. SOARCA is the first SOAR to be fully compliant to the the latest [CACAO v2.0](https://docs.oasis-open.org/cacao/security-playbooks/v2.0/security-playbooks-v2.0.html) standard.

The SOARCA SOAR enables cyber defenders to coordinate and automate cyber operations. SOARCA aims to achieve the following goals:

Introducing a distinctive SOAR tool that addresses current market gaps:

- **Vendor-Agnostic Compatibility**: Our solution ensures seamless integration with various vendors, eliminating reliance on a single provider.
- **Standard Compliance**: Adhering to the latest standards, including [CACAO v2.0](https://docs.oasis-open.org/cacao/security-playbooks/v2.0/security-playbooks-v2.0.html) and [OpenC2](https://openc2.org/), guarantees up-to-date and secure operations.
- **Extensibility with Open Interfaces**: Enjoy the flexibility of an extensible tool featuring open and well-defined interfaces, promoting adaptability and customization.
- **Open-Source Affordability**: Embrace an open-source model that not only offers cost-effective solutions but also supports unrestricted use and adaptation for research purposes.


Are you interested in the vision and concepts of SOARCA? Check the SOARCA vision and concepts [page](/docs/concepts/).


## SOARCA Currently integrates with

<div class="works-well-with">
{{< cardpane >}}
{{% card header="[OpenC2 - Native capability](https://openc2.org/)" %}}
[![OpenC2](/images/logos-external/openc2.svg)](/flux/guides/monitoring/)
{{% /card %}}

{{% card header="[HTTP - Native capability](https://openc2.org/)" %}}
[![Http](/images/logos-external/http.svg)](/flux/guides/monitoring/)
{{% /card %}}
{{< /cardpane >}}
</div>


## Features of SOARCA



## Where do I start?

{{% alert title="primary" color="primary" %}}
Following our [Getting started](/docs/getting-started/) guide will help you setup SOARCA and configure the SOAR for your internal security tooling. For more custom requirement
{{% /alert %}}
20 changes: 20 additions & 0 deletions documentation/content/en/docs/about/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: About
weight: 7
description:
---

## About COSSAS

SOARCA finds its home within the Community for Open Source Security Automation Software (COSSAS). [COSSAS](https://cossas-project.org/') offers a continuously expanding base of novel software components for cyber security automation that SOC, CERT and CTI professionals can deploy and trial in their own operational environments. COSSAS is part of the TNO.

## About TNO

SOARCA is an project initiated and support by [TNO](https://tno.nl), the Netherlands Organisation for Applied Scientific Research. TNO, an independent research, development, and consultancy organization in the Netherlands, is dedicated to driving innovation for a safer, healthier, and more sustainable life. TNO focuses on areas such as sustainability, health, safety, and digital transformation. The mission is to make knowledge serve the common good, connecting expertise to create impactful innovations. TNO actively engages with society, aiming for positive impact through its work and insights. Learn more about TNO on their official website .


## Developers




Loading

0 comments on commit 070ae78

Please sign in to comment.