Home

nself-chat Documentation

Version: 0.9.1 (February 3, 2026) Status: Production-Ready License: MIT

White-Label Team Communication Platform

Quick Start • Installation • Features • Deployment • API • Contributing

---

Documentation Structure

This documentation is organized into the following sections:

📚 Getting Started

Start here if you're new to nself-chat.

• Quick Start Guide - Get running in 5 minutes
• Installation Guide - Detailed installation instructions
• Getting Started - First steps after installation

✨ Features

Learn about all the features nself-chat offers.

Core Features

• Features Overview - Complete feature list
• Messaging Features - Chat capabilities
• Feature Completion Matrix - Feature parity comparison

Communication Features

• Voice Calling - Voice call implementation
• Live Streaming - Live streaming capabilities
• Screen Sharing - Screen sharing features
• Mobile Calls - Mobile call optimization

Interactive Features

• GIFs & Stickers - GIF picker and sticker packs
• Polls - Create and manage polls
• Social Media Integration - Twitter, Instagram, LinkedIn integration

Advanced Features

• Search - Enhanced search with MeiliSearch
• Social Media Posting - Auto-posting to social platforms

Customization

• White-Label Guide - Branding and theming
• Bots - Bot development and integration
• Plugins - Plugin system
• Plugin List - Available plugins
• Media Server - Media server configuration

📖 Guides

Step-by-step implementation and usage guides.

Implementation Guides

• Advanced Messaging - Edit, delete, forward, pin, star messages
• E2EE (End-to-End Encryption) - Encryption implementation
• Search Implementation - MeiliSearch integration
• Live Streaming - Stream implementation
• Screen Sharing - Screen sharing setup
• Video Calling - Video call setup
• Voice Calling - Voice call implementation
• Call Management - Call system management
• Mobile Call Optimizations - Mobile-specific optimizations

User Guides

• User Guide - End-user documentation
• Settings Quick Start - User settings guide
• Testing Guide - Testing strategies
• Integration Examples - Code examples
• Utilities Guide - Development utilities

📚 Reference

Technical reference documentation.

Architecture & Design

• Architecture - System architecture
• Architecture Diagrams - Visual documentation
• Database Schema - Database structure
• Project Structure - Codebase organization
• TypeScript Types - Type definitions
• SPORT Reference - Complete API reference

Quick References

• 2FA Quick Reference - Two-factor authentication
• Advanced Messaging Quick Reference - Messaging shortcuts
• Call Management Quick Reference - Call system shortcuts
• Call State Machine - Call state diagram
• E2EE Quick Reference - Encryption quick reference
• Live Streaming Quick Start - Streaming quick start
• Mobile Calls Quick Reference - Mobile call shortcuts
• PIN Lock Quick Start - PIN lock setup
• Polls Quick Start - Polls quick reference
• Screen Sharing Quick Reference - Screen sharing shortcuts
• Search Quick Start - Search operators and filters
• Social Media Quick Reference - Social integration shortcuts
• Voice Calling Quick Start - Voice call quick start

⚙️ Configuration

Configure nself-chat for your needs.

• Configuration Guide - Complete configuration reference
• Authentication Setup - Auth provider configuration
• Environment Variables - All environment variables

📡 API

API documentation and examples.

• API Overview - GraphQL API overview
• API Documentation - Complete API reference
• API Examples - Multi-language code examples
• Bot API Implementation - Bot API reference

🚀 Deployment

Deploy nself-chat to production.

• Deployment Overview - Production deployment guide
• Docker Deployment - Deploy with Docker
• Kubernetes Deployment - Deploy to K8s
• Helm Charts - Helm deployment
• Production Checklist - Pre-deployment checklist
• Production Validation - Post-deployment validation

🔐 Security

Security features and best practices.

Security Features

• Security Overview - Security architecture
• Security Audit - Security audit results
• Performance Optimization - Performance guide

Authentication & Authorization

• 2FA Implementation - Two-factor authentication
• PIN Lock System - PIN lock and biometric auth
• PIN Lock Implementation - Technical details

Encryption

• E2EE Implementation Summary - End-to-end encryption
• E2EE Security Audit - Encryption audit

🆘 Troubleshooting

Common issues and solutions.

• FAQ - Frequently asked questions
• Troubleshooting Guide - Common issues
• Operations Runbook - Operations guide

ℹ️ About

Project information and planning.

Release Information

