OpenSource/homepage
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Changed config to show how to add a local URL for a service.

Browse Source
This commit is contained in:
Larry 2024-10-05 17:54:25 +02:00
parent 96c0ea66b4
commit 76c26e50b0
1 changed files with 18 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/configs/services.md
View File

@ -12,50 +12,56 @@ Groups are defined as top-level array entries.
```yaml ```yaml
- Group A: - Group A:
- Service A: - Service A:
href: http://localhost/ href: http://my.service.url/
href_local: http://10.1.1.11:3000
- Group B: - Group B:
- Service B: - Service B:
href: http://localhost/ href: http://my.service.url/
``` ```
<img width="1038" alt="Service Groups" src="https://user-images.githubusercontent.com/82196/187040754-28065242-4534-4409-881c-93d1921c6141.png"> <img width="1038" alt="Service Groups" src="https://user-images.githubusercontent.com/82196/187040754-28065242-4534-4409-881c-93d1921c6141.png">
## Services ## 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 ```yaml
- Group A: - Group A:
- Service A: - Service A:
href: http://localhost/ href: http://my.service.url/
href_local: http://10.1.1.11:3000
- Service B: - Service B:
href: http://localhost/ href: http://my.service.url/
- Service C: - Service C:
href: http://localhost/ href_local: http://localhost:3000
- Group B: - Group B:
- Service D: - Service D:
href: http://localhost/ href: http://my.service.url/
``` ```
<img width="1038" alt="Service Services" src="https://user-images.githubusercontent.com/82196/187040763-038023a2-8bee-4d87-b5cc-13447e7365a4.png"> <img width="1038" alt="Service Services" src="https://user-images.githubusercontent.com/82196/187040763-038023a2-8bee-4d87-b5cc-13447e7365a4.png">
## Descriptions ## Descriptions
Services may have descriptions, Services may have descriptions.
```yaml ```yaml
- Group A: - Group A:
- Service A: - Service A:
href: http://localhost/ href: http://my.service.url/
href_local: http://10.1.1.11:3000
description: This is my service description: This is my service
- Group B: - Group B:
- Service B: - Service B:
href: http://localhost/ href: http://my.service.url/
description: This is another service description: This is another service
``` ```
@ -156,14 +162,14 @@ Services may be connected to a Docker container, either running on the local mac
```yaml ```yaml
- Group A: - Group A:
- Service A: - Service A:
href: http://localhost/ href: http://my.service.url/
description: This is my service description: This is my service
server: my-server server: my-server
container: my-container container: my-container
- Group B: - Group B:
- Service B: - Service B:
href: http://localhost/ href: http://my.service.url/
description: This is another service description: This is another service
server: other-server server: other-server
container: other-container container: other-container