Files
shuffle-cracked/install-guide.md
T
Kaushal Parikh 184fb87520 Update install-guide.md
Changed cd shuffle to cd Shuffle as the repo starts with a capital S
2020-05-21 15:42:43 +05:30

1.1 KiB

Installation guide

Installation of Shuffle is currently only available in docker.

There are four parts to the infrastructure:

  • Frontend - GUI, React
  • Backend - Go
  • Database - Google Datastore
  • Orborus - Go, controls the workers to deploy. Can be used to connect to others' setup
  • Worker - Controls each workflow execution
  • App_sdk - Used

Docker

The Docker setup is done with docker-compose and is a single command to get set up.

  1. Make sure you have Docker and docker-compose installed.

  2. Run docker-compose.

git clone https://github.com/frikky/shuffle
cd Shuffle
docker-compose up -d

After installation

  1. After installation, go to http://localhost:3001/adminsetup (or your servername)

  2. Now set up your admin account (username & password). Shuffle doesn't have a default username and password.

Admin account setup

Useful info

  • The server is available on http://localhost:3001 (or your servername)
  • Further configurations can be done in docker-compose.yml and .env.
  • Default database location is /etc/shuffle