<img src="https://github.com/user-attachments/assets/710bb1c3-0eda-48cf-819a-e066bde3a3ec" alt="ClipCascade Logo" width="34" /> ClipCascade

ClipCascade is a lightweight, open-source utility that automatically syncs your clipboard across multiple devices—no manual input required. It ensures seamless sharing with robust end-to-end encryption, providing a secure and reliable clipboard experience across workstations.

No Server? No Problem! Instantly sync your clipboard using the Live Community Server at clipcascade.sathvik.dev—no setup needed. Just create an account and start sharing your clipboard across devices in seconds!

<div align="center"> <table> <tr> <th>Docker</th> <th>Windows</th> <th>macOS</th> <th>Android</th> <th>Linux</th> </tr> <tr> <td> <a href="https://hub.docker.com/r/sathvikrao/clipcascade"> <img src="https://www.docker.com/wp-content/uploads/2022/03/Moby-logo.png" alt="Docker" width="50" /> </a> </td> <td> <a href="https://github.com/Sathvik-Rao/ClipCascade/releases"> <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/5/5f/Windows_logo_-_2012.svg/512px-Windows_logo_-_2012.svg.png" alt="Windows" width="50" /> </a> </td> <td> <a href="https://github.com/Sathvik-Rao/ClipCascade/releases"> <img src="https://upload.wikimedia.org/wikipedia/commons/1/1b/Apple_logo_grey.svg" alt="macOS" width="40" /> </a> </td> <td> <a href="https://github.com/Sathvik-Rao/ClipCascade/releases"> <img src="https://upload.wikimedia.org/wikipedia/commons/d/d7/Android_robot.svg" alt="Android" width="40" /> </a> </td> <td> <a href="https://github.com/Sathvik-Rao/ClipCascade/releases"> <img src="https://upload.wikimedia.org/wikipedia/commons/3/35/Tux.svg" alt="Linux" width="40" /> </a> </td> </tr> </table> </div> <br /> <div align="center"> <img src="https://github.com/user-attachments/assets/0b7178fd-e40f-400c-9c6f-6ea9f4e5b800" alt="arch_design_p2s" width="360" height="300" /> <img src="https://github.com/user-attachments/assets/32366820-fc48-4849-914f-fe0474fa308a" alt="arch_design_p2p" width="360" height="300" /> </div>

📸 Screenshots

| 🪟 Desktop (Windows) | 🍏 Desktop (macOS) | 🤖📱 Mobile (Android) | 🐧🖱️ Desktop (Linux_GUI) | 🐧⌨️ Desktop (Linux_CLI) | |-----------------------|--------------------|--------------------|--------------------|--------------------| | <img src="https://github.com/user-attachments/assets/369d5db5-685c-4284-946d-b6a0e1f4fef9" alt="Desktop (Windows) - 1" width="360" /> | <img src="https://github.com/user-attachments/assets/2c0a7f4d-652c-4f4c-97e9-ee9b9d66f03f" alt="Desktop (macOS) - 1" width="360" /> | <img src="https://github.com/user-attachments/assets/a5606f3c-6d8a-434f-8f1d-03d6276e03c0" alt="Mobile (Android) - 1" width="360" /> | <img src="https://github.com/user-attachments/assets/f1acd9f4-27ee-4eb0-8696-a786a21551ed" alt="Desktop (Linux_GUI) - 1" width="360" /> | <img src="https://github.com/user-attachments/assets/f3f7c3a9-0299-4f0d-9494-5d9a102a243f" alt="Desktop (Linux_CLI) - 1" width="360" /> | | <img src="https://github.com/user-attachments/assets/3d51539b-69d0-4b0d-8854-e262638333bd" alt="Desktop (Windows) - 2" width="240" /> | <img src="https://github.com/user-attachments/assets/3d473d8d-601e-4c78-bb7f-0684d39aef67" alt="Desktop (macOS) - 2" width="240" /> | <img src="https://github.com/user-attachments/assets/607135ff-498f-45ae-b60e-18da525b6b19" alt="Mobile (Android) - 2" width="240" /> | <img src="https://github.com/user-attachments/assets/394ab014-ae40-475d-8109-d95c9a69645b" alt="Desktop (Linux_GUI) - 2" width="240" /> | <img src="https://github.com/user-attachments/assets/daf0a4ac-4dcc-4547-9171-7bb0546f6712" alt="Desktop (Linux_non_GUI) - 2" width="240" /> |

