Skip to main content

Welcome to Bellamy Book Documentation

Welcome to the documentation for Bellamy Book, a self-hosted social network platform. This documentation covers everything you need to set up, use, and extend your own social network on your infrastructure. New here? Read the product overview on the self-hosted social network landing page (build your own platform—deploy with Docker or try the demo).

What is Bellamy Book?​

Bellamy Book is a self-hosted social networking platform that gives you a full-featured network (posts, messaging, stories, friends, and more). Deploy it on your own servers; white-label and customize. It includes:

  • Posts & Feed: Create, share, and interact with posts (personalized feed via api/Post)
  • Comments & Reactions: Engage with content through comments and reactions (api/Comment, api/Post reactions)
  • Messaging: Real-time messaging between users (api/Chat, SignalR/ChatWorker); Voice/Video Calls (api/Call, LiveKit)
  • Stories: Share temporary stories with your network (api/Story)
  • Friends & Connections: Manage your network (api/Friendship, api/Follow, api/friends)
  • Hashtags: Discover content and trending topics (api/Hashtags)
  • Notifications: Real-time and push notifications (api/Notification, api/Announcement; WebSocketWorker)
  • Blogs: Published blogs and admin blog editor (api/Blog)
  • Search: Full-text search across users, posts, blogs, hashtags (api/Search, Elasticsearch)
  • Support Tickets: User support tickets (frontend + api/tickets when licensed)
  • License: Activation (CONSUMER) or key generation (MAIN) (api/license)
  • Email Campaigns, AI Blog Generation: License-gated admin features (api/EmailCampaign, api/ai-agent)
  • Backup: Admin backup and restore (api/admin/backup)
  • Analytics: Admin dashboard engagement metrics (api/admin/dashboard)
  • Save to Web (PWA): Install Bellamy Book on your phone or computer like an app—quick access from home screen or taskbar, Web Push for chat and call notifications when the app is closed or in the background, and a better experience on slow networks. See Save the website as an app.

Tip for users: Save to Web​

You can save Bellamy Book to your device and use it like a native app. This helps you:

  • Quick access — One tap from your home screen (mobile) or taskbar (desktop).
  • Web Push — Get chat messages and incoming-call notifications even when the app is closed or in the background.
  • App-like experience — Standalone window, no browser tabs; works better on slow or flaky networks.

How to save the website as an app → (Android, iPhone/iPad, Windows, macOS)

Documentation Sections​

📚 Features Overview​

All product features with links to detailed docs (posts, blogs, search, messaging, license, backup, and more).

📲 Save to Web (install as app)​

Install Bellamy Book on your phone or computer for quick access, Web Push notifications, and an app-like experience—helps users get the most out of the platform.

📖 Getting Started​

Installation, configuration, and quick start.

🔌 API Reference​

Detailed API documentation with endpoints, authentication, and examples.

🎓 Tutorials​

Step-by-step tutorials for common tasks and advanced features.

🏠 Self-Hosting​

Guides for deploying and self-hosting the application.

📸 Screenshots​

Visual documentation and screenshots of the application.

🏗️ Architecture​

System architecture, design decisions, and technical documentation.

📝 Release Notes​

Changelog and release notes for all versions.

Quick Start​

  1. Installation Guide
  2. Configuration
  3. Quick Start Tutorial

Need Help?​

Let's get started! 🚀