Skip to content

Commit 6a9c1b3

Browse files
authored
Added more info about the .env file
1 parent 612d973 commit 6a9c1b3

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

docs/configuration.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,22 @@ Shuffle is by default configured to be easy to start using. This means we have h
8080
![image](https://github.com/user-attachments/assets/1bf288e0-fbd7-47c1-aba2-5269acaa4f8d)
8181

8282
**Here are the things we'll dive into**
83-
- [Hybrid Cloud Configuration](#hybrid-cloud-configuration)
83+
- [Environment Variables](#environment_variables)
8484
- [High Availability](#high-availability)
8585

86+
### Environment Variables
87+
With Shuffle being a very technical system, it is important to understand that you have a lot of control mechanisms available to you in your local installation.
88+
89+
[Check the .env file on your server](https://github.com/Shuffle/Shuffle/blob/main/.env) to see what the default values are. They are broadly split into the following:
90+
91+
- Setup Configuration (default usernames & download locations for easy deployments)
92+
- Network Configuration (e.g. how does the frontend route to the correct backend, or Orborus->Frontend->Backend through Nginx)
93+
- Container Control (Registries, Docker & K8s-specific configs etc.)
94+
- Health and Stability (Enable/Disable health checks, Log forwarding, automatic Reruns and Aborts etc.)
95+
- Opensearch Configuration (Networking, password & security systems etc)
96+
97+
**PS:** Most of our environment variables start with `SHUFFLE_`
98+
8699
### Servers
87100
When setting up Shuffle for production, we always recommend two or more servers (VMs), but it works fine with one to start. These are MINIMUM requirements, and we recommend adding more to avoid congestion.
88101

0 commit comments

Comments
 (0)