orbit/orbit-client-docs
orbit/orbit-client-docs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Orbit documentation: docs, wiki and FAQ pages

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

51
faq.md Normal file
View file

@ -0,0 +1,51 @@
## Is Orbit free?
Yes — it's **free software under AGPL-3.0**. You can use,
modify, and self-host it. If you run a **modified** version as a network service, you must publish
your source.
## Do I need to create an account?
No. Pick a nick and start chatting. Accounts (SASL / registration) are optional and only needed to
reserve a nick, host images, or get push notifications while closed.
## What servers does it work with?
Any **IRCv3** server with a WebSocket listener — InspIRCd, Ergo, and others. The more capabilities
the server supports, the more features light up. See [IRCv3 capabilities](/docs/ircv3/).
## Can I use it for my own network?
Absolutely — that's the point. Re-point it at your server and rebrand it entirely from one
[`config.json`](/docs/config/), no rebuild. See [Branding & themes](/docs/branding/).
## Does it work on mobile?
Yes. Orbit is an installable **PWA** with a mobile-first layout, offline shell, and push
notifications.
## Are my passwords safe?
Orbit connects over TLS, and it **masks** services passwords in the message log. If you accidentally
type `IDENTIFY nick pass` without a leading slash, it intercepts it, sends it privately, and warns
you — it's never broadcast to the channel.
## How do notifications work?
In-tab alerts and sounds work everywhere. **Push** notifications while the tab is closed use the
`draft/webpush` capability (VAPID) and require being logged into an account.
## Can I self-host it?
Yes — it's a static build behind any web server. The project even runs its own git server with
[push-to-deploy](/docs/push-to-deploy/). Start with the [Quick start](/docs/quick-start/).
## How do I report a bug or contribute?
Issues and code live on [Codeberg](https://codeberg.org/reversefr/orbit). You can also clone it
straight from `https://orbit.tchatou.fr/orbit.git`.
## Why IRC in 2026?
Because it's **open, federated, and yours** — no platform lock-in, no ads, no data harvesting. Orbit
gives that protocol a modern, friendly face.