GnosysLabs/Synapsis
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: remove AI-assisted setup wizard mentions

Browse Source
This commit is contained in:
Christomatt
2026-02-01 03:24:43 +01:00
parent 4326aa768e
commit 9b22b2a944
13 changed files with 495 additions and 384 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+93 -91
View File
@@ -1,34 +1,64 @@
# Synapsis
Synapsis is an open-source, federated social network built to serve as global communication infrastructure. It is designed to be lightweight, easy to deploy, and built on the Synapsis Swarm network.
**Your node. Your network. Your identity.**
## Features
- **Swarm Network**: Native peer-to-peer network for Synapsis nodes with gossip protocol.
- **Swarm Chat**: End-to-end encrypted chat system built for the swarm.
- **Decentralized Identity (DIDs)**: Portable identity system that you truly own.
- **AI Bots**: Create and manage AI-powered bot accounts with custom personalities.
- **Modern UI**: Clean, responsive interface inspired by Vercel's design system.
- **Rich Media**: Support for image uploads and media galleries.
- **Moderation**: Built-in admin dashboard for user management and content moderation.
- **Setup Wizard**: User-friendly `/install` flow to get your node running in minutes.
- **Curated Feeds**: Smart feed algorithms to highlight engaging content across the swarm.
Synapsis is an open-source, federated social network built for the decentralized web. Run your own node, own your identity with DIDs, and communicate across the Swarm network with end-to-end encryption. No corporations. No lock-in. Just you and the network.
---
## 📖 User Guide
## 🚀 Deploy Your Own Node (5 Minutes)
New to Synapsis? Visit the **[/guide](/guide)** page in the app for a comprehensive walkthrough on:
Run your personal Synapsis node with a single command:
- How the Swarm network works
- How Synapsis differs from traditional social networks
- How to follow users on other nodes
- How others can follow you
- Understanding Decentralized Identifiers (DIDs) and portable identity
```bash
# 1. Download and start
mkdir -p /opt/synapsis && cd /opt/synapsis
curl -O https://raw.githubusercontent.com/cyph3rasi/synapsis/main/docker-compose.yml
curl -O https://raw.githubusercontent.com/cyph3rasi/synapsis/main/docker/Caddyfile
curl -O https://raw.githubusercontent.com/cyph3rasi/synapsis/main/docker/.env.example
cp .env.example .env
# 2. Edit .env with your domain and secrets (takes 2 minutes)
nano .env
# 3. Start your node
docker compose up -d
```
Done! Your node is live at `https://your-domain.com` with automatic SSL. No build step. No dependencies. No fuss.
**Updating:**
```bash
docker compose pull && docker compose up -d
```
For detailed Docker setup, see [docker/README.md](docker/README.md).
---
## Architecture & Concepts
## ✨ Features
- **🌐 Swarm Network** — Native peer-to-peer network with automatic node discovery and gossip protocol
- **💬 Swarm Chat** — End-to-end encrypted messaging across the entire network
- **🔐 Decentralized Identity (DIDs)** — Cryptographic identity you truly own, portable between nodes
- **🤖 AI Bots** — Create AI-powered bot accounts with custom personalities
- **🎨 Modern UI** — Clean, responsive interface inspired by Vercel's design system
- **🖼️ Rich Media** — Image uploads, media galleries, and S3-compatible storage
- **🛡️ Built-in Moderation** — Admin dashboard for user management and content moderation
- **📱 Auto Port Detection** — Runs on the first available port (3000-3020) automatically
- **📊 Curated Feeds** — Smart algorithms highlighting engaging content across the swarm
---
## 📖 Documentation
- **[Docker Deployment Guide](docker/README.md)** — Complete production deployment instructions
- **[User Guide](/guide)** — Learn how Synapsis works (visit after installing)
- **[API Documentation](https://docs.synapsis.social)** — Developer reference
---
## 🏗️ Architecture
Synapsis differs from traditional social networks by prioritizing **sovereign identity** and **native peer-to-peer communication**.
@@ -43,33 +73,26 @@ Unlike centralized platforms where your identity is a row in a database owned by
| **Key Pair** | Every account has a public/private key pair. Your private key proves you are you; your public key lets others verify your identity. |
**Why this matters:**
- **Ownership**: Your identity is cryptographically yours, not controlled by a company.
- **Authenticity**: Every post is signed with your private key, proving it came from you.
- **True Portability**: Move your account between nodes without losing followers.
- **Ownership** — Your identity is cryptographically yours, not controlled by a company
- **Authenticity** — Every post is signed with your private key, proving it came from you
- **True Portability** — Move your account between nodes without losing followers
### 🌐 The Swarm Network
Synapsis operates on the **Swarm** — a native peer-to-peer network designed specifically for Synapsis nodes:
- **Gossip Protocol**: Nodes discover each other automatically and exchange information.
- **Swarm Timeline**: Aggregated feed of posts from across all Synapsis nodes.
- **Swarm Chat**: End-to-end encrypted direct messaging between users on any Synapsis node.
- **Handle Registry**: Distributed directory of user handles across the swarm.
- **Instant Interactions**: Likes, reposts, follows, and mentions delivered in real-time.
**Swarm Features:**
- Real-time post delivery across the network
- Encrypted chat with read receipts
- Automatic node discovery and health monitoring
- Distributed user directory
- Cross-node interactions (likes, reposts, follows)
- **Gossip Protocol** — Nodes discover each other automatically and exchange information
- **Swarm Timeline** — Aggregated feed of posts from across all Synapsis nodes
- **Swarm Chat** — End-to-end encrypted direct messaging between users on any Synapsis node
- **Handle Registry** — Distributed directory of user handles across the swarm
- **Instant Interactions** — Likes, reposts, follows, and mentions delivered in real-time
### 🆚 Synapsis vs. Traditional Federation
| Feature | Traditional Federation | Synapsis |
|---------|------------------------|----------|
| **Identity** | Server-bound (`@user@server`) | DID-based (cryptographic, portable) |
| **Account Migration** | Limited (followers don't auto-migrate) | **Full**: DID-based migration with auto-follow |
| **Account Migration** | Limited (followers don't auto-migrate) | **Full** — DID-based migration with auto-follow |
| **Cryptographic Signing** | HTTP Signatures only | Full post signing with user keys |
| **Direct Messages** | Posts with limited visibility | True E2E encrypted chat |
| **Network Discovery** | Manual server discovery | Automatic gossip protocol |
@@ -78,75 +101,54 @@ Synapsis operates on the **Swarm** — a native peer-to-peer network designed sp
---
## Tech Stack
## 🛠️ Development
- **Framework**: [Next.js 15+](https://nextjs.org/) (App Router)
- **Database**: PostgreSQL (via [Neon](https://neon.tech) / Drizzle ORM)
- **Styling**: Tailwind CSS v4 & custom Vercel-like design system
- **Authentication**: Auth.js (NextAuth)
- **Type Safety**: TypeScript
Want to hack on Synapsis? Here's how to run it locally:
---
### Prerequisites
- Node.js 20+
- PostgreSQL 15+
- S3-compatible storage (or MinIO for local dev)
## Recent Updates
### Swarm Chat (Latest)
- End-to-end encrypted messaging between Synapsis users
- Real-time delivery across nodes
- Read receipts and delivery status
- No legacy protocol limitations - built for the swarm
- See [SWARM_CHAT.md](SWARM_CHAT.md) for details
### Bug Fixes
- Fixed remote users appearing in local user lists
- Fixed duplicate posts in swarm feeds
- Improved swarm timeline filtering to only show local posts
### Swarm Network Improvements
- Enhanced gossip protocol for node discovery
- Improved handle registry synchronization
- Better error handling for cross-node communication
---
## 🚀 Run Your Own Node
### Quick Start (Docker - Recommended)
Deploy your own Synapsis node in minutes using Docker:
### Local Setup
```bash
# 1. Create directory and download files
mkdir -p /opt/synapsis && cd /opt/synapsis
curl -O https://raw.githubusercontent.com/cyph3rasi/synapsis/main/docker-compose.yml
curl -O https://raw.githubusercontent.com/cyph3rasi/synapsis/main/docker/Caddyfile
curl -O https://raw.githubusercontent.com/cyph3rasi/synapsis/main/.env.example
# 1. Clone the repository
git clone https://github.com/cyph3rasi/synapsis.git
cd synapsis
# 2. Configure environment
# 2. Install dependencies
npm install
# 3. Configure environment
cp .env.example .env
# Edit .env with your domain, database password, auth secret, etc.
# Edit .env with your local database and storage settings
# 3. Start your node
docker compose up -d
# 4. Set up the database
npx drizzle-kit push
# 5. Run the development server
npm run dev
```
Your node will be available at `https://your-domain.com` with automatic SSL.
Visit `http://localhost:3000` — the app will redirect you to `/install` for initial setup.
**Updating:**
```bash
docker compose pull && docker compose up -d
```
### Tech Stack
For detailed instructions, see [docker/README.md](docker/README.md).
### Documentation
For complete setup instructions, visit:
**📚 [docs.synapsis.social/run-your-own-node](https://docs.synapsis.social/run-your-own-node)**
- **Framework** — [Next.js 15+](https://nextjs.org/) (App Router)
- **Database** — PostgreSQL with [Drizzle ORM](https://orm.drizzle.team/)
- **Styling** — Tailwind CSS v4 & custom Vercel-like design system
- **Authentication** — Auth.js (NextAuth)
- **Type Safety** — TypeScript
---
## License
## 📜 License
Licensed under the **Apache 2.0 License**. See [LICENSE](LICENSE) for details.
---
<p align="center">
<strong>Run your node. Join the swarm. Own your social.</strong>
</p>