Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/shuffle/shuffle-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
frikky committed Oct 27, 2024
2 parents ff698a0 + b477061 commit 00037cd
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 3 deletions.
7 changes: 7 additions & 0 deletions docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,13 @@ curl https://shuffler.io/api/v1/apps/upload -H "Authorization: Bearer APIKEY" -F
{"success": true, "id": "798f1234c4fb8b4a6300da3c546af45a"}
```

The ID returned is based on these fields being unique:
- Organization
- App Name
- App ID

After an app is uploaded, the App cache for your Organization is cleared, meaning your apps will be loaded from the database directly.
If you want to see whether your app was uploaded or not, you can always check the app directly here (swap appid): https://shuffler.io/apps/{appid}

## Stats and Timelines
Stats and Timelines are a system built to help track changes to something over time. This is used both by internal systems in Shuffle, and is an option for you to use in Workflows or elsewhere to make timelines. Adding statistics was added in versions >1.4.3, and graphing of ANY value will be available soon. Graphs for default tracked information like App and Workflow utilisation is on the [statistics admin page for your Organisation](https://shuffler.io/admin?admin_tab=billing).
Expand Down
5 changes: 5 additions & 0 deletions docs/app_creation.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,10 @@ You may want to change an app later. This can be done by using the /apps UI to f
## Python - Building apps manually
Apps using Python can do pretty much anything you can do on a computer. As an example, most utility functions of Shuffle itself are written with as functions of Python in the app "Shuffle-Tools"

### Uploading an App
[Uploading apps (cloud)](https://shuffler.io/docs/API#upload-a-python-app) or [Local Hotloading (onprem)](https://shuffler.io/docs/app_creation#hotloading-your-app) are the way to go. Look into this when you have a prototype app ready.

### About
One of the first things you have to do is select an SDK. There are three images currently in Shuffle, Alpine, Kali, and Blackarch. Alpine is your standard slim docker image. Kali allows you access to Kali tooling, and Blackarch is arch, with a kitchen sink approach to tools.

In our example, we are going to develop an app that connects to an API for Office365, pulls some log data and returns it as a JSON data structure.
Expand All @@ -274,6 +278,7 @@ Build your Python functions with the expected arguments, and ensure they return

Don't forget to document your app in the docs.md file in each version's directory (see below)!


### Utility functions
The Python SDK has a couple of utility functions and data you can utilize. These are as follows:

Expand Down
8 changes: 5 additions & 3 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@ Welcome to the Shuffle documentation! This guide will help you get up and runnin
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)](https://github.com/shuffle/shuffle/blob/main/.github/install-guide.md)**
Download and install Shuffle on your infrastructure.
- **[Cloud Signup (SaaS)](https://shuffler.io)**
Sign up for Shuffle's cloud-based service and get started quickly.
Download and install Shuffle in your infrastructure.
- **[Cloud Signup (SaaS)](https://shuffler.io/register)**
Sign up for Shuffle's cloud-based service and get started quickly. Allows for Multi-Tenant and [stores data in a location near you](https://shuffler.io/docs/privacy_policy#data-location).
- **[Hybrid Cloud](https://shuffler.io)**
Use Local Shuffle Agents connected to your Shuffle Cloud Organizations.

**Need help? Check out these resources:**
- **[Professional Services](https://shuffler.io/professional-services)**
Expand Down

0 comments on commit 00037cd

Please sign in to comment.