frikky
136 lines
4.4 KiB
Markdown
136 lines
4.4 KiB
Markdown
# Installation guide
|
|
Installation of Shuffle is currently only available in docker. Looking for how to update Shuffle? Check the [updating guide](https://shuffler.io/docs/configuration#updating_shuffle)
|
|
|
|
## Docker
|
|
The Docker setup is done with docker-compose and is a single command to get set up.
|
|
|
|
**PS: if you're setting up Shuffle on Windows, go to the next step (Windows Docker setup)**
|
|
|
|
1. Make sure you have Docker and [docker-compose](https://docs.docker.com/compose/install/) installed.
|
|
2. Run docker-compose.
|
|
```
|
|
git clone https://github.com/frikky/Shuffle
|
|
cd Shuffle
|
|
docker-compose up -d
|
|
```
|
|
|
|
When you're done, skip to the "After installation" step below.
|
|
|
|
## Windows Docker setup
|
|
This step is for setting up with Docker on windows from scratch.
|
|
|
|
1. Make sure you have [Docker](https://docs.docker.com/docker-for-windows/install/) and [docker-compose](https://docs.docker.com/compose/install/) installed. WSL2 may be required.
|
|
2. Go to https://github.com/frikky/shuffle/releases and download the latest .zip release (or install git)
|
|
3. Unzip the folder and enter it
|
|
4. Open the .env file and change the line with "OUTER_HOSTNAME" to contain your IP:
|
|
```
|
|
OUTER_HOSTNAME=YOUR.IP.HERE
|
|
```
|
|
5. Run docker-compose
|
|
```
|
|
docker-compose up -d
|
|
```
|
|
|
|
### Configurations (proxies, default users etc.)
|
|
https://shuffler.io/docs/configuration
|
|
|
|
### 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.
|
|
3. Check out https://shuffler.io/docs/configuration as it has a lot of useful information to get started
|
|
|
|
|
|
|
|
### Useful info
|
|
* Check out [getting started](https://shuffler.io/docs/getting_started)
|
|
* 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
|
|
|
|
### Execution problems
|
|
If you have problems with your first execution (hello world), you might need to set the correct Docker API version. Here's how:
|
|
|
|
1. Find your API version by running "docker version"
|
|
```
|
|
$ docker version
|
|
|
|
Client:
|
|
Version: 17.09.1-ce
|
|
API version: 1.32 # <-- this one
|
|
Go version: go1.8.3
|
|
Git commit: 19e2cf6
|
|
Built: Thu Dec 7 22:24:16 2017
|
|
OS/Arch: linux/amd64
|
|
|
|
Server:
|
|
Version: 17.09.1-ce
|
|
API version: 1.32 (minimum version 1.12)
|
|
Go version: go1.8.3
|
|
Git commit: 19e2cf6
|
|
Built: Thu Dec 7 22:22:56 2017
|
|
OS/Arch: linux/amd64
|
|
Experimental: false
|
|
```
|
|
|
|
2. Open docker-compose.yml and change the line with "DOCKER_API_VERSION" to your version.
|
|
3. Restart docker-compose
|
|
```
|
|
docker-compose down
|
|
docker-compose up
|
|
```
|
|
|
|
Related issue: #47
|
|
|
|
# Local development installation
|
|
Local development is pretty straight forward with **ReactJS** and **Golang**. This part is intended to help you run the code for development purposes.
|
|
|
|
**PS: You have to stop the Backend Docker container to get this one working**
|
|
**PPS: Use the "Launch" branch when developing to get it set up easier**
|
|
|
|
## Frontend - ReactJS /w cytoscape
|
|
http://localhost:3000 - Requires [npm](https://nodejs.org/en/download/)/[yarn](https://yarnpkg.com/lang/en/docs/install/#debian-stable)/your preferred manager. Runs independently from backend.
|
|
```bash
|
|
cd frontend
|
|
npm i
|
|
npm start
|
|
```
|
|
|
|
## Backend - Golang
|
|
http://localhost:5001 - REST API - requires [>=go1.13](https://golang.org/dl/)
|
|
```bash
|
|
export DATASTORE_EMULATOR_HOST=0.0.0.0:8000
|
|
cd backend/go-app
|
|
go run *.go
|
|
```
|
|
|
|
**WINDOWS USERS:** You'll have to to add the "export" part as an environment variable.
|
|
|
|
## Database - Datastore
|
|
Based on Google datastore
|
|
```
|
|
docker run -p 8000:8000 google/cloud-sdk gcloud beta emulators datastore start --project=shuffle --host-port 0.0.0.0:8000 --no-store-on-disk
|
|
```
|
|
|
|
## Orborus
|
|
Execution of Workflows:
|
|
PS: This requires some specific environment variables
|
|
```
|
|
cd functions/onprem/orborus
|
|
go run orborus.go
|
|
```
|
|
|
|
|
|
Environments (modify for Windows):
|
|
```
|
|
export ORG_ID=Shuffle
|
|
export ENVIRONMENT_NAME=Shuffle
|
|
export BASE_URL=http://YOUR-IP:5001
|
|
export DOCKER_API_VERSION=1.40
|
|
export SHUFFLE_PASS_WORKER_PROXY=${SHUFFLE_PASS_WORKER_PROXY}
|
|
```
|
|
|
|
**WINDOWS USERS:** You'll have to to add the "export" part as an environment variable.
|
|
|
|
AND THAT's it - hopefully it worked. If it didn't please email [frikky@shuffler.io](mailto:frikky@shuffler.io)
|