ref: add nice readme to backend
This commit is contained in:
parent
93c55df649
commit
f5118557d9
@ -1,11 +1,11 @@
|
|||||||
# Handy Server - Development Guidelines
|
# Handy Server - Development Guidelines
|
||||||
|
|
||||||
This document contains the development guidelines and instructions for the Handy Server project. This guide OVERRIDES any default behaviors and MUST be followed exactly.
|
This document contains the development guidelines and instructions for the Happy Server project. This guide OVERRIDES any default behaviors and MUST be followed exactly.
|
||||||
|
|
||||||
## Project Overview
|
## Project Overview
|
||||||
|
|
||||||
**Name**: handy-server
|
**Name**: happy-server
|
||||||
**Repository**: https://github.com/ex3ndr/handy-server.git
|
**Repository**: https://github.com/slopus/happy-server.git
|
||||||
**License**: MIT
|
**License**: MIT
|
||||||
**Language**: TypeScript
|
**Language**: TypeScript
|
||||||
**Runtime**: Node.js 20
|
**Runtime**: Node.js 20
|
||||||
|
33
README.md
Normal file
33
README.md
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
# Happy Server
|
||||||
|
|
||||||
|
Minimal backend for open-source end-to-end encrypted Claude Code clients.
|
||||||
|
|
||||||
|
## What is Happy?
|
||||||
|
|
||||||
|
Happy Server is the synchronization backbone for secure Claude Code clients. It enables multiple devices to share encrypted conversations while maintaining complete privacy - the server never sees your messages, only encrypted blobs it cannot read.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- 🔐 **Zero Knowledge** - The server stores encrypted data but has no ability to decrypt it
|
||||||
|
- 🎯 **Minimal Surface** - Only essential features for secure sync, nothing more
|
||||||
|
- 🕵️ **Privacy First** - No analytics, no tracking, no data mining
|
||||||
|
- 📖 **Open Source** - Transparent implementation you can audit and self-host
|
||||||
|
- 🔑 **Cryptographic Auth** - No passwords stored, only public key signatures
|
||||||
|
- ⚡ **Real-time Sync** - WebSocket-based synchronization across all your devices
|
||||||
|
- 📱 **Multi-device** - Seamless session management across phones, tablets, and computers
|
||||||
|
- 🔔 **Push Notifications** - Notify when Claude Code finishes tasks or needs permissions (encrypted, we can't see the content)
|
||||||
|
- 🌐 **Distributed Ready** - Built to scale horizontally when needed
|
||||||
|
|
||||||
|
## How It Works
|
||||||
|
|
||||||
|
Your Claude Code clients generate encryption keys locally and use Happy Server as a secure relay. Messages are end-to-end encrypted before leaving your device. The server's job is simple: store encrypted blobs and sync them between your devices in real-time.
|
||||||
|
|
||||||
|
## Hosting
|
||||||
|
|
||||||
|
**You don't need to self-host!** Our free cloud Happy Server at `happy-api.slopus.com` is just as secure as running your own. Since all data is end-to-end encrypted before it reaches our servers, we literally cannot read your messages even if we wanted to. The encryption happens on your device, and only you have the keys.
|
||||||
|
|
||||||
|
That said, Happy Server is open source and self-hostable if you prefer running your own infrastructure. The security model is identical whether you use our servers or your own.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
MIT - Use it, modify it, deploy it anywhere.
|
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "handy-server",
|
"name": "happy-server",
|
||||||
"version": "0.0.0",
|
"version": "0.0.0",
|
||||||
"repository": "https://github.com/ex3ndr/handy-server.git",
|
"repository": "https://github.com/slopus/happy-server.git",
|
||||||
"author": "Steve Korshakov <steve@korshakov.com>",
|
"author": "Steve Korshakov <steve@korshakov.com>",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"private": true,
|
"private": true,
|
||||||
|
Loading…
Reference in New Issue
Block a user