Merge branch 'master' of https://github.com/Shuffle/Shuffle-docs

Shuffle · Dec 18, 2024 · 35e4cc9 · 35e4cc9
2 parents 829c022 + 7b9c5f1
commit 35e4cc9
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 23 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -256,26 +256,19 @@ Docker Compose Installation Guide: https://docs.docker.com/compose/install/
 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):
 ```
 # Required:
-## Free since Shuffle 2.0.0-beta
-- SHUFFLE_SWARM_CONFIG=run
-
-## Ensures apps are not halting due to memory overloads      
-- SHUFFLE_LOGS_DISABLED=true
-
-## 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         
-- BASE_URL=http://YOUR-BACKEND-URL:3001
-
-## Worker image choice
-- SHUFFLE_WORKER_IMAGE=ghcr.io/shuffle/shuffle-worker:nightly
-
-## Optional configuration:
-SHUFFLE_AUTO_IMAGE_DOWNLOAD=false                       # This should be set to false IF images are already downloaded
-SHUFFLE_WORKER_SERVER_URL=http://shuffle-workers        # Internal Docker Worker URL (don't modify if not necessary)
-SHUFFLE_SWARM_NETWORK_NAME=shuffle_swarm_executions     # If you want a special network name in the executions
-SHUFFLE_SCALE_REPLICAS=1                                # The amount of worker container replicas PER NODE  (since 1.2.0)
-SHUFFLE_APP_REPLICAS=1                                  # The amount of app container replicas PER NODE     (since 1.2.1)
-SHUFFLE_MAX_SWARM_NODES=1                               # The max amount of swarm nodes shuffle can use     (since 1.3.2)
-SHUFFLE_SKIPSSL_VERIFY=true                             # Stops Shuffle's internal services from validating TLS/SSL certificates. Good to use if BASE_URL is a domain.
+- SHUFFLE_SWARM_CONFIG=run      # Enables SWARM scaling
+- SHUFFLE_LOGS_DISABLED=true    # Ensures we don't have memory issues
+- BASE_URL=http://YOUR-BACKEND-IP:3001   # replaced by the backend's public IP
+- SHUFFLE_WORKER_IMAGE=ghcr.io/shuffle/shuffle-worker:latest
+
+# Optional configuration:
+- SHUFFLE_AUTO_IMAGE_DOWNLOAD=false                       # This should be set to false IF images are already downloaded
+- SHUFFLE_WORKER_SERVER_URL=http://shuffle-workers        # Internal Docker Worker URL (don't modify if not necessary)
+- SHUFFLE_SWARM_NETWORK_NAME=shuffle_swarm_executions     # If you want a special network name in the executions
+- SHUFFLE_SCALE_REPLICAS=1                                # The amount of worker container replicas PER NODE  (since 1.2.0)
+- SHUFFLE_APP_REPLICAS=1                                  # The amount of app container replicas PER NODE     (since 1.2.1)
+- SHUFFLE_MAX_SWARM_NODES=1                               # The max amount of swarm nodes shuffle can use     (since 1.3.2)
+- SHUFFLE_SKIPSSL_VERIFY=true                             # Stops Shuffle's internal services from validating TLS/SSL certificates. Good to use if BASE_URL is a domain.
     
 ```
 
@@ -1354,4 +1347,4 @@ sudo podman-compose -f docker-compose.yml up
 
 ### Marketplace Setup
 
-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. 
+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. 
diff --git a/docs/liquid.md b/docs/liquid.md
@@ -61,15 +61,27 @@ By adding 86400 seconds to the string "now", before adding a date format, we get
 ### Create an epoch Unix timestamp 
 By using the string "now", and changing the date format to seconds, it will give you the epoch timestamp.
 
+
 **Expression:**
 ```
 {{ "now" | date: "%s" }}
 ```
 
 **Result:**
-... 
+``` 
 1643912690 
-... 
+``` 
+
+Example 2: Calculate a Time Range Using Epoch Timestamps:
+You can use epoch timestamps to calculate a time range. For instance, you can use mathematical operations like subtraction or addition to find timestamps for a specific range (e.g., 10 days).
+```
+TimeFrom={{ "now" | date: "%s" | minus: 864000 }}&TimeTo={{ "now" | date: "%s" }}
+```
+**Result:**
+If the current timestamp is 1643912690, the generated values would be:
+```
+TimeFrom=1643048690&TimeTo=1643912690
+```
 
 ### Get size of an array