diff --git a/.env b/.env index 4ffc4215..de39c311 100644 --- a/.env +++ b/.env @@ -8,15 +8,15 @@ SHUFFLE_DOWNLOAD_WORKFLOW_USERNAME= SHUFFLE_DOWNLOAD_WORKFLOW_PASSWORD= SHUFFLE_DOWNLOAD_WORKFLOW_BRANCH= -SHUFFLE_APP_DOWNLOAD_LOCATION=https://github.com/frikky/shuffle-apps +SHUFFLE_APP_DOWNLOAD_LOCATION=https://github.com/frikky/shuffle-apps SHUFFLE_DOWNLOAD_AUTH_USERNAME= SHUFFLE_DOWNLOAD_AUTH_PASSWORD= SHUFFLE_DOWNLOAD_AUTH_BRANCH= SHUFFLE_APP_FORCE_UPDATE=false # User config for first load. Username & PW: min length 3 -SHUFFLE_DEFAULT_USERNAME= -SHUFFLE_DEFAULT_PASSWORD= +SHUFFLE_DEFAULT_USERNAME=shuffle +SHUFFLE_DEFAULT_PASSWORD==Fr1kky1sN0t@D0g SHUFFLE_DEFAULT_APIKEY= # Local location of your app directory. Can't use ~/ @@ -33,7 +33,7 @@ OUTER_HOSTNAME=shuffle-backend DB_LOCATION=./shuffle-database # Proxy configurations. SHUFFLE_PASS_WORKER_PROXY must be FALSE to not pass the proxy information to sub-apps. -# PS: It will skip proxy for +# PS: It will skip proxy for SHUFFLE_HTTP_PROXY= SHUFFLE_HTTPS_PROXY= SHUFFLE_PASS_WORKER_PROXY=TRUE diff --git a/.github/install-guide.html b/.github/install-guide.html new file mode 100644 index 00000000..45bf03e2 --- /dev/null +++ b/.github/install-guide.html @@ -0,0 +1,126 @@ + + + + + +

Installation guide

+

Installation of Shuffle is currently only available in docker. Looking for how to update Shuffle? Check the updating guide

+

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 installed.
    2. +
  2. Adapt the .env file to your convenience.
    3. +
  3. Run docker-compose.
    git clone https://github.com/frikky/Shuffle
+cd Shuffle
+docker-compose up -d
    4. +
+

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 and docker-compose installed. WSL2 may be required.
    2. +
  2. Go to https://github.com/frikky/shuffle/releases and download the latest .zip release (or install git)
    3. +
  3. Unzip the folder and enter it
    4. +
  4. Open the .env file and change the line with "OUTER_HOSTNAME" to contain your IP:
    OUTER_HOSTNAME=YOUR.IP.HERE
    5. +
  5. Run docker-compose
    docker-compose up -d
    6. +
+

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. +

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

    +
    3. +
  3. Check out https://shuffler.io/docs/configuration as it has a lot of useful information to get started
    4. +
+

Admin account setup

+

Useful info

+ +

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
    2. +
+

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

+
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

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

+
+ +
+ \ No newline at end of file diff --git a/.github/install-guide.md b/.github/install-guide.md index d1c21169..34a1f6f2 100644 --- a/.github/install-guide.md +++ b/.github/install-guide.md @@ -7,7 +7,8 @@ The Docker setup is done with docker-compose and is a single command to get set **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. +2. Adapt the .env file to your convenience. +3. Run docker-compose. ``` git clone https://github.com/frikky/Shuffle cd Shuffle @@ -16,7 +17,7 @@ docker-compose up -d When you're done, skip to the "After installation" step below. -## Windows Docker setup +## 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. @@ -34,7 +35,7 @@ docker-compose up -d ### Configurations (proxies, default users etc.) https://shuffler.io/docs/configuration -### After installation +### 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. @@ -82,14 +83,14 @@ docker-compose up Related issue: #47 -# Local development installation +# 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. +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 @@ -97,7 +98,7 @@ npm start ``` ## Backend - Golang -http://localhost:5001 - REST API - requires [>=go1.13](https://golang.org/dl/) +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 @@ -114,7 +115,7 @@ docker run -p 8000:8000 google/cloud-sdk gcloud beta emulators datastore start - ## Orborus Execution of Workflows: -PS: This requires some specific environment variables +PS: This requires some specific environment variables ``` cd functions/onprem/orborus go run orborus.go