Waylight for teams¶
Waylight started as a start page for one person and their household. With the team features it becomes the shared start page of a small organisation such as an office, a practice, an agency or a club: every person has their own dashboard, admins maintain tabs and links for everyone, and the answers from the wiki and the chat are one search away.
What the team features add¶
| Area | What you get | Details |
|---|---|---|
| Accounts | Admins, members and guests, groups, invitation links, password reset without shell access | Members and groups |
| Shared content | Team tabs per group, link collections per group, shared notes and to-dos | Team tabs and links |
| Team widgets | Announcements, absences and team calendar, presence, phone list | Team widgets |
| Sign-in | Single sign-on for every account, with groups and the admin role taken from the identity provider | Single sign-on |
| Workplace search | Confluence, SharePoint and OneDrive, Notion, Slack and Microsoft Teams messages in the search field, with the permissions of the person searching | Workplace search |
| Chat | A Slack slash command, Waylight as a tab in Microsoft Teams, announcements posted to a channel | Slack and Microsoft Teams |
| Administration | Policies, audit log with export, own name, logo and colours | Administration |
Everything a single person or a household needs stays in the free core under the MIT licence. That includes the wiki search for BookStack, Outline and Wiki.js with one shared token, and Slack and Microsoft Teams as notification channels.
Licence key¶
The team features live in the ee/ directory of the repository under the
Elastic License 2.0 (ADR 0020). They
are not open source and never become MIT, and using them needs a licence key.
A licence key is a small signed text. It names the licensee, the number of seats, the enabled features and the date until which it is valid. Enter it under Settings → Licence, or set it as an environment variable:
LICENSE_KEY=wl1.eyJsaWNlbnNlZSI6... # the key itself
LICENSE_KEY_FILE=/run/secrets/waylight-licence # or a file that holds it
The key is checked on your server with a public key that is built into Waylight. No request leaves your instance for the check, not at start and not later, so "no outbound request you did not configure" holds for licensed instances too.
| State | What happens |
|---|---|
| Valid key | The licensed features appear in the settings and for the members. Admins see the licensee, seats in use and the expiry date. |
| Key expires in 30 days or less | Admins see a notice in the settings. Nothing else changes. |
| Expired key | All data stays readable. Team tabs, announcements and shared content can no longer be changed, and branding is no longer applied. A new key restores everything; nothing is deleted. |
| No key or a tampered key | The team features stay hidden and their API answers 403. The core works as before. |
A seat is one active member or admin account. Guests and kiosk displays do not count.
Switching an instance to team mode¶
An existing instance keeps all its data when you add a licence key:
- Enter the licence key. The owner becomes the first admin. Existing guests stay guests, kiosk links and API tokens keep working.
- Create groups under Settings → Members → Groups, for example Reception, Accounting and Everyone.
- Invite people with an invitation link or let them sign in through single sign-on. Each member gets their own dashboard, tabs and data.
- Build team tabs for the groups: the tools of the office, the announcements, the team calendar. Members see them next to their own tabs.
The rules for who owns which record are described in ADR 0018.