Getting Started with Shuffle
Welcome to the Shuffle documentation! This guide will help you get up and running with Shuffle quickly and effectively.
Table of contents
Overview
Shuffle is an open-source automation platform designed specifically for the security industry. You can start using it for free with the following options:
- Open Source (On-Premises)
Download and install Shuffle in your infrastructure. - Cloud Signup (SaaS)
Sign up for Shuffle's cloud-based service and get started quickly. Allows for Multi-Tenant and stores data in a location near you. - Hybrid Cloud Use Local Shuffle Agents connected to your Shuffle Cloud Organizations.
Need help? Check out these resources:
- Professional Services
Explore our professional services for advanced support and customization. - Training
Access training resources to get up to speed with Shuffle. - Old Training Videos
In case you would like to watch older on-demand training videos. The platform however has significantly improved since then and the current training would be a better match.
Usecases
Usecases are a collection of Workflows that perform a task together. This can be things like handling SIEM alerts, or doing phishing analysis.
Workflows
Workflows connect Apps together to perform an action, typically getting and setting data with API's and using Shuffle's built in tools like Shuffle Tools to modify or format the data. They can be ran and stopped according to your needs, and typically have one starting point and multiple outputs.
Apps
Apps are API's or Python scripts, and can be modified and built by anyone. To use an existing public app in a Workflow, you must first activate it. Public apps can be forked, meaning you can have your own version of them.
Blogposts
- 1. Introducing Shuffle - an Open Source SOAR platform
- 2. Getting started with Shuffle
- 3. Creating your first app - Virustotal and TheHive
- 4. On webhooks and loops - TheHive, Cortex and MISP
- 5. Deploying Shuffle :)
- 6. Automation with Shuffle SOAR
- 7. Simplify Your SOAR Implementation with Shuffle
Usage Models
Workflow Principles
- Variables & nodes
- JSON autocompletion
- Loops
- Nestedloops
- Start nodes
- Triggers
- Subflows
- App Authentication
- Loop filtering
- Shuffle File storage
- Shuffle Datastore (Cache)
- Deduplication
- Liquid formatting
- HTTP & Rest APIs
Shuffle 101
- Learning Startnodes
- Learning the HTTP app
- Cache Tutorial
- File Tutorial
- App Authentication
- Learning Liquid Formatting
- JSON within Shuffle
Shuffle YouTube Videos
Learn about Shuffle - in-depth
Here's a training session we did on Shuffle.
- 00:00 - 00:30: Introduction to Shuffle and what we're building
- 00:30 - 02:00: Feature walkthrough of organizations, app creator, and workflows
- 02:00 - end: Real-time demo, creating use-cases for attendees
Community Videos
1. Understanding Shuffle
Our friends at OpenSecure have created excellent videos to help you learn about Shuffle. Be sure to check them out!
2. What is SOAR?
Learn the basics of SOAR (Security Orchestration, Automation, and Response) and how Shuffle fits into this ecosystem.
Watch now: Shuffle Getting Started - Understanding Shuffle
3. Installing Shuffle
Ready to install Shuffle? Follow this step-by-step guide to get Shuffle up and running quickly.
Watch now: How to Install Shuffle