{"id":18451781,"url":"https://github.com/DVDAndroid/glance-docker-container-ext","last_synced_at":"2025-04-08T02:32:45.684Z","repository":{"id":251763436,"uuid":"838326803","full_name":"DVDAndroid/glance-docker-container-ext","owner":"DVDAndroid","description":null,"archived":false,"fork":false,"pushed_at":"2024-09-09T15:58:27.000Z","size":72,"stargazers_count":16,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-06T07:38:55.659Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DVDAndroid.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-05T12:17:40.000Z","updated_at":"2024-11-05T07:43:01.000Z","dependencies_parsed_at":"2024-09-09T19:13:34.399Z","dependency_job_id":null,"html_url":"https://github.com/DVDAndroid/glance-docker-container-ext","commit_stats":null,"previous_names":["dvdandroid/glance-docker-container-ext"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DVDAndroid%2Fglance-docker-container-ext","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DVDAndroid%2Fglance-docker-container-ext/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DVDAndroid%2Fglance-docker-container-ext/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DVDAndroid%2Fglance-docker-container-ext/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DVDAndroid","download_url":"https://codeload.github.com/DVDAndroid/glance-docker-container-ext/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247764826,"owners_count":20992183,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T07:29:37.765Z","updated_at":"2025-04-08T02:32:45.447Z","avatar_url":"https://github.com/DVDAndroid.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"glance-docker-container-ext\n===\n\n![Docker Image Size](https://img.shields.io/docker/image-size/dvdandroid/glance-docker-container-ext)\n![Docker Image Version](https://img.shields.io/docker/v/dvdandroid/glance-docker-container-ext)\n\n[Glance](https://github.com/glanceapp/glance) extension that creates a widget that displays the running Docker containers.\n\n![Sample Screenshot](./assets/screen.png)\n\n## Installation\n\nAssuming you are using Docker compose, add the following to your `docker-compose.yml` file containing Glance container:\n\n```yaml\nglance-docker-container-ext:\n  image: dvdandroid/glance-docker-container-ext\n  container_name: glance-docker-container-ext\n  restart: unless-stopped\n  environment:\n    - DOCKER_HOST=unix:///var/run/docker.sock\n    - PORT=8081 # Optional, default is 8081\n  volumes:\n    - /var/run/docker.sock:/var/run/docker.sock\n```\n\nthen in your `glance.yml` config file, add the following:\n\n```yaml\n- type: extension\n  allow-potentially-dangerous-html: true\n  url: http://glance-docker-container-ext:8081\n  cache: 5m\n  parameters:\n    title: Docker Containers\n    all: true\n    order: name,status\n```\n\n### Parameters\n\n| Parameter       | Description                                                                                                              | Default             |\n|-----------------|--------------------------------------------------------------------------------------------------------------------------|---------------------|\n| `title`         | Title of the widget                                                                                                      | \"Docker Containers\" |\n| `all`           | Show all containers or only running ones                                                                                 | `true`              |\n| `order`         | Order of the containers, comma separated **string** of `name`, `status`\u003cbr\u003e(`name`,`status`,`name,status`,`status,name`) | `name`              |\n| `group`         | Identifier for the group of containers. If set, only containers with the same group will be displayed.                   |                     |\n| `same-tab`      | Open the URL in the same tab. Value customizable per container                                                           | `false`             |\n| `ignore-status` | Status of the containers will not be displayed                                                                           | `false`             |\n\n## Configuration\n\nThen, for every container you want to monitor, add the following labels to its compose file:\n\n```yaml\nlabels:\n  glance.0.enable: true\n  glance.0.name: Sonarr\n  glance.0.description: TV show search\n  glance.0.group: media\n  glance.0.url: http://sonarr.lan\n  glance.0.icon: ./assets/imgs/television-classic.svg\n```\n\n:warning: Multiple labels can be added to the same container. Read below\n\n| Label                  | Description                                                                                                | Default        |\n|------------------------|------------------------------------------------------------------------------------------------------------|----------------|\n| `glance.X.enable`      | Enable monitoring for this container                                                                       |                |\n| `glance.X.name`        | Name of the container                                                                                      | container name |\n| `glance.X.description` | Description of the container                                                                               |                |\n| `glance.X.group`       | Identifier for the group of containers, used in combination with parameter `group` in glance configuration |                |\n| `glance.X.url`         | URL to open when clicking on the container                                                                 |                |\n| `glance.X.icon`        | Icon to display, pointing to assets or Simple Icon (`si:` prefix)                                          |                |\n| `glance.X.same-tab`    | Open the URL in the same tab                                                                               | `false`        |\n\nValue of `X` must be replaced with a number starting from 0: this allows to add multiple widget referring to the same container.\n\nFor example, if you want to define two widgets for the same container, but with different labels, you can do it like this (in the compose file):\n\n```yaml\nlabels:\n  glance.0.enable: true\n  glance.0.name: Container (ADMIN)\n  glance.0.url: http://website.lan/admin\n  glance.1.enable: true\n  glance.1.group: User\n  glance.1.name: Container (USER)\n  glance.1.description: User access\n  glance.1.url: http://website.lan/user\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDVDAndroid%2Fglance-docker-container-ext","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FDVDAndroid%2Fglance-docker-container-ext","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDVDAndroid%2Fglance-docker-container-ext/lists"}