Welcome to the Pubky Knowledge Base
This is a knowledge base for the Pubky platform, which includes Pubky Core, PKARR and Pubky App. These documents are a work in progress, much like Pubky’s protocols and applications!
What is Pubky?
Pubky attempts to unlock the web by realizing our vision for a key-based, self-regulating web that puts users in control.
So far, Pubky does this by combining practical decentralized routing & identity (PKARR), with simple interoperable hosting (Homeservers) that allow for censorship resistance and a credible exit, as well as a publishing application, Pubky App, that facilitates the creation of a Semantic Social Graph, which can be used for filtering, discovery, matching and coordination.
Learn more about the overall vision here: The Vision of Pubky
Quick Start
- TLDR: 30-second overview of the entire ecosystem
- Getting Started: Complete guide for users and developers
- Glossary: Quick reference for key terms
- Comparisons: How Pubky compares to other protocols
- Frequently Asked Questions (FAQ): 63+ questions answered
For Users
Try Pubky
- Pubky Ring - Download the mobile key manager app (iOS/Android)
- Pubky.app - Try the social media application
- Pubky Explorer - Browse your data at explorer.pubky.app
Identity Management
🔐 Pubky Ring is the key manager app for the Pubky ecosystem. Native mobile app (iOS/Android) for managing your pubkys, authorizing apps, and controlling sessions.
- Pubky Ring Overview - Your keychain for decentralized identity
- Official Repository - React Native mobile app
For Developers: Pubky Core
🏗️ Pubky Core is the open protocol and infrastructure for building censorship-resistant web applications.
Core Documentation
- Pubky Core Overview - Protocol, homeserver, and SDK
- SDK Documentation - Client libraries (Rust, JavaScript, iOS, Android)
- API Reference - RESTful HTTP API specification
- Architecture Overview - System design and data flow
- Homeserver Documentation - Deploy and configure homeservers
Infrastructure
- Homegate - Signup verification service for homeservers (SMS + Lightning)
- PKDNS - DNS server for resolving public key domains
- Pubky Nexus - Production indexing service
Resources
- Official Repository - MIT licensed
- Official Docs - Complete documentation
- Rust API Docs - Rust crate documentation
- NPM Package - JavaScript/TypeScript bindings
Developer Tools
🛠️ Pubky Ecosystem Tools - Utilities for development, debugging, and exploration:
- Pubky Docker - One-click Docker stack for running the complete Pubky Social environment locally
- Pubky Explorer - Web-based file browser for homeserver data (explorer.pubky.app)
- Pubky CLI - Command-line tool for homeserver management and testing
- PKDNS Digger - Web-based DNS record lookup tool for PKARR domains (github.com/pubky/pkdns-digger)
- Jeb AI Bot - AI-powered bot for summaries and fact-checking on Pubky social network
Pubky App: Social Application
Pubky App is a decentralized social media application built on Pubky Core.
Current Status
- Live Application: https://pubky.app - Production PWA currently operational
- Current Repository: github.com/pubky/pubky-app - ⚠️ Deprecated (MVP codebase)
- New Development: github.com/pubky/franky - Work in Progress (next-gen client, expected summer 2025)
- Data Model Specification: pubky-app-specs - Formal schema definitions for interoperability
Backend Infrastructure
🚀 Pubky Nexus is the production indexing and aggregation service that powers Pubky App’s social features.
- Pubky Nexus Overview - Real-time social graph aggregation and high-performance API
- Official Repository - Open source Rust implementation
- Live API - Production REST API with Swagger UI
- Staging API - Latest development version
Key Concepts
Understand the fundamental ideas behind Pubky:
- Semantic Social Graph - Tagged relationships and user-controlled filtering
- Censorship Resistance - Why centralized platforms fail
- Credible Exit - Freedom to switch providers without losing data
- PKARR - Public key addressable resource records
- Mainline DHT - Distributed hash table for discovery
Work in Progress: Payment Protocol
⚠️ Paykit is a payment protocol (work in progress) built on Pubky for payment discovery and coordination. Not production-ready.
- Paykit Overview - Current state and architecture (WIP)
- Fork Repository (WIP) - BitcoinErrorLog fork
- Complete Documentation - Repository docs (work in progress)
Work in Progress: Encrypted Communication
⚠️ Pubky Noise is a Noise Protocol implementation (work in progress) for encrypted peer-to-peer communication in the Pubky ecosystem. Not production-ready.
- Pubky Noise Overview - Encrypted channels for private communication (WIP)
- Repository (WIP) - BitcoinErrorLog fork
Community & Support
- Getting Started - Complete onboarding guide
- FAQ - Frequently asked questions
- Troubleshooting - Common issues and solutions
- Contributing - How to contribute to Pubky
- Telegram: t.me/pubkycore
- GitHub: github.com/pubky
Ready to get started? Check out the Getting Started guide or dive into Pubky Core!