bllackbull/songbird repository overview

English⁠ | فارسی⁠

⁠Key Features

• 💬 Chat Types: Direct messages, groups, and channels
• 📁 Media Support: File uploads, voice messages, video transcoding
• 🔔 Push Notifications: Web push with VAPID
• 📡 Remote Channels: Mirror Telegram or Songbird channels (v0.10.3+)
• 🛡️ Admin Panel: Full management interface with owner role (v0.11.0+)
• 🔒 Security: Encryption at rest, bcrypt hashing, rate limiting
• 📱 PWA: Installable progressive web app
• ☁️ Cloud Deployment: PaaS and CaaS deployment with object storage support
• 🌍 i18n: English and Persian/Farsi support

⁠Quick Start

The easiest way to install Songbird is the deployment script. On an Ubuntu server (22.04+) with sudo access, run:

curl -fsSL https://raw.githubusercontent.com/bllackbull/Songbird/main/scripts/install.sh | bash

The script handles dependencies, builds the app, configures Nginx, and can set up SSL for you. After installation, access it again anytime with:

songbird-deploy

⁠Documentation

Full documentation lives at docs.songbird.website⁠:

• Deployment Script⁠
• Install via Docker⁠
• Cloud Deployment⁠
• Manual Installation⁠
• Configure Nginx⁠
• SSL Certificates⁠
• Running behind a CDN⁠
• Running behind a domain + subpath⁠
• Environment Variables⁠
• Object Storage⁠
• Media Worker⁠
• Admin Panel⁠
• Remote Channel Setup⁠
• Push Notification Proxy⁠
• Updating the deployed app⁠
• Database Commands⁠
• Troubleshooting⁠

⁠Author

• Maintainer: @bllackbull⁠
• Contributors: @nkhalili⁠, @modos⁠, @iPmartNetwork⁠

⁠Contributing

• Contributions are welcome.
• If you want to contribute, contact the maintainer first by opening an issue here⁠.
• For direct coordination, reach out to @bllackbull⁠ on GitHub before opening a PR.
• Checkout Contributing⁠ guideline for more information.

⁠Support

If you like this project which I hope you do, consider supporting your favorite project:

⁠

⁠TRX:

TPf1bEhipKpGkjo5N2Scj9nufNNh5TNrwX

⁠BTC:

bc1q9hupvcc39juhf0k7rgzn6phn8s8jez365kzmuj

⁠TON:

UQDzQ3xbWzKQvw8X8sWU82dksBeYqTHrT9sLzhBOyaESPjVy

⁠License

This project is licensed under the MIT License. See the LICENSE⁠ file for details.