From 76c26e50b0a11ef67985db1c849667a3106a7e49 Mon Sep 17 00:00:00 2001 From: Larry Date: Sat, 5 Oct 2024 17:54:25 +0200 Subject: [PATCH] Changed config to show how to add a local URL for a service. --- docs/configs/services.md | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/docs/configs/services.md b/docs/configs/services.md index 9cb75177..2cb0896e 100644 --- a/docs/configs/services.md +++ b/docs/configs/services.md @@ -12,50 +12,56 @@ Groups are defined as top-level array entries. ```yaml - Group A: - Service A: - href: http://localhost/ + href: http://my.service.url/ + href_local: http://10.1.1.11:3000 - Group B: - Service B: - href: http://localhost/ + href: http://my.service.url/ ``` Service Groups ## Services -Services are defined as array entries on groups, +Services are defined as array entries on groups. +A service can have either a external and a local URL or both. +Homepage will check automaticly whether the local or the external URL is used, based on the URL that is used to access the page. +If only one type of URL is given, it will be used nomatter the connection type. ```yaml - Group A: - Service A: - href: http://localhost/ + href: http://my.service.url/ + href_local: http://10.1.1.11:3000 - Service B: - href: http://localhost/ + href: http://my.service.url/ - Service C: - href: http://localhost/ + href_local: http://localhost:3000 - Group B: - Service D: - href: http://localhost/ + href: http://my.service.url/ ``` Service Services ## Descriptions -Services may have descriptions, +Services may have descriptions. ```yaml - Group A: - Service A: - href: http://localhost/ + href: http://my.service.url/ + href_local: http://10.1.1.11:3000 description: This is my service - Group B: - Service B: - href: http://localhost/ + href: http://my.service.url/ description: This is another service ``` @@ -156,14 +162,14 @@ Services may be connected to a Docker container, either running on the local mac ```yaml - Group A: - Service A: - href: http://localhost/ + href: http://my.service.url/ description: This is my service server: my-server container: my-container - Group B: - Service B: - href: http://localhost/ + href: http://my.service.url/ description: This is another service server: other-server container: other-container