Christopher
132 lines
4.2 KiB
Markdown
132 lines
4.2 KiB
Markdown
# 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 interoperable with the broader fediverse.
|
|
|
|
## Features
|
|
|
|
- **Federation Ready**: Built with ActivityPub compatibility in mind (WebFinger, NodeInfo).
|
|
- **Identity**: Portable identity system backed by user handles.
|
|
- **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.
|
|
|
|
## Tech Stack
|
|
|
|
- **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
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
|
|
- Node.js 18+
|
|
- A PostgreSQL database (e.g., [Neon](https://neon.tech))
|
|
|
|
### Installation
|
|
|
|
1. **Clone the repository**
|
|
```bash
|
|
git clone https://github.com/cyph3rasi/Synapsis.git
|
|
cd Synapsis
|
|
```
|
|
|
|
2. **Install dependencies**
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
3. **Configure Environment**
|
|
Copy the example environment file:
|
|
```bash
|
|
cp .env.example .env
|
|
```
|
|
|
|
Update `.env` with your credentials:
|
|
```env
|
|
# Database (PostgreSQL connection string)
|
|
DATABASE_URL="postgresql://user:password@host/dbname..."
|
|
|
|
# Auth (Generate with: openssl rand -base64 33)
|
|
AUTH_SECRET="your-secret-key"
|
|
|
|
# Node Configuration
|
|
NEXT_PUBLIC_NODE_DOMAIN="your-domain.com"
|
|
NEXT_PUBLIC_NODE_NAME="My Synapsis Node"
|
|
|
|
# Admin Access (Comma-separated emails)
|
|
ADMIN_EMAILS="admin@example.com,moderator@example.com"
|
|
```
|
|
|
|
4. **Initialize Database**
|
|
Push the schema to your database:
|
|
```bash
|
|
npm run db:push
|
|
```
|
|
|
|
5. **Start Development Server**
|
|
```bash
|
|
npm run dev
|
|
```
|
|
Visit `http://localhost:3000` to see your node.
|
|
|
|
### Initial Setup
|
|
|
|
1. Go to `http://localhost:3000` (or your deployed URL).
|
|
2. You will be redirected to the **Setup Wizard** (`/install`) if the node is not configured.
|
|
3. Follow the wizard to verify your environment and database connection.
|
|
4. **Register your first account**.
|
|
5. Add your email to `ADMIN_EMAILS` in your `.env` file to grant yourself admin privileges.
|
|
6. Restart the server (if running locally) to apply the admin changes.
|
|
|
|
## Deployment & Updates
|
|
|
|
### 1. Initial Deployment
|
|
|
|
The easiest way to deploy your own instance is with **Vercel**. Click the button below to clone the repository and deploy:
|
|
|
|
[](https://vercel.com/new/clone?repository-url=https://github.com/cyph3rasi/Synapsis)
|
|
|
|
During the setup process on Vercel:
|
|
1. **Repository Name**: Choose a name for your private copy (e.g., `my-node`).
|
|
2. **Environment Variables**: Add your `DATABASE_URL` and `AUTH_SECRET`.
|
|
- *Note: If you skip this, the build will succeed with a placeholder DB, but you must add them later in Project Settings -> Environment Variables and redeploy.*
|
|
|
|
### 2. Updating Your Instance
|
|
|
|
Since Vercel creates a **clone** (new copy) of the repository, you need to manually pull updates from the official source (`upstream`) to keep your node current.
|
|
|
|
**Setup (One-time):**
|
|
1. Clone your new repository to your local machine:
|
|
```bash
|
|
git clone https://github.com/YOUR_USERNAME/YOUR_REPO_NAME.git
|
|
cd YOUR_REPO_NAME
|
|
```
|
|
2. Add the official repository as a remote source:
|
|
```bash
|
|
git remote add upstream https://github.com/cyph3rasi/Synapsis.git
|
|
```
|
|
|
|
**To Update:**
|
|
Whenever a new version of Synapsis is released, run these commands globally to pull changes and deploy them to your instance:
|
|
|
|
```bash
|
|
# 1. Fetch latest changes from the official source
|
|
git fetch upstream
|
|
|
|
# 2. Merge changes into your main branch
|
|
git checkout main
|
|
git merge upstream/main
|
|
|
|
# 3. Push to your repository (Vercel will auto-deploy)
|
|
git push origin main
|
|
```
|
|
|
|
## License
|
|
|
|
Licensed under the **Apache 2.0 License**. See [LICENSE](LICENSE) for details.
|