Frequently asked questions¶
Can I reach my dashboard from outside my home?¶
Yes, but not by forwarding a port on your router. Connect to your home
network through a VPN such as WireGuard, and Waylight behaves as if you
were at home. If you want a public https:// address anyway, put it behind
a reverse proxy, keep two-factor authentication on and
consider single sign-on in front
of it.
Does it work without an internet connection?¶
Mostly. Notes, to-dos, bookmarks, countdowns, habits, the focus timer and everything about your server work in the LAN alone. Widgets that depend on outside services, such as the weather, departures or parcel tracking, show their last data until the connection is back. Phones with the installed app keep showing the last data even when they cannot reach the server.
Can my family use it too?¶
They can look at the tabs you share with them through guest accounts, each with their own password, and a wall tablet can show tabs as a kiosk display. Only the owner can change things. If everyone needs their own editable dashboard, Waylight is not the right tool today; see the comparison.
Is a Raspberry Pi fast enough?¶
Yes. Waylight needs around 75 MB of memory and very little CPU. A Raspberry Pi 3B runs it; a Pi 4 or 5 leaves plenty of room for other services. The ready-made image is the easiest way to set one up.
Where is my data stored?¶
In one SQLite file: /data/waylight.db in the Docker volume, or
/var/lib/waylight/waylight.db with the package and the Pi image.
Daily backups sit next to it. Nothing is stored anywhere
else, and nothing is sent to the project.
I use Homepage. Can I keep my Docker labels?¶
Yes. Service tiles can be created from Docker labels, and the homepage.*
labels are understood as well. See
Docker autodiscovery. Homepage's
service widgets do not carry over; check the feature overview
for the Waylight equivalents.
Can I configure it with a file instead of the web interface?¶
Yes. Appearance, search, services, bookmarks and the dashboard can be
exported as a readable waylight.yaml, kept in Git and imported again, or
applied at every start with CONFIG_FILE
(settings as a YAML file). Settings that change what
the server may do stay environment variables (configuration).
Which service I use is missing. What now?¶
If the service has a JSON API, the JSON widget can probably show what you need. Otherwise open a feature request in the issue tracker, or write a module yourself with the developer guide; a simple one takes about 30 minutes.
Who is behind the project?¶
Waylight is maintained by one person in their spare time and published
under the MIT licence. The team features live in a separate directory, ee/,
under the Elastic License 2.0: they are not open source, using them needs a
licence key, and the code never becomes MIT
(ADR 0020). Everything a single person
or a household needs stays MIT.
Planned work is on the
roadmap.