diff --git a/docs/configs/docker.md b/docs/configs/docker.md index 2eaf2683..3e665248 100644 --- a/docs/configs/docker.md +++ b/docs/configs/docker.md @@ -170,6 +170,26 @@ labels: - homepage.widget.field[1].field.status=latest_version ``` +## Automatic Bookmark Discovery + +Homepage can load bookmarks from docker labels attached to any container using the proper configuration. Note that the bookmarks +do not have to be related to the service, in fact you could use these labels on the homepage container itself. + +```yaml +services: + service: + ... + labels: + - homepage.bookmarks.gh.group=Developer Tools + - homepage.bookmarks.gh.name=Github + - homepage.bookmarks.gh.icon=github-light + - homepage.bookmarks.gh.href=https://github.com/ + - homepage.bookmarks.wnyc.group=News + - homepage.bookmarks.wnyc.name=WNYC + - homepage.bookmarks.wnyc.abbr=NY + - homepage.bookmarks.wnyc.href=https://wnyc.org +``` + ## Docker Swarm Docker swarm is supported and Docker services are specified with the same `server` and `container` notation. To enable swarm support you will need to include a `swarm` setting in your docker.yaml, e.g. diff --git a/kubernetes.md b/kubernetes.md index 326d6e84..fbf58b73 100644 --- a/kubernetes.md +++ b/kubernetes.md @@ -121,6 +121,22 @@ one application to see a high-level aggregate: ) ``` +## Bookmark Discovery + +Sample yaml: + +```yaml +kind: Ingress +metadata: + name: homepage + annotations: + gethomepage.dev/enabled: "true" + gethomepage.dev/bookmarks.gh.group: Developer Tools + gethomepage.dev/bookmarks.gh.name: Github + gethomepage.dev/bookmarks.gh.icon: gh-light + gethomepage.dev/bookmarks.gh.href: https://github.com +``` + ## Longhorn Widget There is a widget for showing storage stats from [Longhorn](https://longhorn.io).