Import from Homepage or Dashy

In the admin: General, then Backup. See the Settings reference.

Stackyard reads gethomepage and Dashy configuration files, so you do not have to retype every link. Find it under General, Import from another dashboard.

From Docker labels

Import from Docker labels reads gethomepage labels from every container, stopped ones included. It reads them through the Docker Socket URL under Health Checks, so turn Health Checks on and set that address first. The proxy needs read access to containers, such as CONTAINERS=1 on docker-socket-proxy.

A container needs both homepage.name and homepage.group. The group becomes a folder. Apps in a folder are ordered by homepage.weight, then by name. Folders are ordered by name.

Each app gets a health check on its own container. Stackyard reads homepage.href, homepage.icon and homepage.siteMonitor. Widget labels are not imported, and their API keys never leave the server.

Labels scoped to one instance, such as homepage.instance.internal.href, are not read. A container named only through instance labels is listed as not imported.

What comes across

Links and folders. An app in the source becomes an app tile, and a group or section becomes a folder.

A link written as a host and port, such as plex.lan:32400, is imported with http:// in front.

Icons come across when they are a dashboard-icons name or an icon link on cdn.jsdelivr.net.

A name longer than 64 characters is shortened. A username and password in a link or a health-check address are removed.

A Homepage siteMonitor or a Dashy status check becomes the app’s health check. A Dashy check that allows insecure certificates is imported with certificate checking on, unless you tick Allow self-signed certificate in the import preview.

Note

This is one way. It does not keep the two in sync, and it writes nothing back.

What does not

A widget in the source becomes a plain app tile, never a Stackyard widget. The two projects model widgets differently, so there is nothing to translate.

Descriptions, abbreviations, tags, and per-item colours are dropped. Icon fonts, emoji, other icon links and paths into the other dashboard’s files are dropped too. See Apps and folders.

A health-check address that is only a path, or that the other dashboard resolves from its own environment, is dropped. The app imports without that check.

What is skipped

An entry is skipped when it has no label, has no link, or its link is not safe to follow. Relative links are skipped, because they have no meaning outside the dashboard that wrote them, as are values the other dashboard resolves from its own environment.

A file with more than 5,000 entries is refused, and nothing is imported. The same limit applies to containers. So is a file whose YAML merge keys (<<) expand too far.

Stackyard reports how many apps and folders were imported, and lists what it could not import and why.

After importing

Set up badges and widgets in Stackyard. See Badges and Widgets.