Moved over new launch directives and docs for 0.9.56 launch (creators)
This commit is contained in:
@@ -2,6 +2,7 @@
|
|||||||
ORG_ID=Shuffle
|
ORG_ID=Shuffle
|
||||||
ENVIRONMENT_NAME=Shuffle
|
ENVIRONMENT_NAME=Shuffle
|
||||||
|
|
||||||
|
|
||||||
# Remote github config for first load
|
# Remote github config for first load
|
||||||
SHUFFLE_DOWNLOAD_WORKFLOW_LOCATION=
|
SHUFFLE_DOWNLOAD_WORKFLOW_LOCATION=
|
||||||
SHUFFLE_DOWNLOAD_WORKFLOW_USERNAME=
|
SHUFFLE_DOWNLOAD_WORKFLOW_USERNAME=
|
||||||
@@ -30,6 +31,7 @@ SHUFFLE_FILE_LOCATION=./shuffle-files
|
|||||||
SHUFFLE_ENCRYPTION_MODIFIER=
|
SHUFFLE_ENCRYPTION_MODIFIER=
|
||||||
|
|
||||||
# Other configs
|
# Other configs
|
||||||
|
BASE_URL=http://shuffle-backend:5001
|
||||||
BACKEND_HOSTNAME=shuffle-backend
|
BACKEND_HOSTNAME=shuffle-backend
|
||||||
BACKEND_PORT=5001
|
BACKEND_PORT=5001
|
||||||
FRONTEND_PORT=3001
|
FRONTEND_PORT=3001
|
||||||
@@ -49,8 +51,8 @@ SHUFFLE_PASS_APP_PROXY=FALSE
|
|||||||
TZ=Europe/Amsterdam # Timezone-handler in Orborus, Worker and Apps
|
TZ=Europe/Amsterdam # Timezone-handler in Orborus, Worker and Apps
|
||||||
ORBORUS_CONTAINER_NAME= # Used to FIND the containername. cgroup v2: issue 501
|
ORBORUS_CONTAINER_NAME= # Used to FIND the containername. cgroup v2: issue 501
|
||||||
|
|
||||||
SHUFFLE_BASE_IMAGE_REGISTRY=ghcr.io
|
|
||||||
SHUFFLE_BASE_IMAGE_NAME=frikky
|
SHUFFLE_BASE_IMAGE_NAME=frikky
|
||||||
|
SHUFFLE_BASE_IMAGE_REGISTRY=ghcr.io
|
||||||
SHUFFLE_BASE_IMAGE_TAG_SUFFIX="-0.8.80"
|
SHUFFLE_BASE_IMAGE_TAG_SUFFIX="-0.8.80"
|
||||||
|
|
||||||
# Used for auto-cleanup of containers. REALLY important at scale.
|
# Used for auto-cleanup of containers. REALLY important at scale.
|
||||||
@@ -59,10 +61,10 @@ SHUFFLE_ELASTIC=true
|
|||||||
|
|
||||||
# DATABASE CONFIGURATIONS
|
# DATABASE CONFIGURATIONS
|
||||||
DATASTORE_EMULATOR_HOST=shuffle-database:8000
|
DATASTORE_EMULATOR_HOST=shuffle-database:8000
|
||||||
#SHUFFLE_OPENSEARCH_URL=https://shuffle-opensearch:9200
|
#SHUFFLE_OPENSEARCH_URL=http://shuffle-opensearch:9200
|
||||||
SHUFFLE_OPENSEARCH_URL=http://shuffle-opensearch:9200
|
SHUFFLE_OPENSEARCH_URL=https://shuffle-opensearch:9200
|
||||||
SHUFFLE_OPENSEARCH_USERNAME=
|
SHUFFLE_OPENSEARCH_USERNAME=admin
|
||||||
SHUFFLE_OPENSEARCH_PASSWORD=
|
SHUFFLE_OPENSEARCH_PASSWORD=admin
|
||||||
SHUFFLE_OPENSEARCH_CERTIFICATE_FILE=
|
SHUFFLE_OPENSEARCH_CERTIFICATE_FILE=
|
||||||
SHUFFLE_OPENSEARCH_APIKEY=
|
SHUFFLE_OPENSEARCH_APIKEY=
|
||||||
SHUFFLE_OPENSEARCH_CLOUDID=
|
SHUFFLE_OPENSEARCH_CLOUDID=
|
||||||
|
|||||||
@@ -1,7 +1,22 @@
|
|||||||
# Shuffle
|
<h1 align="center">
|
||||||
[Shuffle](https://shuffler.io) is an automation platform focused on accessibility. We believe everyone should have access to efficient processes, and are striving to make that a possibility by making integrations for YOUR tools. Security Operations is complex, but it doesn't have to be.
|
|
||||||
|
|
||||||
[](https://discord.gg/B2CBzUm)
|
[](https://shuffler.io)
|
||||||
|
|
||||||
|
Shuffle Automation
|
||||||
|
|
||||||
|
</h1><h4 align="center">
|
||||||
|
|
||||||
|
[Shuffle](https://shuffler.io) 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_](https://shuffler.io/docs/features) —
|
||||||
|
[_Community & Support_](https://discord.gg/B2CBzUm) —
|
||||||
|
[_Documentation_](https://shuffler.io/docs) —
|
||||||
|
[_Getting Started_](https://shuffler.io/docs/getting_started) —
|
||||||
|
[_Development_](https://github.com/frikky/Shuffle/blob/master/.github/CONTRIBUTING.md)
|
||||||
|
|
||||||
|
Follow us on Twitter at [@shuffleio](https://twitter.com/shuffleio).
|
||||||
|
|
||||||
|
</h4>
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
@@ -85,15 +100,14 @@ Below is the folder structure with a short explanation
|
|||||||
```bash
|
```bash
|
||||||
├── README.md # What you're reading right now
|
├── README.md # What you're reading right now
|
||||||
├── backend # Contains backend related code.
|
├── backend # Contains backend related code.
|
||||||
│ ├── go-app # The backend golang webserver
|
│ ├── go-app # The backend golang webserver
|
||||||
│ └── app_sdk # The SDK used for apps
|
│ └── app_sdk # The SDK used for apps
|
||||||
├── frontend # Contains frontend code. ReactJS, Material UI and cytoscape
|
├── frontend # Contains frontend code. ReactJS, Material UI and cytoscape
|
||||||
├── functions # Has execution and extension resources, such as the Wazuh integration
|
├── functions # Has execution and extension resources, such as the Wazuh integration
|
||||||
│ ├── onprem # Code for onprem solutions
|
│ ├── onprem # Code for onprem solutions
|
||||||
│ │ ├── Orborus # Distributes execution locations
|
│ │ ├── Orborus # Distributes execution locations
|
||||||
│ │ ├── Worker # Runs a workflow
|
│ │ ├── Worker # Runs a workflow
|
||||||
└ docker-compose.yml # Used for deployments
|
└ docker-compose.yml # Used for deployments
|
||||||
```
|
```
|
||||||
|
|
||||||
**It's in BETA (0.8.60)** - [Get in touch](https://shuffler.io/contact), send a mail to [frikky@shuffler.io](mailto:frikky@shuffler.io) or poke me on twitter [@frikkylikeme](https://twitter.com/frikkylikeme)
|
**It's in BETA** - [Get in touch](https://shuffler.io/contact), send a mail to [frikky@shuffler.io](mailto:frikky@shuffler.io) or poke me on twitter [@frikkylikeme](https://twitter.com/frikkylikeme)
|
||||||
|
|
||||||
|
|||||||
+8
-8
@@ -39,7 +39,6 @@ services:
|
|||||||
#- opensearch #Not necessary because dependancy is handled within the backend itself instead
|
#- opensearch #Not necessary because dependancy is handled within the backend itself instead
|
||||||
#- database
|
#- database
|
||||||
orborus:
|
orborus:
|
||||||
#build: ./functions/onprem/orborus
|
|
||||||
image: ghcr.io/frikky/shuffle-orborus:latest
|
image: ghcr.io/frikky/shuffle-orborus:latest
|
||||||
container_name: shuffle-orborus
|
container_name: shuffle-orborus
|
||||||
hostname: shuffle-orborus
|
hostname: shuffle-orborus
|
||||||
@@ -48,7 +47,6 @@ services:
|
|||||||
volumes:
|
volumes:
|
||||||
- /var/run/docker.sock:/var/run/docker.sock
|
- /var/run/docker.sock:/var/run/docker.sock
|
||||||
environment:
|
environment:
|
||||||
- SHUFFLE_APP_SDK_VERSION=latest
|
|
||||||
- SHUFFLE_WORKER_VERSION=latest
|
- SHUFFLE_WORKER_VERSION=latest
|
||||||
- ORG_ID=${ORG_ID}
|
- ORG_ID=${ORG_ID}
|
||||||
- ENVIRONMENT_NAME=${ENVIRONMENT_NAME}
|
- ENVIRONMENT_NAME=${ENVIRONMENT_NAME}
|
||||||
@@ -61,18 +59,17 @@ services:
|
|||||||
- HTTPS_PROXY=${HTTPS_PROXY}
|
- HTTPS_PROXY=${HTTPS_PROXY}
|
||||||
- SHUFFLE_PASS_WORKER_PROXY=${SHUFFLE_PASS_WORKER_PROXY}
|
- SHUFFLE_PASS_WORKER_PROXY=${SHUFFLE_PASS_WORKER_PROXY}
|
||||||
- SHUFFLE_PASS_APP_PROXY=${SHUFFLE_PASS_APP_PROXY}
|
- SHUFFLE_PASS_APP_PROXY=${SHUFFLE_PASS_APP_PROXY}
|
||||||
- SHUFFLE_ORBORUS_EXECUTION_TIMEOUT=600
|
- SHUFFLE_SWARM_NETWORK_NAME=shuffle_swarm_executions
|
||||||
- SHUFFLE_ORBORUS_EXECUTION_CONCURRENCY=5
|
- SHUFFLE_SCALE_REPLICAS=1
|
||||||
- CLEANUP=${SHUFFLE_CONTAINER_AUTO_CLEANUP}
|
- SHUFFLE_SWARM_CONFIG=runn
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
opensearch:
|
opensearch:
|
||||||
image: opensearchproject/opensearch:1.2.3
|
image: opensearchproject/opensearch:1.2.4
|
||||||
hostname: shuffle-opensearch
|
hostname: shuffle-opensearch
|
||||||
container_name: shuffle-opensearch
|
container_name: shuffle-opensearch
|
||||||
environment:
|
environment:
|
||||||
- bootstrap.memory_lock=true
|
- bootstrap.memory_lock=true
|
||||||
- "OPENSEARCH_JAVA_OPTS=-Xms1024m -Xmx1024m" # minimum and maximum Java heap size, recommend setting both to 50% of system RAM
|
- "OPENSEARCH_JAVA_OPTS=-Xms2048m -Xmx2048m" # minimum and maximum Java heap size, recommend setting both to 50% of system RAM
|
||||||
- plugins.security.disabled=true
|
|
||||||
- cluster.routing.allocation.disk.threshold_enabled=false
|
- cluster.routing.allocation.disk.threshold_enabled=false
|
||||||
- cluster.name=shuffle-cluster
|
- cluster.name=shuffle-cluster
|
||||||
- node.name=shuffle-opensearch
|
- node.name=shuffle-opensearch
|
||||||
@@ -96,3 +93,6 @@ services:
|
|||||||
networks:
|
networks:
|
||||||
shuffle:
|
shuffle:
|
||||||
driver: bridge
|
driver: bridge
|
||||||
|
|
||||||
|
#driver: overlay
|
||||||
|
#driver: bridge
|
||||||
|
|||||||
Reference in New Issue
Block a user