✨ Features

• 🚀 Instant Clipboard Sync – Clipboard content updates in real time across all connected devices. Just copy, and it’s there!
• 🔒 Secure Authentication – Ensures only authorized users can sync clipboard data.
• 🛡️ End-to-End Encryption – Protects clipboard content with advanced cryptographic security and hashing techniques.
• 🔄 Dual Sync Modes:
  • ☁️ Server-Based Sync – Reliable cloud-based synchronization via a centralized server.
  • 🔗 Peer-to-Peer Sync – Direct device-to-device connection for ultra-low latency and minimal server dependency.
• 💻 Cross-Platform Compatibility – Works seamlessly on Windows, macOS, Linux, and Android.
• 📄📷📁 Universal Clipboard – Syncs text, images, and files effortlessly across devices.
• 📦 Self-Hosting Option – Deploy your own secure instance using a Docker image or standalone JAR file.
• 👥 Multi-User Support – Isolates clipboard data per user while enabling seamless syncing between personal devices.
• 🌐 Web-Based Dashboard – Track clipboard activity and manage settings through an intuitive interface.
• ⚙️ Customizable Preferences – Fine-tune sync settings for performance, security, and usability.
• 🔔 Smart Update Notifications – Stay informed about new features, security patches, and enhancements.

<div align="center"> <table> <tr> <th>Type</th> <th>Windows</th> <th>MacOS</th> <th>Linux GUI</th> <th>Linux CLI</th> <th>Android</th> </tr> <tr> <td><strong>Text</strong></td> <td>✔</td> <td>✔</td> <td>✔</td> <td>✔</td> <td>✔</td> </tr> <tr> <td><strong>Image</strong></td> <td>✔</td> <td>✔</td> <td>✔</td> <td>✔</td> <td>✔</td> </tr> <tr> <td><strong>Files</strong></td> <td>✔</td> <td>✔</td> <td>✔</td> <td>✔</td> <td>✔</td> </tr> </table> </div>

📥 Installation Guide

🦾 Self-Hosting ClipCascade on Bare Metal:

To deploy the ClipCascade server on any operating system that supports Java 21 or later, follow the steps outlined below.

1. Download the Server JAR File

   Obtain the latest release of ClipCascade-Server-JRE_21.jar from the release page.

2. Configure Environment Variables (Optional)

   The ClipCascade server supports various environment variables for customization. None of these variables are mandatory, but they can be configured as needed.

   For a comprehensive list of available environment variables, refer to the Advanced Details section.

   | Variable | Description | Default Value | Example | |------------------------------|------------------------------------------------------------------------------------------------------|-------------------|-----------------------------------| | CC_MAX_MESSAGE_SIZE_IN_MiB | Defines the maximum allowed message size in MiB. Ignored if CC_P2P_ENABLED is set to true. | 1 | 3 | | CC_ALLOWED_ORIGINS | Specifies the allowed CORS origins for secure cross-origin access. | * | https://clipcascade.example.com | | CC_P2P_ENABLED | Enables or disables peer-to-peer mode. When enabled, CC_MAX_MESSAGE_SIZE_IN_MiB is ignored. | false | true | | CC_SIGNUP_ENABLED | Allows or restricts user self-registration. | false | false | | CC_PORT | Specifies the port on which the server listens for incoming connections. | 8080 | 1234 |

3. Start the Server
   Run the following command in the terminal to launch the ClipCascade server:

   java -jar ClipCascade-Server-JRE_21.jar
   

4. Access the Server
   Once the server is running, you can access it via:

   http://localhost:8080
   

   • Default Credentials:
     • Username: admin
     • Password: admin123

Important: It is strongly recommended to change the default credentials immediately after the initial login.

For guidance on setting up a reverse proxy, refer to the Reverse Proxy Setup section.

➡️ Explore Advanced Details

---

🐳 Self-Hosting ClipCascade Using Docker:

Quick Installation (Single Command)

For users who prefer a one-liner, you can deploy ClipCascade instantly using:

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

Detailed Installation Steps

To host ClipCascade on your server using Docker, follow these steps:

1. Create a docker-compose.yml File

   Create a docker-compose.yml file with the following content, or download it from the [release page](http