• Changelog - Version history
• Release Notes v0.3.0 - Latest release notes
• Release Checklist v0.3.0 - Release checklist
• Implementation Complete - v0.3.0 completion status

Planning & Roadmap

• Roadmap - Future plans
• Roadmap v0.2 - v0.2 planning
• Upgrade Guide - Version upgrade guide
• Contributing - How to contribute

Documentation

• Documentation Audit - Documentation quality assessment
• Documentation Map - Documentation structure
• Documentation Improvements - Improvement summary
• Documentation Improvements v0.3.0 - v0.3.0 improvements
• Advanced Messaging Report - Feature report

---

Quick Start

Get nself-chat running in under 5 minutes:

# 1. Clone the repository
git clone https://github.com/nself-org/nchat.git
cd nself-chat

# 2. Install dependencies
pnpm install

# 3. Start development mode (with test users)
pnpm dev

# 4. Open in browser
open http://localhost:3000

Next Steps:

1. Complete the 9-step setup wizard
2. Explore the feature documentation
3. Check out the configuration guide

Full Quick Start Guide →

---

What's New in v0.9.1

Documentation Excellence & Plugin System

v0.9.1 brings comprehensive documentation polish and a powerful plugin architecture:

Highlights

1. Advanced Messaging Features ✅

   • Edit messages with edit history
   • Delete messages (soft delete)
   • Forward messages to multiple channels
   • Pin important messages
   • Star/save messages for later
   • Message read receipts
   • Real-time typing indicators
   • Learn More →

2. GIFs and Stickers 🎨

   • GIF search integration (Tenor API)
   • GIF picker in message composer
   • Sticker packs management
   • Custom sticker upload (admin/owner)
   • 2 default sticker packs included
   • Learn More →

3. Polls and Interactive Messages 📊

   • Create polls with multiple options
   • Single-choice and multiple-choice
   • Anonymous voting option
   • Poll expiration/deadline
   • Live poll results
   • Learn More →

4. Two-Factor Authentication (2FA) 🔒

   • TOTP 2FA setup with QR code
   • Support for authenticator apps
   • 10 backup codes per user
   • 2FA enforcement option
   • Remember device (30 days)
   • Recovery process
   • Learn More →

5. PIN Lock & Session Security 🔐

   • PIN lock setup (4-6 digits)
   • Lock on app close/background
   • Auto-lock after timeout
   • Biometric unlock (WebAuthn)
   • Emergency unlock with password
   • Failed attempt lockout
   • Learn More →

6. Enhanced Search 🔍

   • Search messages, files, users, channels
   • Advanced filters (date, channel, user, type)
   • Search within threads
   • Search operators (from:, in:, has:, before:, after:)
   • Search history and saved searches
   • Keyboard shortcuts (Cmd+K)
   • Learn More →

7. Bot API Foundation 🤖

   • Bot user type
   • Bot token generation
   • Bot API endpoints (5 endpoints)
   • Webhook delivery
   • Bot permissions system (16 permissions)
   • Bot management UI
   • Learn More →

8. Social Media Integration 🌐

   • Link social accounts (Twitter, Instagram, LinkedIn)
   • Monitor accounts for new posts
   • Auto-post to announcement channels
   • Rich embeds for social posts
   • Enable/disable per account
   • Post filtering (hashtags, keywords)
   • Learn More →

Full Changelog →

---

Architecture Overview

┌─────────────────────────────────────────────────────────────────┐
│                     nself-chat Platform (v0.3.0)                 │
├─────────────────────────────────────────────────────────────────┤
│   Frontend (Next.js 15 + React 19)                              │
│   • 9-step setup wizard                                          │
│   • 25+ theme presets (light/dark)                              │
│   • Real-time messaging UI                                       │
│   • Advanced search (MeiliSearch)                                │
│   • Bot management dashboard                                     │
│   • Social media integration UI                                  │
├─────────────────────────────────────────────────────────────────┤
│   State Management                                               │
│   • Zustand (client state)                                       │
│   • Apollo Client (GraphQL + subscriptions)                      │
│   • LocalStorage + Database sync                                 │
├─────────────────────────────────────────────────────────────────┤
│   Backend (nself CLI v0.4.2)                                     │
│   • PostgreSQL (database)                                        │
│   • Hasura GraphQL Engine                                        │
│   • Nhost Auth (production) / FauxAuth (dev)                    │
│   • MinIO (file storage)                                         │
│   • MeiliSearch (search engine)                                  │
│   • Redis (jobs & caching)                                       │
├─────────────────────────────────────────────────────────────────┤
│   Multi-Platform Support                                         │
│   • Web (Next.js)                                                │
│   • Desktop (Tauri, Electron)                                    │
│   • Mobile (Capacitor, React Native)                             │
│   • PWA (installable)                                            │
└─────────────────────────────────────────────────────────────────┘

