Add Documentation

This commit is contained in:
MikeC 2025-03-17 07:09:31 -04:00
parent 075bdfdc23
commit 51e70347e4

View File

@ -1701,8 +1701,11 @@ Display the status of your Docker containers along with an icon and an optional
```yaml ```yaml
- type: docker-containers - type: docker-containers
hide-by-default: false hide-by-default: false
readable-names: false
``` ```
The `readable-names` will try to auto format your container names by capitalizing the first letter and converting `-` and `_` characters to spaces.
> [!NOTE] > [!NOTE]
> >
> The widget requires access to `docker.sock`. If you're running Glance inside a container, this can be done by mounting the socket as a volume: > The widget requires access to `docker.sock`. If you're running Glance inside a container, this can be done by mounting the socket as a volume:
@ -1727,6 +1730,21 @@ Configuration of the containers is done via labels applied to each container:
glance.description: Movies & shows glance.description: Movies & shows
``` ```
Configuration of the containers can also be overridden using `glance.yml`. Containers are specified by their container names, these will take preference over any docker labels that are set:
```yaml
- type: docker-containers
hide-by-default: false
readable-names: false
containers: # Alternative to using docker labels
container_name_1: # This is the actual container name
title: "Test Container Name"
description: "test-description"
url: "127.0.0.1:3011/test"
icon: "si:jellyfin"
hide: false
```
For services with multiple containers you can specify a `glance.id` on the "main" container and `glance.parent` on each "child" container: For services with multiple containers you can specify a `glance.id` on the "main" container and `glance.parent` on each "child" container:
<details> <details>