Orbit documentation: docs, wiki and FAQ pages

This commit is contained in:
reverse 2026-06-20 06:34:12 +00:00
commit bcbe5fff22
No known key found for this signature in database
18 changed files with 714 additions and 0 deletions

27
wiki/troubleshooting.md Normal file
View file

@ -0,0 +1,27 @@
# Troubleshooting
## "Connexion fermée" / the socket closes immediately
The IRC server is rejecting the **Origin**. Add the host Orbit is served from to the server's
WebSocket origin allow-list (e.g. InspIRCd `<wsorigin allow="https://chat.example.org">`).
## I don't see the latest version after a deploy
A service worker is serving the cached build. **Bump the cache version** in `public/sw.js` on every
deploy (`const CACHE = 'app-vN'`) — the worker then auto-reloads installed clients. Or hard-refresh.
## Notifications don't work
- The browser must grant permission (Settings → Notifications).
- Web Push when the tab is closed needs the server's `draft/webpush` support (VAPID) **and** you to
be logged into an account (subscriptions are stored per account).
## The keyboard covers the input on mobile
Orbit tracks the visual viewport to keep the composer above the keyboard. This works best on
Chromium-based browsers; some other mobile browsers report the viewport late.
## Channels start empty
Server-side history needs `draft/chathistory` + a storage backend on the server, and the channel
must have history enabled (e.g. InspIRCd `+H`). Without it, channels begin empty.