# Misskey — Federated Social Platform with Rich Media and Customization

> Feature-rich, ActivityPub-compatible social networking platform with reactions, drive storage, antenna feeds, and extensive theming options.

## Install

Save in your project root:

# Misskey — Federated Social Platform for the Fediverse

## Quick Use
```bash
# Docker Compose deployment
git clone https://github.com/misskey-dev/misskey.git && cd misskey
cp .config/docker_example.yml .config/default.yml
cp docker-compose_example.yml docker-compose.yml
# Edit default.yml with your domain and database settings
docker compose build && docker compose up -d
# Access at https://your-domain and create the first admin user
```

## Introduction
Misskey is a decentralized, open-source social networking platform that federates via ActivityPub. Originating from Japan, it offers a uniquely expressive experience with custom emoji reactions, a media drive, antenna-based feeds, and deep theming support that sets it apart from other fediverse platforms.

## What Misskey Does
- Posts notes (short messages) with text, images, polls, and content warnings
- Supports custom emoji reactions beyond simple likes for expressive engagement
- Provides a personal Drive for uploading and organizing media files
- Offers Antennas that create custom feeds based on keyword and user filters
- Federates with Mastodon, Lemmy, Pleroma, and other ActivityPub-compatible platforms

## Architecture Overview
Misskey is a Node.js application built with Fastify on the backend and Vue.js on the frontend. PostgreSQL stores all persistent data, Redis handles caching and job queues, and MeiliSearch provides optional full-text search. The federation layer implements ActivityPub for inter-instance communication, with signed HTTP requests for authenticity. Background workers process federation deliveries and media thumbnailing.

## Self-Hosting & Configuration
- Deploy via Docker Compose with the provided example configuration files
- Requires Node.js 20+, PostgreSQL 15+, Redis 7+, and optionally MeiliSearch
- Configure instance name, domain, database, and object storage in default.yml
- Set up a reverse proxy (Nginx or Caddy) with SSL and WebSocket forwarding
- Use the admin panel for instance-level settings, moderation rules, and federation controls

## Key Features
- Rich custom emoji system with reactions, remote emoji imports, and packs
- Widgets and dashboard customization for a personalized home experience
- Pages feature for creating custom profile pages with a built-in editor
- Clip collections for bookmarking and organizing notes by topic
- MFM (Misskey Flavored Markdown) with animations, ruby text, and special formatting

## Comparison with Similar Tools
- **Mastodon** — Most popular fediverse platform; more minimalist UX with fewer interactive features
- **Pleroma / Akkoma** — Lightweight ActivityPub servers; lower resource usage but fewer built-in features
- **Pixelfed** — Federated photo sharing focused on images; not designed for text-based social networking
- **GoToSocial** — Lightweight Go-based ActivityPub server; API-only with no built-in web frontend
- **Threads (Meta)** — Centralized microblogging with partial ActivityPub support; proprietary

## FAQ
**Q: Can Misskey users interact with Mastodon users?**
A: Yes. Both platforms support ActivityPub, so users can follow, reply, and boost content across instances.

**Q: What are the server requirements for a Misskey instance?**
A: A small instance runs on 2 CPU cores, 2GB RAM, and 20GB storage. Larger instances with many active users need 4+ cores and 8GB+ RAM.

**Q: How do custom emoji reactions work?**
A: Instance admins can upload custom emoji, and users can react to any note with them. Remote emoji from federated instances can also be imported.

**Q: Are there forks of Misskey I should know about?**
A: Sharkey and Firefish are popular forks with their own feature additions and community. They remain compatible with the broader Misskey and fediverse ecosystem.

## Sources
- https://github.com/misskey-dev/misskey
- https://misskey-hub.net/en/docs/

---
Source: https://tokrepo.com/en/workflows/aa95e9df-3cb4-11f1-9bc6-00163e2b0d79
Author: AI Open Source