mirror of
https://github.com/gethomepage/homepage.git
synced 2025-07-09 03:04:18 -04:00
Created Services (markdown)
parent
24728f6831
commit
c90f7c1996
138
Services.md
Normal file
138
Services.md
Normal file
@ -0,0 +1,138 @@
|
|||||||
|
# Overview
|
||||||
|
|
||||||
|
Services are configured inside the `services.yaml` file. You can have any number of groups, and any number of services per group.
|
||||||
|
|
||||||
|
## Groups
|
||||||
|
|
||||||
|
Groups are defined as the top-level array entries.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- Group A:
|
||||||
|
- Service A:
|
||||||
|
href: http://localhost/
|
||||||
|
|
||||||
|
- Group B:
|
||||||
|
- Service B:
|
||||||
|
href: http://localhost/
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
<img width="1038" alt="Service Groups" src="https://user-images.githubusercontent.com/82196/187040754-28065242-4534-4409-881c-93d1921c6141.png">
|
||||||
|
|
||||||
|
|
||||||
|
## Services
|
||||||
|
|
||||||
|
Services are defined as array entires on groups,
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- Group A:
|
||||||
|
- Service A:
|
||||||
|
href: http://localhost/
|
||||||
|
|
||||||
|
- Service B:
|
||||||
|
href: http://localhost/
|
||||||
|
|
||||||
|
- Service C:
|
||||||
|
href: http://localhost/
|
||||||
|
|
||||||
|
- Group B:
|
||||||
|
- Service D:
|
||||||
|
href: http://localhost/
|
||||||
|
```
|
||||||
|
|
||||||
|
<img width="1038" alt="Service Services" src="https://user-images.githubusercontent.com/82196/187040763-038023a2-8bee-4d87-b5cc-13447e7365a4.png">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Descriptions
|
||||||
|
|
||||||
|
Services may have descriptions,
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- Group A:
|
||||||
|
- Service A:
|
||||||
|
href: http://localhost/
|
||||||
|
description: This is my service
|
||||||
|
|
||||||
|
- Group B:
|
||||||
|
- Service B:
|
||||||
|
href: http://localhost/
|
||||||
|
description: This is another service
|
||||||
|
```
|
||||||
|
|
||||||
|
<img width="1038" alt="Service Descriptions" src="https://user-images.githubusercontent.com/82196/187040817-11a3d0eb-c997-4ef9-8f06-2d03a11332b6.png">
|
||||||
|
|
||||||
|
|
||||||
|
## Icons
|
||||||
|
|
||||||
|
Services may have an icon attached to them, you can use icons from [Dashboard Icons](https://github.com/walkxcode/dashboard-icons) automatically, by passing the name of the icon, with, or without `.png`. You may also pass a remote URL to an icon. Support for custom locally served icons is coming soon.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- Group A:
|
||||||
|
- Sonarr:
|
||||||
|
icon: sonarr.png
|
||||||
|
href: http://sonarr.host/
|
||||||
|
description: Series management
|
||||||
|
|
||||||
|
- Group B:
|
||||||
|
- Radarr:
|
||||||
|
icon: radarr.png
|
||||||
|
href: http://radarr.host/
|
||||||
|
description: Movie management
|
||||||
|
```
|
||||||
|
|
||||||
|
<img width="1038" alt="Service Icons" src="https://user-images.githubusercontent.com/82196/187040777-da1361d7-f0c4-4531-95db-136cd00a1611.png">
|
||||||
|
|
||||||
|
|
||||||
|
## Server & Container
|
||||||
|
|
||||||
|
Services may be connected to a Docker container, either running on the local machine, or a remote machine.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- Group A:
|
||||||
|
- Service A:
|
||||||
|
href: http://localhost/
|
||||||
|
description: This is my service
|
||||||
|
server: my-server
|
||||||
|
container: my-container
|
||||||
|
|
||||||
|
- Group B:
|
||||||
|
- Service B:
|
||||||
|
href: http://localhost/
|
||||||
|
description: This is another service
|
||||||
|
server: other-server
|
||||||
|
container: other-container
|
||||||
|
```
|
||||||
|
|
||||||
|
<img width="1038" alt="Service Containers" src="https://user-images.githubusercontent.com/82196/187040793-cc4c7e3d-8fea-4161-b5e9-ac38a2dc67db.png">
|
||||||
|
|
||||||
|
|
||||||
|
## Widgets / Integrations
|
||||||
|
|
||||||
|
Services may also have a service widget attached to them, this works independently of the Docker integration.
|
||||||
|
|
||||||
|
Here is an example of a Radarr & Sonarr service, with their respective integrations.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- Group A:
|
||||||
|
- Sonarr:
|
||||||
|
icon: sonarr.png
|
||||||
|
href: http://sonarr.host/
|
||||||
|
description: Series management
|
||||||
|
widget:
|
||||||
|
type: sonarr
|
||||||
|
url: http://sonarr.host
|
||||||
|
key: apikeyapikeyapikeyapikeyapikey
|
||||||
|
|
||||||
|
- Group B:
|
||||||
|
- Radarr:
|
||||||
|
icon: radarr.png
|
||||||
|
href: http://radarr.host/
|
||||||
|
description: Movie management
|
||||||
|
widget:
|
||||||
|
type: radarr
|
||||||
|
url: http://radarr.host
|
||||||
|
key: apikeyapikeyapikeyapikeyapikey
|
||||||
|
```
|
||||||
|
|
||||||
|
<img width="1038" alt="Service Integrations" src="https://user-images.githubusercontent.com/82196/187040838-6cd518c2-4f08-41ef-8aa6-364df5e2660e.png">
|
Loading…
x
Reference in New Issue
Block a user