Settings reference
The admin has four sections down the left. This page follows them in order, using the same group headings you see on screen, so you can find a setting here by remembering where it sits in the app.
Open the admin from the Settings icon on the dashboard.
General
Section titled “General”Everything about the server itself.
At the top, before any group:
| Setting | What it does |
|---|---|
| Title | The name of this Stackyard instance. |
| Description | Free text shown alongside the title. |
| Host IP | Your server’s own address. Setting it lets badges and widgets reach services on that IP, which the SSRF guard would otherwise block. See Security. |
Monitoring
Section titled “Monitoring”| Setting | What it does |
|---|---|
| Logging Level | How much detail goes to the container log. Errors shows warnings and errors. Security events are always logged. See Support. |
| Docker Container Health Checks | Turns on container status for apps. Needs a socket proxy address below. See Badges. |
| Hide Healthy Badge | Shows the health dot only when something is wrong. |
| Socket URL | Where your Docker socket proxy is. Never the Docker socket itself. See Advanced configuration. |
If every app suddenly shows as unhealthy, the socket proxy address is the usual cause. See Troubleshooting.
Security
Section titled “Security”| Setting | What it does |
|---|---|
| Password Protection | Sets or changes the dashboard password. Minimum 8 characters. Leave blank to keep the existing one. |
| Sign out all devices | Ends every session everywhere, including the one you are using. Use it if you think a session may be compromised. |
Locked out? See password recovery.
Backup
Section titled “Backup”| Setting | What it does |
|---|---|
| Import / Export | Downloads your whole config as one file, or restores it. See Backup and restore. |
| Import from another dashboard | Reads gethomepage and Dashy files. Apps and folders are added. See Migrating. |
Appearance
Section titled “Appearance”How the dashboard looks. Every change applies immediately. Explained in full on Customization.
App Title
Section titled “App Title”| Setting | What it does |
|---|---|
| App Title | The title drawn on the dashboard itself. |
| Show On Desktop | Whether that title appears on a large screen. |
| Show On Mobile | Whether it appears on a phone. |
Display
Section titled “Display”| Setting | What it does |
|---|---|
| Keep Screen Awake | Stops the screen dimming while the dashboard is open. Browsers only allow this over HTTPS. |
| Settings Display Mode | Light, dark or system, for these settings pages only. Stored in this browser, so it does not follow you to another device. |
Wallpaper
Section titled “Wallpaper”| Setting | What it does |
|---|---|
| Source | Unsplash, an image, or a solid colour. |
| API Key | Unsplash only. See Getting an Unsplash key. |
| Collection ID | Unsplash only. Leave blank for a random photo. See Finding a Collection ID. |
| Image | Upload a file, or link one by URL. Both are stored on your own server. |
| Fit | Fill crops to cover the screen. Fit shows the whole image. |
| Color | A solid background colour, as #rrggbb or a CSS colour name. |
| Brightness | Dims the wallpaper so tiles and labels stay readable. |
Choosing Image or Solid color means Unsplash is never contacted.
Dashboard
Section titled “Dashboard”The contents of your dashboard, and the only place you add things.
Search narrows the list. The All, Apps, Widgets and Folders filters limit it by kind. Drag the handle on a row to reorder.
| To do this | See |
|---|---|
| Add an app, a folder, or another dashboard page | Adding services |
| Put a live value or a health dot on an app | Badges |
| Add a widget and fill in its fields | Widgets |
Version, an update notice when one is available, and links to the documentation, the source, issue reporting and support.
Check the version here before filing a bug. See Support.