aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFuwn <[email protected]>2021-05-15 16:35:40 +0000
committerFuwn <[email protected]>2021-05-15 16:35:40 +0000
commita0fc24024b8edd5a220ecf22e9fd4635150ab312 (patch)
tree55a13ffcef6d1f41b53e1d1ca69789186602f5fa
parentrefactor: rename (diff)
downloadwhirl-a0fc24024b8edd5a220ecf22e9fd4635150ab312.tar.xz
whirl-a0fc24024b8edd5a220ecf22e9fd4635150ab312.zip
refactor(config): new documentation information
Remove comments, add URL to Whirlsplash documentation regarding configuration options.
-rw-r--r--Whirl.example.toml10
-rw-r--r--src/config/Whirl.default.toml10
2 files changed, 12 insertions, 8 deletions
diff --git a/Whirl.example.toml b/Whirl.example.toml
index 6dcc7d8..0edb0b2 100644
--- a/Whirl.example.toml
+++ b/Whirl.example.toml
@@ -1,6 +1,8 @@
+# See more keys and their definitions at https://whirlsplash.org/docs/whirl/configuration
+
[whirlsplash]
-worldsmaster_username = "WORLDSMASTER" # DO NOT CHANGE UNLESS YOU KNOW WHAT YOU ARE DOING
-ip = "0.0.0.0" # DO NOT CHANGE UNLESS YOU KNOW WHAT YOU ARE DOING
+worldsmaster_username = "WORLDSMASTER"
+ip = "0.0.0.0"
api.port = 8080
[whirlsplash.prompt]
@@ -15,7 +17,7 @@ test = false
[distributor]
worldsmaster_greeting = "Welcome to Whirlsplash!"
-port = 6650 # DO NOT CHANGE UNLESS YOU KNOW WHAT YOU ARE DOING
+port = 6650
[hub]
-port = 5673 # DO NOT CHANGE UNLESS YOU KNOW WHAT YOU ARE DOING
+port = 5673
diff --git a/src/config/Whirl.default.toml b/src/config/Whirl.default.toml
index 6dcc7d8..0edb0b2 100644
--- a/src/config/Whirl.default.toml
+++ b/src/config/Whirl.default.toml
@@ -1,6 +1,8 @@
+# See more keys and their definitions at https://whirlsplash.org/docs/whirl/configuration
+
[whirlsplash]
-worldsmaster_username = "WORLDSMASTER" # DO NOT CHANGE UNLESS YOU KNOW WHAT YOU ARE DOING
-ip = "0.0.0.0" # DO NOT CHANGE UNLESS YOU KNOW WHAT YOU ARE DOING
+worldsmaster_username = "WORLDSMASTER"
+ip = "0.0.0.0"
api.port = 8080
[whirlsplash.prompt]
@@ -15,7 +17,7 @@ test = false
[distributor]
worldsmaster_greeting = "Welcome to Whirlsplash!"
-port = 6650 # DO NOT CHANGE UNLESS YOU KNOW WHAT YOU ARE DOING
+port = 6650
[hub]
-port = 5673 # DO NOT CHANGE UNLESS YOU KNOW WHAT YOU ARE DOING
+port = 5673