Skip to content

Commit

Permalink
Merge branch 'main' into 1.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
frikky committed Dec 7, 2023
2 parents bb37e3e + e493d08 commit acd0f1c
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 9 deletions.
15 changes: 12 additions & 3 deletions .github/install-guide.md
Original file line number Diff line number Diff line change
@@ -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)
<h1 align="center">

[![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.

Expand Down Expand Up @@ -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.
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/dockerbuild.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 5 additions & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit acd0f1c

Please sign in to comment.