Skip to main content

Welcome to Chirp Documentation

Chirp is a modern, self-hostable social platform built with privacy in mind. It provides Discord-like functionality with servers, channels, direct messages, media sharing, and real-time communication, all while giving you complete control over your data.

🎵 Chirp

Why Choose Chirp?​

🏠 Self-Hosted & Private​

  • Complete Data Control: Your data stays on your server, under your control
  • No Tracking: No analytics, no telemetry, no data mining
  • Privacy First: Built with privacy as the core principle, not an afterthought

🛠️ Modern Technology Stack​

  • Frontend: React 19 with Vite, Tailwind CSS, and Zustand
  • Backend: Node.js with Express and Socket.IO
  • Database: PostgreSQL with comprehensive migration support
  • Desktop: Electron app with auto-updater
  • Mobile: Capacitor-based mobile apps

🔧 Administrator Friendly​

  • Role-Based Permissions: Comprehensive permission system
  • API Access: Full REST API for automation and integrations
  • Docker Support: Easy containerized deployment

Key Features​

Communication​

  • Text Channels: Real-time messaging with rich text support
  • Voice Channels: WebRTC-based voice chat with noise suppression and push-to-talk
  • Media Channels: Dedicated spaces for browsing and sharing media with folders
  • Forum Channels: Threaded discussions with tags and following
  • Collaborative Channels: Real-time document editing and wikis
  • Direct Messages: Private conversations with file sharing
  • Group DMs: Multi-user private conversations

Rich Content​

  • File Attachments: Upload and share any file type (up to 250MB)
  • Image Previews: Automatic thumbnails and previews
  • GIF Integration: Built-in GIF search via Tenor API
  • Custom Emoji & Stickers: Per-server custom emoji and sticker packs
  • Link Previews: Rich previews with oEmbed support
  • Reactions: Add emoji reactions to messages
  • Polls: Create and participate in polls
  • Threads: Create sub-conversations from any message
  • Pins: Pin important messages for easy reference

Community​

  • Server Events: Create and manage events with dates and locations
  • Badges: User badges and achievements
  • Friends System: Friend requests, online status, quick DM access
  • Notes: Private notes about other users

User Experience​

  • Themes: Light, dark, and custom themes
  • Notifications: Push notifications (web, desktop, mobile)
  • Search: Full-text search across messages and content
  • Mobile Support: Native Android experience via Capacitor
  • Desktop App: Electron app with auto-updates and VR notifications (XSOverlay)

Who is Chirp For?​

🏢 Businesses & Organizations​

  • Internal team communication
  • Project collaboration spaces
  • Client communication portals
  • Knowledge management systems

👥 Communities​

  • Gaming communities
  • Interest groups
  • Educational platforms
  • Social networks

👨‍💻 Developers & Tech Enthusiasts​

  • Self-hosting advocates
  • Privacy-conscious users
  • Custom platform development
  • API integration projects

Ready to get started? Let's begin your Chirp journey!