Detailed Architecture →

---

Tech Stack

Frontend

• Framework: Next.js 15.5.10, React 19.0.0, TypeScript 5.7.3
• UI: Tailwind CSS 3.4.17, Radix UI, Framer Motion 11.18.0
• State: Zustand 5.0.3, Apollo Client 3.12.8
• Forms: React Hook Form 7.54.2, Zod 3.24.1
• Editor: TipTap 2.11.2 (rich text)
• Real-time: Socket.io 4.8.1, GraphQL subscriptions

Backend (via nself CLI)

• Database: PostgreSQL with 60+ extensions
• GraphQL: Hasura GraphQL Engine
• Auth: Nhost Authentication
• Storage: MinIO (S3-compatible)
• Search: MeiliSearch 0.44.0
• Cache: Redis

Development

• Testing: Jest 29.7.0, Playwright 1.50.1
• Linting: ESLint 9.18.0, Prettier 3.4.2
• CI/CD: 19 GitHub Actions workflows
• Monitoring: Sentry 8.47.0

---

Key Features

White-Label Everything

• Complete branding customization (name, logo, colors)
• 25+ theme presets with light/dark modes
• Custom CSS injection support
• Landing page templates (5 options)
• Feature toggles for selective functionality

Dual Authentication

• Development Mode: 8 test users for fast iteration
• Production Mode: Nhost Auth with 11 provider options
  • Email/password, Magic links
  • Google, Facebook, Twitter, GitHub, Discord, Slack
  • ID.me (military, police, first responders, government)

Advanced Messaging

• Edit/delete messages with history
• Forward to multiple channels
• Pin important messages
• Star/bookmark messages
• Read receipts & typing indicators
• Threaded conversations
• Rich text editing (markdown, code blocks)

Powerful Search

• MeiliSearch integration (sub-50ms queries)
• Search operators: from:, in:, has:, before:, after:, is:
• Filter by date, channel, user, file type
• Search within threads
• Saved searches and history
• Keyboard shortcuts (Cmd+K)

Enterprise Security

• Two-factor authentication (TOTP)
• PIN lock with biometric support
• Session management with device tracking
• Row-level security (RLS) on all tables
• Audit logging for admin actions
• Content moderation and filtering

---

Documentation By Audience

For End Users

• Quick Start
• User Guide
• Settings Guide
• FAQ

For Administrators

• Installation
• Configuration
• Deployment Guide
• Production Checklist
• Runbook
• Security Overview

For Developers

• Architecture
• API Reference
• Contributing Guide
• Testing Guide
• Bot Development
• Plugin Development

For DevOps

• Docker Deployment
• Kubernetes Deployment
• Helm Charts
• Production Validation
• Runbook

---

Project Stats

Metric	Value
Version	0.9.1
Release Date	February 3, 2026
Total Features	150+
Feature Parity	~65% (vs major platforms)
Components	75+ directories
Custom Hooks	60+ hooks
Database Tables	50+ tables
API Endpoints	40+ endpoints
Theme Presets	25+ themes
Auth Providers	11 providers
CI Workflows	19 workflows
Documentation Pages	333+ pages

---

Support & Community

Getting Help

• Documentation: You're reading it!
• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Email: support@nself.org

Contributing

We welcome contributions! See our Contributing Guide for:

• Code of conduct
• Development setup
• Pull request process
• Code standards
• Testing requirements

Roadmap

• v0.9.2 (1 week): Additional plugin integrations
• v1.0.0 (1 month): Production launch with full feature parity
• v1.1.0 (2 months): Advanced AI features and analytics
• v1.2.0 (3 months): Enterprise features and compliance

Full Roadmap →

---

License

MIT License - see LICENSE for details.

---

Acknowledgments

Built with:

• Next.js - React framework
• nself CLI - Backend infrastructure
• Radix UI - UI components
• Tailwind CSS - Styling
• MeiliSearch - Search engine
• Hasura - GraphQL engine

---

Version 0.9.1 • February 2026 • GitHub

nself-chat - White-label team communication platform