diff --git a/Services.md b/Services.md new file mode 100644 index 0000000..98b23e8 --- /dev/null +++ b/Services.md @@ -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/ + +``` + +Service Groups + + +## 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/ +``` + +Service Services + + + +## 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 +``` + +Service Descriptions + + +## 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 +``` + +Service Icons + + +## 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 +``` + +Service Containers + + +## 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 +``` + +Service Integrations