docs: update env var name in toml config template files

torrust · May 9, 2024 · b0c2f9f · b0c2f9f
1 parent 69d7939
commit b0c2f9f
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 12 deletions.
diff --git a/share/default/config/tracker.container.mysql.toml b/share/default/config/tracker.container.mysql.toml
@@ -30,11 +30,11 @@ ssl_cert_path = "/var/lib/torrust/tracker/tls/localhost.crt"
 ssl_enabled = false
 ssl_key_path = "/var/lib/torrust/tracker/tls/localhost.key"
 
-# Please override the admin token setting the
-#    `TORRUST_TRACKER_API_ADMIN_TOKEN`
-#                     environmental variable!
-
 [http_api.access_tokens]
+# Please override the admin token setting the environmental variable:
+# `TORRUST_TRACKER__HTTP_API__ACCESS_TOKENS__ADMIN`
+# The old variable name is deprecated:
+# `TORRUST_TRACKER_API_ADMIN_TOKEN`
 admin = "MyAccessToken"
 
 [health_check_api]

diff --git a/share/default/config/tracker.container.sqlite3.toml b/share/default/config/tracker.container.sqlite3.toml
@@ -30,11 +30,11 @@ ssl_cert_path = "/var/lib/torrust/tracker/tls/localhost.crt"
 ssl_enabled = false
 ssl_key_path = "/var/lib/torrust/tracker/tls/localhost.key"
 
-# Please override the admin token setting the
-#    `TORRUST_TRACKER_API_ADMIN_TOKEN`
-#                     environmental variable!
-
 [http_api.access_tokens]
+# Please override the admin token setting the environmental variable:
+# `TORRUST_TRACKER__HTTP_API__ACCESS_TOKENS__ADMIN`
+# The old variable name is deprecated:
+# `TORRUST_TRACKER_API_ADMIN_TOKEN`
 admin = "MyAccessToken"
 
 [health_check_api]

diff --git a/share/default/config/tracker.development.sqlite3.toml b/share/default/config/tracker.development.sqlite3.toml
@@ -31,6 +31,10 @@ ssl_enabled = false
 ssl_key_path = ""
 
 [http_api.access_tokens]
+# Please override the admin token setting the environmental variable:
+# `TORRUST_TRACKER__HTTP_API__ACCESS_TOKENS__ADMIN`
+# The old variable name is deprecated:
+# `TORRUST_TRACKER_API_ADMIN_TOKEN`
 admin = "MyAccessToken"
 
 [health_check_api]

diff --git a/share/default/config/tracker.e2e.container.sqlite3.toml b/share/default/config/tracker.e2e.container.sqlite3.toml
@@ -30,11 +30,11 @@ ssl_cert_path = "/var/lib/torrust/tracker/tls/localhost.crt"
 ssl_enabled = false
 ssl_key_path = "/var/lib/torrust/tracker/tls/localhost.key"
 
-# Please override the admin token setting the
-#    `TORRUST_TRACKER_API_ADMIN_TOKEN`
-#                     environmental variable!
-
 [http_api.access_tokens]
+# Please override the admin token setting the environmental variable:
+# `TORRUST_TRACKER__HTTP_API__ACCESS_TOKENS__ADMIN`
+# The old variable name is deprecated:
+# `TORRUST_TRACKER_API_ADMIN_TOKEN`
 admin = "MyAccessToken"
 
 [health_check_api]

diff --git a/share/default/config/tracker.udp.benchmarking.toml b/share/default/config/tracker.udp.benchmarking.toml
@@ -31,6 +31,10 @@ ssl_enabled = false
 ssl_key_path = ""
 
 [http_api.access_tokens]
+# Please override the admin token setting the environmental variable:
+# `TORRUST_TRACKER__HTTP_API__ACCESS_TOKENS__ADMIN`
+# The old variable name is deprecated:
+# `TORRUST_TRACKER_API_ADMIN_TOKEN`
 admin = "MyAccessToken"
 
 [health_check_api]