Shuffle

Shuffle Automation

Shuffle is an open source automation platform, built for and by the security professionals. Security operations is complex, but it doesn't have to be. Built to work well with MSSP's and other service providers in mind.

Key Features — Community & Support — Get training - Documentation — Getting Started

Follow us on Twitter at @shuffleio.

Try it

• Self-hosted: Check out the installation guide
• Cloud: Register at https://shuffler.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
• Shuffler.io

Blogposts

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

Documentation

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

Setting up a local development environment

Please follow the steps mentioned here!

Related repositories

• OpenAPI apps: https://github.com/shuffle/security-openapis
• Documentation: https://github.com/shuffle/shuffle-docs
• Workflows: https://github.com/shuffle/shuffle-workflows
• Python apps: https://github.com/shuffle/shuffle-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 shuffler.io (optional)

Website

https://shuffler.io

Contributing

We want to make the world of cybersecurity more accessible and need all the help we can get. Send an email to support@shuffler 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

Shuffle

App magicians

License

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

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

Architecture

Security Contributors: Hall of Fame

Pushpraj - Reported several issues between July and August 2024

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 [email protected] or poke me on twitter @frikkylikeme