46 lines
1 KiB
Markdown
46 lines
1 KiB
Markdown
# Quick start
|
|
|
|
Run your own Orbit in about a minute.
|
|
|
|
## 1. Clone & install
|
|
|
|
```sh
|
|
git clone https://codeberg.org/reversefr/orbit.git
|
|
cd orbit
|
|
npm install
|
|
```
|
|
|
|
## 2. Point it at your server
|
|
|
|
Edit **`public/config.json`** — at minimum set the WebSocket URL of your IRCv3 server:
|
|
|
|
```json
|
|
{
|
|
"server": { "url": "wss://irc.example.org/ws/" },
|
|
"startup": { "channels": ["#lobby"] }
|
|
}
|
|
```
|
|
|
|
Your IRC server needs a **WebSocket listener** speaking the `text.ircv3.net` / `binary.ircv3.net`
|
|
sub-protocols (InspIRCd, Ergo, etc.), and its Origin allow-list must include where you serve Orbit.
|
|
|
|
## 3. Develop
|
|
|
|
```sh
|
|
npm run dev # http://localhost:5173
|
|
```
|
|
|
|
## 4. Build & serve
|
|
|
|
```sh
|
|
npm run build # → dist/
|
|
```
|
|
|
|
Serve the static `dist/` behind any web server (commonly under `/app/`). See
|
|
[Build & deploy](/docs/deploy/) for nginx and service-worker details.
|
|
|
|
## Next steps
|
|
|
|
- [config.json reference](/docs/config/) — every option.
|
|
- [Branding & themes](/docs/branding/) — make it yours.
|
|
- [IRCv3 capabilities](/docs/ircv3/) — what works on your server.
|