Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ramborogers/cyberchat
CyberChat - P2P Zero Config Chat and Files
https://github.com/ramborogers/cyberchat
chat golang mdns p2p security
Last synced: about 22 hours ago
JSON representation
CyberChat - P2P Zero Config Chat and Files
- Host: GitHub
- URL: https://github.com/ramborogers/cyberchat
- Owner: RamboRogers
- License: gpl-3.0
- Created: 2025-01-22T02:34:29.000Z (6 days ago)
- Default Branch: master
- Last Pushed: 2025-01-27T01:02:42.000Z (1 day ago)
- Last Synced: 2025-01-27T01:30:05.765Z (1 day ago)
- Topics: chat, golang, mdns, p2p, security
- Language: Go
- Homepage: https://matthewrogers.org
- Size: 47.6 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CyberChat 🌐
[](https://golang.org)
[](LICENSE)
[](https://github.com/ramborogers/cyberchat/releases)
[](https://github.com/ramborogers/cyberchat#-key-features)
A secure, peer-to-peer chat application with end-to-end encryption, featuring a cyberpunk-themed UI and zero-configuration networking.
### When you would use cyberchat:
- You want instant communication with friends/family without configuring anything
- You want to talk to Linux / Windows / Mac machines without configuring anything
- You want to share files with friends without the internet
- You want to chat with friends without the internet
### CyberChat Screenshots
## ✨ Key Features
🔒 Security
• End-to-end encryption
• Perfect forward secrecy
• Certificate-based security
• 1 click wipe
• No internet required
🌐 Networking
• Zero configuration
• Peer-to-peer via mDNS
• Direct message routing
• No central server
• Offline support
📱 Interface
• Desktop app
• Web interface
• Cyberpunk theme
• Real-time updates
📁 Files
• Encrypted transfers
• Unlimited file size
• Media previews
• Auto cleanup
• Resume support
📢 Social
• Broadcast messages
• Private messages
⚡ Performance
• Low resource usage
• Quick startup
• State recovery
## ⚡ Installation
The binary is available for Windows, Mac, and Linux. You can download from the bins folder, or use the install scripts. They are in the repo if you want to browse the commands (super simple download and copy).
---
### 🐧 Mac & Linux & Windows (Desktop App)
For a desktop app, download a release from the [releases page](https://github.com/RamboRogers/cyberchat/releases).
🍏 Homebrew Install for Apple Desktop App
```
brew tap ramborogers/cyberchat
brew install --cask cyberchat-desktop
```
> Apple doesn't like self signed apps. I've applied for a developer account, but it takes a while to get approved. Use brew to install the desktop app or you can use xattr to remove the quarantine attribute.
---
### 🐧 Mac & Linux & Windows (Single Binary + Web Interface)
For a single binary, you can use the install scripts and your web browser.
Open a terminal and run the following command:
```bash
curl -L https://raw.githubusercontent.com/RamboRogers/cyberchat/refs/heads/master/install.sh | sh
```
or Brew for Mac
```bash
brew tap ramborogers/cyberchat
brew install cyberchat
```
### 🪟 Windows PowerShell
Open a PowerShell terminal and run the following command:
```powershell
iwr -useb https://raw.githubusercontent.com/RamboRogers/cyberchat/refs/heads/master/install.ps1 | iex
```
## 🚀 Quick Start
The cyberchat binary has a number of options. You can run the server directly, or run the desktop electron app.
```bash
Usage of cyberchat
-d string
Custom home directory for CyberChat data
-debug
Enable debug logging
-n string
Name to use for this peer
-p int
Port to listen on (default 7331)
-r Reset all data and start fresh
-v Show version information
```
Then access the web interface at `https://localhost:7331`
## 🔧 Prerequisites
- Go 1.22 or later
- Node.js and npm
- GCC for CGO compilation
- Platform-specific requirements:
- **Windows**: MinGW
- **Linux**: build-essential
- **macOS**: Xcode CLI tools
## 🏗️ Architecture
### Security Model
- RSA key pairs for peer identity
- AES-256 message encryption
- Trust levels (0-4) for peers
- Certificate-based transport security
### Core Components
- **Server** (Default port: 7331)
- SQLite persistence
- Gorilla Mux routing
- WebSocket support
- Auto-port increment
- **Database Schema**
```
settings - Configuration
peers - Network members
messages - 30-day retention
files - Transfer tracking
relays - Message routing
```
- **API Endpoints**
```
/api/v1/message - Message handling
/api/v1/file - File operations
/api/v1/whoami - Identity management
/api/v1/discovery - Peer discovery
/api/v1/client - Web client API
```
## 🤝 Contributing
1. Fork the repository
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
## 📝 License
This project is licensed under the GNU GPL v3.0 License - see the [LICENSE](LICENSE) file for details.
## 🛡️ Security
Please report security vulnerabilities to the issue tracker.
## 🙏 Acknowledgments
- The Go team for an amazing language
- The Electron project for cross-platform support
- The cyberpunk community for design inspiration
---
## ⚖️ License
CyberDock is licensed under the GNU General Public License v3.0 (GPLv3).
Free Software
[](https://www.gnu.org/licenses/gpl-3.0)
### Connect With Me 🤝
[](https://github.com/RamboRogers)
[](https://x.com/rogerscissp)
[](https://matthewrogers.org)