BirdX Docs

Help center

Step-by-step guides for BirdX — web app, calls, native apps, and self-hosted server install (online or offline).

Open web app Self-host install

Getting started

BirdX runs in your browser at app.birdx.chat. No install is required for the full experience; Windows and Android apps are optional shortcuts to the same app.

  1. 1

    Open the web app

    Visit app.birdx.chat in Chrome, Firefox, Safari, or Edge. Allow notifications if you want desktop alerts.

  2. 2

    Create your account

    Choose a unique username and a strong password. Add a display name and profile photo if you like. Enable two-factor authentication under Settings → Security before you join sensitive groups.

  3. 3

    Start or join a conversation

    Open a direct message from the member list, create a group with the + button, or paste a channel invite link shared by your team.

  4. 4

    Install as PWA (optional)

    In Chrome or Edge, use “Install app” from the menu to pin BirdX to your taskbar or home screen for faster access.

Messaging

Organize work and community discussions in one place.

Direct messages

Private one-to-one chats. When E2EE is enabled, messages are encrypted on your device with X3DH and AES-256-GCM before they are sent.

Groups

Invite members, assign roles (owner, admin, moderator, member), pin important messages, and manage join permissions.

Channels

Broadcast updates to many subscribers. Ideal for announcements where not everyone needs to reply in thread.

Files & media

Send images, videos, and documents in-line. Drag files into the composer or use the attachment button.

Polls & stickers

Create polls for quick team decisions. Use emoji stickers to react without cluttering the timeline.

Search & mentions

Find people and conversations from the sidebar search. Mention teammates with @username where supported.

Voice & video calls

Calls run in the browser using WebRTC — no separate phone number required.

Starting a call

From an open direct message or group, use the call buttons for voice or video. Grant camera/microphone permission when prompted.

Screen sharing

During a video call, share your screen or a window for demos and support sessions.

Group calls

Join group voice or video sessions when your community enables them. Participant limits depend on server configuration.

Troubleshooting

If media fails, check browser permissions, disable conflicting VPN extensions, and try a wired network. Refresh the page and rejoin the call.

Security & privacy

Understand what is protected and what you should configure yourself.

End-to-end encryption

E2EE applies to eligible direct messages. BirdX cannot decrypt that content. Verify the lock indicator in the chat header.

Two-factor authentication

Settings → Security → enable TOTP. Store backup codes offline. You will need them if you lose your authenticator device.

Session & devices

Sign out on shared computers. Change your password if you suspect compromise and contact support@birdx.chat.

Privacy policy

Full details on data collection, retention, and your rights.

Privacy Policy

Security overview

Visual explanation of how E2EE works on the homepage.

Security section

Settings & profile

Profile

Update display name, username rules, and avatar under Settings → Profile.

Language

Switch between English and Persian (FA). The interface direction updates automatically for RTL.

Notifications

Control desktop and in-app alerts. On mobile browsers you may need to add BirdX to the home screen for reliable push-style notifications.

Appearance

Toggle light or dark theme to match your environment.

Privacy (DM policy)

Choose who can start direct messages with you — everyone, contacts only, or acquaintances — in Settings → Privacy.

Apps & downloads

Web app

Recommended for daily use. Always up to date without manual installs.

app.birdx.chat

Windows

Download birdx-setup.exe from birdx.chat/downloads. The desktop app opens app.birdx.chat in a native window.

Download for Windows

Android

Install birdx.apk from birdx.chat/downloads. Allow installs from unknown sources only if you trust the official site.

Download APK

Sync across devices

Messages and read state sync when you use the same account. Calls and notifications follow your per-device settings.

More help

FAQ

Answers to common product questions.

View FAQ

Contact support

Account issues, abuse reports, and security concerns.

Contact us

Telegram

News and release announcements.

@birdx_app

GitHub

Source code and issue tracker for BirdX.Chat.

BirdX.Chat on GitHub

Self-hosted server

Host BirdX Chat (server + web client) on your own Linux VPS. The official cloud app at app.birdx.chat is separate — this guide is for operators who deploy their own domain.

The installer deploys chat only — not the birdx.chat marketing site or Windows/Android store builds. Custom branded apps are available on request via Telegram.

  1. 1

    Requirements

    Ubuntu or Debian with sudo, a public IP or domain, and ports 80/443 (plus optional TURN for calls). Minimum 2 GB RAM recommended for production.

    • Node.js 24.x is installed automatically by the script
    • HTTPS is required for push notifications
    • Default bootstrap admin username: birdxchat
  2. 2

    Online install (recommended)

    Downloads the official installer and opens the birdx-deploy menu. Choose Install → follow the wizard (domain, TLS, uploads, optional coturn).

    curl -fsSL https://raw.githubusercontent.com/iPmartNetwork/BirdX.Chat/master/scripts/install.sh | sudo bash
# later:
sudo birdx-deploy
  3. 3

    Offline install (restricted network)

    When GitHub or npm is blocked, download the source bundle, copy it to the server, then use Offline mode in birdx-deploy.

    • Download birdx-selfhost.zip from this site (see link below)
    • Upload to the server as /birdx.zip (or ~/birdx.zip)
    • Run the install script once (can be copied via USB), then birdx-deploy → Install → Source: Offline
    scp birdx-selfhost.zip root@YOUR_SERVER:/birdx.zip
ssh root@YOUR_SERVER
sudo birdx-deploy  # → Install → Offline
  4. 4

    After install

    Open your HTTPS URL, sign in or register, then visit /admin to manage users. Re-run birdx-deploy anytime for updates, .env edits, database tools, or logs.

    • Install path: /opt/birdx
    • Mirrors (npm/apt/Node) are optional — menu item 8, only if needed
    • Full env reference: GitHub .env.example

Offline source bundle

ZIP archive with server/ and client/ (same layout as the public GitHub repo). Publish updates here when you ship a new self-host release.

Download birdx-selfhost.zip

GitHub (source & issues)

Public repository for BirdX.Chat — clone for manual builds or contribution.

BirdX.Chat on GitHub

Custom native apps

Self-hosters normally use the PWA in the browser. Branded Windows/Android shells for your domain are a separate project.

@birdx_app