sathvikrao/clipcascade repository overview

⁠ ClipCascade

ClipCascade is an open-source, lightweight utility that automatically syncs your clipboard across multiple devices—no key press required. It ensures seamless clipboard sharing between devices, prioritizing privacy with end-to-end encryption. Whether you're moving between workstations or simply want the convenience of a unified clipboard, ClipCascade has you covered.

Github	Windows	macOS	Android	Linux
⁠	⁠	⁠	⁠	⁠

⁠📥 Installation

⁠Self-Hosting with Docker

You can host ClipCascade on your server using Docker with either docker-compose or a simple docker run command.

⁠Option 1: Using Docker Compose

• Create a docker-compose.yml file with the following content:

# 🔑 Default admin credentials:
#       Username: admin
#       Password: admin123
# ⚠️ IMPORTANT: Ensure that the default admin credentials are changed immediately after the first login.

services:
  clipcascade:
    image: sathvikrao/clipcascade:latest
    ports:
      - "8080:8080" 
    restart: always 
    volumes:
      - ./cc_users:/database  # Persistent storage for user data
    environment:
      - CC_MAX_MESSAGE_SIZE_IN_MiB=1   # Maximum message size in MiB (ignored if P2P mode is enabled)
      - CC_P2P_ENABLED=false  # Enables or disables peer-to-peer(P2P) mode
      # - CC_ALLOWED_ORIGINS=https://clipcascade.example.com  # Defines allowed CORS origins for security
      # - CC_SIGNUP_ENABLED=false  # Enables or disables user self-registration

• Run the Docker container using Docker Compose:

docker-compose up -d

• Access the web-based monitoring page at http://localhost:8080. Upon first login, update the default credentials (admin / admin123) for security.

⁠Option 2: Using Docker Run

• If you prefer to run the container directly without Docker Compose, use the following command:

docker run -d \
  --name clipcascade \
  -p 8080:8080 \
  -e CC_MAX_MESSAGE_SIZE_IN_MiB=1 \
  -v ./cc_users:/database \
  sathvikrao/clipcascade

• This will start the ClipCascade container and make it accessible at http://localhost:8080. Upon first login, update the default credentials (admin / admin123) for security.