Skip to content

Commit 51e7034

Browse files
committed
Add Documentation
1 parent 075bdfd commit 51e7034

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/configuration.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1701,8 +1701,11 @@ Display the status of your Docker containers along with an icon and an optional
17011701
```yaml
17021702
- type: docker-containers
17031703
hide-by-default: false
1704+
readable-names: false
17041705
```
17051706

1707+
The `readable-names` will try to auto format your container names by capitalizing the first letter and converting `-` and `_` characters to spaces.
1708+
17061709
> [!NOTE]
17071710
>
17081711
> 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:
17271730
glance.description: Movies & shows
17281731
```
17291732

1733+
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:
1734+
1735+
```yaml
1736+
- type: docker-containers
1737+
hide-by-default: false
1738+
readable-names: false
1739+
containers: # Alternative to using docker labels
1740+
container_name_1: # This is the actual container name
1741+
title: "Test Container Name"
1742+
description: "test-description"
1743+
url: "127.0.0.1:3011/test"
1744+
icon: "si:jellyfin"
1745+
hide: false
1746+
```
1747+
17301748
For services with multiple containers you can specify a `glance.id` on the "main" container and `glance.parent` on each "child" container:
17311749

17321750
<details>

0 commit comments

Comments
 (0)