Quick base change
Shuffling around the .env and Readme
This commit is contained in:
@@ -8,15 +8,15 @@ SHUFFLE_DOWNLOAD_WORKFLOW_USERNAME=
|
|||||||
SHUFFLE_DOWNLOAD_WORKFLOW_PASSWORD=
|
SHUFFLE_DOWNLOAD_WORKFLOW_PASSWORD=
|
||||||
SHUFFLE_DOWNLOAD_WORKFLOW_BRANCH=
|
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_USERNAME=
|
||||||
SHUFFLE_DOWNLOAD_AUTH_PASSWORD=
|
SHUFFLE_DOWNLOAD_AUTH_PASSWORD=
|
||||||
SHUFFLE_DOWNLOAD_AUTH_BRANCH=
|
SHUFFLE_DOWNLOAD_AUTH_BRANCH=
|
||||||
SHUFFLE_APP_FORCE_UPDATE=false
|
SHUFFLE_APP_FORCE_UPDATE=false
|
||||||
|
|
||||||
# User config for first load. Username & PW: min length 3
|
# User config for first load. Username & PW: min length 3
|
||||||
SHUFFLE_DEFAULT_USERNAME=
|
SHUFFLE_DEFAULT_USERNAME=shuffle
|
||||||
SHUFFLE_DEFAULT_PASSWORD=
|
SHUFFLE_DEFAULT_PASSWORD==Fr1kky1sN0t@D0g
|
||||||
SHUFFLE_DEFAULT_APIKEY=
|
SHUFFLE_DEFAULT_APIKEY=
|
||||||
|
|
||||||
# Local location of your app directory. Can't use ~/
|
# Local location of your app directory. Can't use ~/
|
||||||
@@ -33,7 +33,7 @@ OUTER_HOSTNAME=shuffle-backend
|
|||||||
DB_LOCATION=./shuffle-database
|
DB_LOCATION=./shuffle-database
|
||||||
|
|
||||||
# Proxy configurations. SHUFFLE_PASS_WORKER_PROXY must be FALSE to not pass the proxy information to sub-apps.
|
# 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_HTTP_PROXY=
|
||||||
SHUFFLE_HTTPS_PROXY=
|
SHUFFLE_HTTPS_PROXY=
|
||||||
SHUFFLE_PASS_WORKER_PROXY=TRUE
|
SHUFFLE_PASS_WORKER_PROXY=TRUE
|
||||||
|
|||||||
File diff suppressed because one or more lines are too long
@@ -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)**
|
**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.
|
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
|
git clone https://github.com/frikky/Shuffle
|
||||||
cd Shuffle
|
cd Shuffle
|
||||||
@@ -16,7 +17,7 @@ docker-compose up -d
|
|||||||
|
|
||||||
When you're done, skip to the "After installation" step below.
|
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.
|
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.
|
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.)
|
### Configurations (proxies, default users etc.)
|
||||||
https://shuffler.io/docs/configuration
|
https://shuffler.io/docs/configuration
|
||||||
|
|
||||||
### After installation
|
### After installation
|
||||||
1. After installation, go to http://localhost:3001/adminsetup (or your servername)
|
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.
|
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
|
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.
|
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**
|
**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**
|
**PPS: Use the "Launch" branch when developing to get it set up easier**
|
||||||
|
|
||||||
## Frontend - ReactJS /w cytoscape
|
## 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
|
```bash
|
||||||
cd frontend
|
cd frontend
|
||||||
npm i
|
npm i
|
||||||
@@ -97,7 +98,7 @@ npm start
|
|||||||
```
|
```
|
||||||
|
|
||||||
## Backend - Golang
|
## 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
|
```bash
|
||||||
export DATASTORE_EMULATOR_HOST=0.0.0.0:8000
|
export DATASTORE_EMULATOR_HOST=0.0.0.0:8000
|
||||||
cd backend/go-app
|
cd backend/go-app
|
||||||
@@ -114,7 +115,7 @@ docker run -p 8000:8000 google/cloud-sdk gcloud beta emulators datastore start -
|
|||||||
|
|
||||||
## Orborus
|
## Orborus
|
||||||
Execution of Workflows:
|
Execution of Workflows:
|
||||||
PS: This requires some specific environment variables
|
PS: This requires some specific environment variables
|
||||||
```
|
```
|
||||||
cd functions/onprem/orborus
|
cd functions/onprem/orborus
|
||||||
go run orborus.go
|
go run orborus.go
|
||||||
|
|||||||
Reference in New Issue
Block a user