Skip to content

Latest commit

 

History

History
172 lines (122 loc) · 4.36 KB

README.md

File metadata and controls

172 lines (122 loc) · 4.36 KB

🔧 PastePoint Server (Rust Backend)

The PastePoint server is a high-performance Rust-based backend built with Actix Web, providing WebSocket-based file sharing and communication services for local networks. Features comprehensive session management, WebRTC signaling, and secure file transfer capabilities.

Actix OpenSSL Rust

🛠️ Tech Stack

  • Framework: Actix Web - High-performance async web framework
  • WebSockets: Native Actix WebSocket support
  • Security: OpenSSL for TLS termination
  • Serialization: Serde for JSON handling
  • UUID: UUID generation for session management
  • Rate Limiting: Actix-governor for request throttling
  • Logging: Built-in logging with configurable levels

📁 Project Structure

server/
├── 📁 src/                        # Source code
├── 📁 config/                     # Configuration files
│   ├── development.toml           # Development configuration
│   ├── production.toml            # Production configuration
│   └── docker-dev.toml            # Docker development config
├── 📁 tests/                      # Tests
├── 📁 target/                     # Rust build artifacts
├── Cargo.toml                     # Project dependencies
├── Cargo.lock                     # Dependency lock file
├── Dockerfile                     # Docker configuration
└── README.md                      # Project documentation

🚀 Quick Start

Prerequisites

  • Rust: stable toolchain (specified in ../rust-toolchain)
  • OpenSSL: Required for SSL/TLS support
    • Linux: sudo apt-get install libssl-dev pkg-config
    • macOS: brew install openssl pkg-config
    • Windows: winget install OpenSSL

Development Setup

  1. Navigate to server directory:

    cd server

  2. Install dependencies:

    cargo build

  3. Run development server:

    cargo run

  4. Run with specific configuration:

    RUST_BUILD_MODE=debug cargo run

⚙️ Configuration

Configuration Files

  • config/development.toml: Development environment settings
  • config/production.toml: Production environment settings
  • config/docker-dev.toml: Docker development environment settings

🧪 Testing

Run all tests:

cargo test

Run specific test:

cargo test test_name

Run tests with output:

cargo test -- --nocapture

🔧 Development Guide

Code Quality

  • Formatting: cargo fmt
  • Linting: cargo clippy
  • Security audit: cargo audit

Development Commands

# Build for development
cargo build

# Build for production
cargo build --release

🔒 Security Features

  • TLS/SSL: Full SSL/TLS support with configurable certificates
  • Rate Limiting: Configurable request throttling with Actix-governor
  • CORS: Configurable Cross-Origin Resource Sharing
  • Input Validation: Comprehensive input validation and sanitization
  • Session Management: Secure UUID-based session handling
  • WebSocket Security: Secure WebSocket connections with proper authentication

🐛 Troubleshooting

Common Issues

  1. SSL Certificate Errors:

    # Generate self-signed certificates
../scripts/generate-certs.sh

  2. Port Already in Use:

    # Check what's using the port
lsof -i :9000
# Kill the process or change the port in config

  3. Permission Denied:

    # Ensure proper permissions for SSL certificates
sudo chown -R $USER:$USER /path/to/certs

  4. Build Issues:

    # Clean build artifacts
cargo clean
# Rebuild
cargo build

🤝 Contributing

📜 License

This project is licensed under the GPL-3.0 License. See the LICENSE file for details.

🔗 Related Documentation