bluep 0.4.5

A minimal real-time collaborative text editor

bluep

A secure real-time collaborative text editor with TOTP authentication and a blue theme. Multiple users can connect and edit text simultaneously through their browsers.

Quick Start

# Clone the repository
git clone https://github.com/glassontin/bluep.git
cd bluep

# Run the setup script
python setup.py

Features

• Two-factor authentication using TOTP
• Real-time text synchronization across clients
• Secure WebSocket communication over HTTPS
• Session management with replay attack prevention
• Machine-specific encryption for TOTP secrets
• Cross-platform configuration storage
• Auto-discovery of local IP address
• Blue minimalist interface

Requirements

• Python 3.7+
• OpenSSL for certificate generation

Installation

git clone https://github.com/glassontin/bluep.git
cd bluep
pip install .

Configuration

1. Generate self-signed SSL certificates:

openssl req -x509 -newkey rsa:4096 -nodes -keyout key.pem -out cert.pem -days 365

2. Visit the setup page to configure TOTP:

https://<your-local-ip>:8500/setup

• Scan the QR code with your authenticator app
• Save the secret key as backup

Usage

1. Start the server:

bluep

2. Access the editor:

https://<your-local-ip>:8500

3. Enter your TOTP code to join the editing session

Security Features

• TOTP-based access control
• Rate limiting for failed authentication attempts
• Secure session management
• HTTPS/WSS encryption
• HTTP-only secure cookies
• Machine-bound configuration encryption

Dependencies

• FastAPI
• uvicorn
• Pillow
• websockets
• pyotp
• qrcode
• cryptography
• pydantic
• jinja2

Running as a System Service

On Linux systems with systemd, you can install bluep as a system service:

# Install the service (requires sudo)
sudo python install_service.py

# Start the service
sudo systemctl start bluep

# Enable service to start on boot
sudo systemctl enable bluep

# Check service status
sudo systemctl status bluep

# View logs
sudo journalctl -u bluep

The service will run with reduced privileges and several security measures enabled:

• Private /tmp directory
• Read-only access to /home
• Protected system directories
• No new privileges
• No kernel module or tunable access
• No device access

You can customize the user the service runs as:

sudo python install_service.py --user your_username

License

MIT License

Copyright (c) 2024 glassontin