README.md

Gsoc2 Automation

Gsoc2 is an automation platform for and by the community, focusing on accessibility for anyone to automate. Security operations is complex, but it doesn't have to be.

Key Features — Community & Support — Documentation — Getting Started — Development

Follow us on Twitter at @gsoc2io.

Try it

• Self-hosted: Check out the installation guide
• Cloud: Register at https://gsoc2r.io/register and get cooking (missing a lot of features)

Please consider sponsoring the project if you want to see more rapid development.

Support

• Discord
• Twitter
• Email
• Open issue
• Gsoc2r.io

Blogposts

• 1. Introducing Gsoc2
• 2. Getting started with Gsoc2
• 3. Integrating Gsoc2 with Virustotal and TheHive
• 4. Real-time executions with TheHive, Cortex and MISP

Documentation

Documentation can be found on https://gsoc2r.io/docs and is written here: https://github.com/gsoc2/gsoc2-docs.

Setting up a local development environment

Please follow the steps mentioned here!

Related repositories

• OpenAPI apps: https://github.com/gsoc2/security-openapis
• Documentation: https://github.com/gsoc2/gsoc2-docs
• Workflows: https://github.com/gsoc2/gsoc2-workflows
• Python apps: https://github.com/gsoc2/gsoc2-apps

Features

• Simple, feature rich workflow editor
• App creator using OpenAPI
• Premade apps for your security tools
• Organization and sub-organization control
• Hybrid resource sharing with gsoc2r.io (optional)

Website

https://gsoc2r.io

Contributing

We want to make the world of cybersecurity more accessible and need all the help we can get. Send an email to gsoc2@gsoc2r and we'll make sure to give you any training you may need.

These are the main areas to contribute in:

• Frontend (ReactJS)
• Backend (Golang)
• App Creation (Python & GUI w/OpenAPI)
• Documentation (Markdown)
• Workflow creation (GUI & Conceptualizing)
• Content Creation (Blogs, videos etc)

Contributing guidelines are outlined here.

Contributors

Gsoc2

App magicians

License

All modular information related to Gsoc2 will be under MIT (anyone can use it for whatever purpose), with Gsoc2 itself using AGPLv3.

Workflows: MIT Documentation: MIT Gsoc2 backend: AGPLv3 Apps, specification and App SDK: MIT

Architecture

Repository overview

Below is the folder structure with a short explanation

├── README.md				# What you're reading right now
├── backend					# Contains backend related code.
│   ├── go-app 			# The backend golang webserver
│   └── app_sdk			# The SDK used for apps
├── frontend				# Contains frontend code. ReactJS, Material UI and cytoscape
├── functions				# Has execution and extension resources, such as the Wazuh integration
│   ├── onprem				# Code for onprem solutions
│   │   ├── Orborus 	# Distributes execution locations
│   │   ├── Worker		# Runs a workflow
└ docker-compose.yml 	# Used for deployments

Get in touch, send a mail to gsoc2@gsoc2r.io or poke me on twitter @gsoc2likeme