Skip to content

index.md

Latest commit

 

History

History
134 lines (89 loc) · 7.47 KB

index.md

File metadata and controls

134 lines (89 loc) · 7.47 KB
title Pubky Knowledge Base

Welcome to the Pubky Knowledge Base

This is a knowledge base for the Pubky platform, which includes [[Explore/PubkyCore/Introduction|Pubky Core]], [[0.Introduction|PKARR]] and [[Explore/PubkyApp/Introduction|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 ([[0.Introduction|PKARR]]), with simple interoperable hosting ([[Homeserver|Homeservers]]) that allow for [[Censorship|censorship]] resistance and a [[CredibleExit|credible exit]], as well as a publishing application, Pubky App, that facilitates the creation of a [[SemanticSocialGraph|Semantic Social Graph]], which can be used for filtering, discovery, matching and coordination.

Learn more about the overall vision here: [[TheVisionOfPubky|The Vision of Pubky]]

Quick Start

  • [[TLDR]]: 30-second overview of the entire ecosystem
  • [[GettingStarted|Getting Started]]: Complete guide for users and developers
  • [[Glossary]]: Quick reference for key terms
  • [[Comparisons]]: How Pubky compares to other protocols
  • [[FAQ|Frequently Asked Questions (FAQ)]]: 63+ questions answered

For Users

Try Pubky

  1. [[Explore/Technologies/PubkyRing|Pubky Ring]] - Download the mobile key manager app (iOS/Android)
  2. Pubky.app - Try the social media application
  3. [[Explore/Technologies/PubkyExplorer|Pubky Explorer]] - Browse your data at explorer.pubky.app

Identity Management

🔐 [[Explore/Technologies/PubkyRing|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.

  • [[Explore/Technologies/PubkyRing|Pubky Ring Overview]] - Your keychain for decentralized identity
  • Official Repository - React Native mobile app

For Developers: Pubky Core

🏗️ [[Explore/PubkyCore/Introduction|Pubky Core]] is the open protocol and infrastructure for building censorship-resistant web applications.

Core Documentation

  • [[Explore/PubkyCore/Introduction|Pubky Core Overview]] - Protocol, Homeserver, and SDK
  • [[Explore/PubkyCore/SDK|SDK Documentation]] - Client libraries (Rust, JavaScript, iOS, Android)
  • [[Explore/PubkyCore/API|API Reference]] - RESTful HTTP API specification
  • [[Architecture|Architecture Overview]] - System design and data flow
  • [[Homeserver|Homeserver Documentation]] - Deploy and configure Homeservers
  • [[Explore/PubkyCore/SecurityModel|Security Model]] - Threat landscape, trust assumptions, and credible exit

Infrastructure

  • [[Homegate|Homegate]] - Signup verification service for Homeservers (SMS + Lightning)
  • [[PKDNS|PKDNS]] - DNS server for resolving public-key domains
  • [[Explore/PubkyApp/Backend/PubkyNexus|Pubky Nexus]] - Production indexing service
  • [[Explore/Technologies/HTTPRelay|HTTP Relay]] - Auth token forwarding for authentication flows
  • [[Explore/Technologies/PubkyBackup|Pubky Backup]] - Desktop backup for data portability and credible exit
  • [[Explore/Technologies/PubkyModeration|Pubky Moderation]] - Content moderation service

Resources

Developer Tools

🛠️ Pubky Ecosystem Tools - Utilities for development, debugging, and exploration:

  • [[Explore/Technologies/PubkyDocker|Pubky Docker]] - One-click Docker stack for running the complete Pubky Social environment locally
  • [[Explore/Technologies/PubkyExplorer|Pubky Explorer]] - Web-based file browser for Homeserver data (explorer.pubky.app)
  • [[Explore/Technologies/PubkyCLI|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)
  • [[JebPubkyAIBot|Jeb AI Bot]] - AI-powered bot for summaries and fact-checking on Pubky social network

Pubky App: Social Application

[[Explore/PubkyApp/Introduction|Pubky App]] is a decentralized social media application built on Pubky Core.

Current Status

  • Live Application: https://pubky.app - Production PWA currently operational
  • Web Client: [[Explore/PubkyApp/Client/PubkyApp|pubky.app]] (github.com/pubky/pubky-app)
  • Data Model Specification: [[Explore/PubkyApp/AppSpecs|App Specs]] (pubky-app-specs) - Formal schema definitions for interoperability

Backend Infrastructure

🚀 [[Explore/PubkyApp/Backend/PubkyNexus|Pubky Nexus]] is the production indexing and aggregation service that powers Pubky App's social features.

  • [[Explore/PubkyApp/Backend/PubkyNexus|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:

  • [[SemanticSocialGraph|Semantic Social Graph]] - Tagged relationships and user-controlled filtering
  • [[Censorship|Censorship Resistance]] - Why centralized platforms fail
  • [[CredibleExit|Credible Exit]] - Freedom to switch providers without losing data
  • [[0.Introduction|PKARR]] - Public key addressable resource records
  • [[MainlineDHT|Mainline DHT]] - Distributed hash table for discovery

Work in Progress: Payment Protocol

⚠️ [[Explore/Technologies/Paykit|Paykit]] is a payment protocol (work in progress) built on Pubky for payment discovery and coordination. Not production-ready.

Work in Progress: Encrypted Communication

⚠️ [[Explore/Technologies/PubkyNoise|Pubky Noise]] is a Noise Protocol implementation (work in progress) for encrypted peer-to-peer communication in the Pubky ecosystem. Not production-ready.

  • [[Explore/Technologies/PubkyNoise|Pubky Noise Overview]] - Encrypted channels for private communication (WIP)
  • Repository (WIP) - BitcoinErrorLog fork

Community & Support

  • [[GettingStarted|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 [[GettingStarted|Getting Started]] guide or dive into [[Explore/PubkyCore/Introduction|Pubky Core]]!