diff --git a/.github/install-guide.md b/.github/install-guide.md index 1ca90c4f..f033838a 100755 --- a/.github/install-guide.md +++ b/.github/install-guide.md @@ -1,5 +1,12 @@ -# 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) +

+ +[![Shuffle Logo](https://github.com/Shuffle/Shuffle/blob/main/frontend/public/images/Shuffle_logo_new.png)](https://shuffler.io) + +Shuffle Installation + +

+ +Installation of Shuffle is currently available for docker and kubernetes. Looking for how to update Shuffle? Check the [updating guide](https://shuffler.io/docs/configuration#updating_shuffle) This document outlines an introduction environment which is not scalable. [Read here](https://shuffler.io/docs/configuration#production_readiness) for information on production readiness. This also includes system requirements and configurations for Swarm or Kubernetes. @@ -55,9 +62,11 @@ OUTER_HOSTNAME=YOUR.IP.HERE docker-compose up -d ``` -### Configurations (proxies, default users etc.) +### Configurations (high availability, scale, proxies, default users etc.) https://shuffler.io/docs/configuration +![architecture](https://github.com/frikky/Shuffle/raw/main/frontend/src/assets/img/shuffle_architecture.png) + ### After installation 1. After installation, go to http://localhost:3001 (or your servername - https is on port 3443) 2. Now set up your admin account (username & password). Shuffle doesn't have a default username and password. diff --git a/.github/workflows/dockerbuild.yaml b/.github/workflows/dockerbuild.yaml index bb2a29fc..ca750fa5 100644 --- a/.github/workflows/dockerbuild.yaml +++ b/.github/workflows/dockerbuild.yaml @@ -19,23 +19,23 @@ jobs: include: - app: frontend path: frontend - version: nightly + version: 1.3.1 experimental: true - app: backend path: backend - version: nightly + version: 1.3.1 experimental: true - app: app_sdk path: backend/app_sdk - version: nightly + version: 1.3.1 experimental: true - app: orborus path: functions/onprem/orborus - version: nightly + version: 1.3.1 experimental: true - app: worker path: functions/onprem/worker - version: nightly + version: 1.3.1 experimental: true steps: - name: Checkout diff --git a/docker-compose.yml b/docker-compose.yml index 3ca6d2f0..727f3e65 100755 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -88,9 +88,13 @@ services: restart: unless-stopped #memcached: - # image: docker.io/bitnami/memcached:1 + # image: memcached:latest # container_name: shuffle-cache # hostname: shuffle-cache + # mem_limit: 1024m + # environment: + # - MEMCACHED_MEMORY=1024 + # - MEMCACHED_MAX_CONNECTIONS=2500 # ports: # - 11211:11211