Skip to content

Commit 7b9c5f1

Browse files
authored
Update configuration.md
1 parent 7b4de69 commit 7b9c5f1

File tree

1 file changed

+14
-21
lines changed

1 file changed

+14
-21
lines changed

docs/configuration.md

Lines changed: 14 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -256,26 +256,19 @@ Docker Compose Installation Guide: https://docs.docker.com/compose/install/
256256
1. Add and change the following environment variables for Orborus in the docker-compose.yml file. `BASE_URL` is the external URL of the server you're running Shuffle on (the one you visit Shuffle with in your browser):
257257
```
258258
# Required:
259-
## Free since Shuffle 2.0.0-beta
260-
- SHUFFLE_SWARM_CONFIG=run
261-
262-
## Ensures apps are not halting due to memory overloads
263-
- SHUFFLE_LOGS_DISABLED=true
264-
265-
## Your Shuffle URL NEEDS to be replaced by the backend's public IP. Otherwise Docker DNS: https://dockerlabs.collabnix.com/intermediate/networking/Configuring_DNS.html
266-
- BASE_URL=http://YOUR-BACKEND-URL:3001
267-
268-
## Worker image choice
269-
- SHUFFLE_WORKER_IMAGE=ghcr.io/shuffle/shuffle-worker:nightly
270-
271-
## Optional configuration:
272-
SHUFFLE_AUTO_IMAGE_DOWNLOAD=false # This should be set to false IF images are already downloaded
273-
SHUFFLE_WORKER_SERVER_URL=http://shuffle-workers # Internal Docker Worker URL (don't modify if not necessary)
274-
SHUFFLE_SWARM_NETWORK_NAME=shuffle_swarm_executions # If you want a special network name in the executions
275-
SHUFFLE_SCALE_REPLICAS=1 # The amount of worker container replicas PER NODE (since 1.2.0)
276-
SHUFFLE_APP_REPLICAS=1 # The amount of app container replicas PER NODE (since 1.2.1)
277-
SHUFFLE_MAX_SWARM_NODES=1 # The max amount of swarm nodes shuffle can use (since 1.3.2)
278-
SHUFFLE_SKIPSSL_VERIFY=true # Stops Shuffle's internal services from validating TLS/SSL certificates. Good to use if BASE_URL is a domain.
259+
- SHUFFLE_SWARM_CONFIG=run # Enables SWARM scaling
260+
- SHUFFLE_LOGS_DISABLED=true # Ensures we don't have memory issues
261+
- BASE_URL=http://YOUR-BACKEND-IP:3001 # replaced by the backend's public IP
262+
- SHUFFLE_WORKER_IMAGE=ghcr.io/shuffle/shuffle-worker:latest
263+
264+
# Optional configuration:
265+
- SHUFFLE_AUTO_IMAGE_DOWNLOAD=false # This should be set to false IF images are already downloaded
266+
- SHUFFLE_WORKER_SERVER_URL=http://shuffle-workers # Internal Docker Worker URL (don't modify if not necessary)
267+
- SHUFFLE_SWARM_NETWORK_NAME=shuffle_swarm_executions # If you want a special network name in the executions
268+
- SHUFFLE_SCALE_REPLICAS=1 # The amount of worker container replicas PER NODE (since 1.2.0)
269+
- SHUFFLE_APP_REPLICAS=1 # The amount of app container replicas PER NODE (since 1.2.1)
270+
- SHUFFLE_MAX_SWARM_NODES=1 # The max amount of swarm nodes shuffle can use (since 1.3.2)
271+
- SHUFFLE_SKIPSSL_VERIFY=true # Stops Shuffle's internal services from validating TLS/SSL certificates. Good to use if BASE_URL is a domain.
279272
280273
```
281274

@@ -1354,4 +1347,4 @@ sudo podman-compose -f docker-compose.yml up
13541347

13551348
### Marketplace Setup
13561349

1357-
Using cloud marketplaces ([AWS Marketplace](https://aws.amazon.com/marketplace/), [Google Cloud Marketplace](https://console.cloud.google.com/marketplace), [Azure Marketplace](https://azuremarketplace.microsoft.com/)), you should be able to deploy Shuffle onprem with a few clicks. This is a great way to get started with Shuffle, as it's a fully managed service and test it out in your own environment without worrying about the setup. We are working with our cloud partners to get this up and running as soon as possible.
1350+
Using cloud marketplaces ([AWS Marketplace](https://aws.amazon.com/marketplace/), [Google Cloud Marketplace](https://console.cloud.google.com/marketplace), [Azure Marketplace](https://azuremarketplace.microsoft.com/)), you should be able to deploy Shuffle onprem with a few clicks. This is a great way to get started with Shuffle, as it's a fully managed service and test it out in your own environment without worrying about the setup. We are working with our cloud partners to get this up and running as soon as possible.

0 commit comments

Comments
 (0)