Workplace search¶
In a small organisation the answer is on the start page, in the wiki or in the chat. The workplace search brings all three into the search field: the wiki pages and chat messages that the person searching may see, and nothing else.
The core already searches BookStack, Outline and Wiki.js with one shared token (wiki search). The team features add the services that have per-person permissions:
| Service | Finds | Prefix |
|---|---|---|
| Confluence (Cloud and Data Center) | Pages and blog posts in the spaces you may read | w |
| SharePoint and OneDrive | Pages, list items and files you may open | w |
| Notion | Pages you shared with the integration (titles) | w |
| Slack | Messages in channels and conversations you can see | s |
| Microsoft Teams | Messages in chats and channels you belong to | t |
How it works¶
- Federated, not indexed. Waylight sends your query to the service when you search and shows the results. It stores no pages and no messages. Results are cached for a few minutes per person, never shared between people.
- Your own permissions. Each person connects their own account. The search runs with that account, so a private Slack channel or a restricted Confluence space only shows up for people who may see it in the service itself.
- Never in the way. The services are asked from two characters on, after a short pause in typing. A slow or failing service never delays the other results; it shows a hint instead, for example when a rate limit is reached.
- Off until set up. Nothing is contacted until an admin enables a service and a person connects their account (outbound requests).
Type normally to search everything, or use a prefix such as w handbook,
s vpn or t holiday to search only the wiki, Slack or Teams.
Connected accounts¶
Settings → Connected accounts lists the services an admin enabled. For each one a member can:
- connect it: the browser goes to the service, the member signs in and agrees, and comes back;
- see the state: connected, expired or revoked, with a reconnect link;
- disconnect it: Waylight revokes the token at the service where the service allows it, and deletes it.
Connections use OAuth 2.0 with PKCE. Tokens are stored encrypted with
SECRET_KEY, refreshed automatically and never leave the server. Admins see
which services are enabled, never the tokens. Removing a member deletes their
connections, and connecting and disconnecting appear in the
audit log.
The return address after signing in is your own Waylight address. It only has to be reachable from the member's browser, not from the internet.
Confluence¶
Confluence Cloud: create an OAuth 2.0 (3LO) app in the
Atlassian developer console
with the scopes search:confluence and read:confluence-content.summary,
and the callback https://<your-waylight>/api/connections/callback. Enter
the client ID and secret under Settings → Integrations → Confluence.
Confluence Data Center: no app is needed. Each member creates a personal access token in Confluence and enters it under Connected accounts.
SharePoint and OneDrive¶
Uses the Microsoft Graph search with delegated permissions only: the search sees exactly what the member may open in Microsoft 365, and Waylight never gets read access to the whole tenant.
- Use the app registration of single sign-on or
create one. Add the redirect URI
https://<your-waylight>/api/connections/callback. - Under API permissions add the delegated Microsoft Graph permissions
Sites.Read.All,Files.Read.Allandoffline_access. Sites.Read.Allneeds admin consent in most tenants: choose Grant admin consent once.- Enter the tenant ID, client ID and secret under Settings → Integrations → Microsoft 365.
Pages and files are marked differently in the results.
Notion¶
Create a public integration in Notion
with the redirect URI https://<your-waylight>/api/connections/callback and
enter its client ID and secret. When connecting, each member chooses the
pages the integration may see; the search covers exactly those.
Notion's API searches page titles, not their full text. A page that was not shared with the integration is not found; the settings explain this.
Slack¶
Slack's search for apps is only open to apps inside your own workspace, so you create an internal app once:
- On api.slack.com/apps choose Create New App → From a manifest and paste:
display_information:
name: Waylight
oauth_config:
redirect_urls:
- https://<your-waylight>/api/connections/callback
scopes:
user:
- search:read.public
- search:read.private
- search:read.im
- search:read.mpim
settings:
org_deploy_enabled: false
- Enter the client ID and secret under Settings → Integrations → Slack.
Members choose when connecting whether private channels and direct messages are searched; without those scopes, only public channels are. Results show the channel, author, an excerpt and the date, and open the message in Slack.
Microsoft Teams¶
Uses the same app registration as SharePoint. Add the delegated permissions
Chat.Read and ChannelMessage.Read.All; the latter needs admin consent in
almost every tenant, so plan for it before you announce the feature. Members
find messages from chats and channels they belong to, and results open in
Teams.