Merge branch 'main' into 1.4.0

This commit is contained in:
Frikky
2023-12-07 22:40:13 +01:00
committed by GitHub
3 changed files with 22 additions and 9 deletions
+12 -3
View File
@@ -1,5 +1,12 @@
# Installation guide <h1 align="center">
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
</h1>
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. 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 docker-compose up -d
``` ```
### Configurations (proxies, default users etc.) ### Configurations (high availability, scale, proxies, default users etc.)
https://shuffler.io/docs/configuration https://shuffler.io/docs/configuration
![architecture](https://github.com/frikky/Shuffle/raw/main/frontend/src/assets/img/shuffle_architecture.png)
### After installation ### After installation
1. After installation, go to http://localhost:3001 (or your servername - https is on port 3443) 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. 2. Now set up your admin account (username & password). Shuffle doesn't have a default username and password.
+5 -5
View File
@@ -19,23 +19,23 @@ jobs:
include: include:
- app: frontend - app: frontend
path: frontend path: frontend
version: nightly version: 1.3.1
experimental: true experimental: true
- app: backend - app: backend
path: backend path: backend
version: nightly version: 1.3.1
experimental: true experimental: true
- app: app_sdk - app: app_sdk
path: backend/app_sdk path: backend/app_sdk
version: nightly version: 1.3.1
experimental: true experimental: true
- app: orborus - app: orborus
path: functions/onprem/orborus path: functions/onprem/orborus
version: nightly version: 1.3.1
experimental: true experimental: true
- app: worker - app: worker
path: functions/onprem/worker path: functions/onprem/worker
version: nightly version: 1.3.1
experimental: true experimental: true
steps: steps:
- name: Checkout - name: Checkout
+5 -1
View File
@@ -88,9 +88,13 @@ services:
restart: unless-stopped restart: unless-stopped
#memcached: #memcached:
# image: docker.io/bitnami/memcached:1 # image: memcached:latest
# container_name: shuffle-cache # container_name: shuffle-cache
# hostname: shuffle-cache # hostname: shuffle-cache
# mem_limit: 1024m
# environment:
# - MEMCACHED_MEMORY=1024
# - MEMCACHED_MAX_CONNECTIONS=2500
# ports: # ports:
# - 11211:11211 # - 11211:11211