github.com/jonnyan404/cloud-clipboard-go

cloud-clipboard-go

A Go remake based on the TransparentLC/cloud-clipboard project.

Added some features based on yurenchen000/cloud-clipboard.

Screenshots

Desktop

Mobile

Usage

This is the Go version of the server.

Easy Run (UI Launcher, Recommended for Beginners)

Click to view preview

Go to UI Launcher Releases, download, and double-click to use.

Run with Docker

# Docker Hub Image (choose one)
docker run -d --name=cloud-clipboard-go -p 9501:9501 -v /path/your/dir/data:/app/server-node/data jonnyan404/cloud-clipboard-go
# GitHub Container Registry Image (choose one)
docker run -d --name=cloud-clipboard-go -p 9501:9501 -v /path/your/dir/data:/app/server-node/data ghcr.io/jonnyan404/cloud-clipboard-go

• vi docker-compose.yml

services:
    cloud-clipboard-go:
        container_name: cloud-clipboard-go
        restart: always
        ports:
            - "9501:9501"
        environment:
            - LISTEN_IP= # Default is 0.0.0.0, can be set to 127.0.0.1. Don't change if unsure.
            - LISTEN_IP6= # Default is empty, can be set to ::. Don't change if unsure.
            - LISTEN_PORT= # Default is 9501, can be set to other ports.
            - PREFIX= # Subpath, can be used with nginx, format: /cloud-clipboard
            - MESSAGE_NUM= # Number of history records, default is 10.
            - AUTH_PASSWORD= # Access password, default is false, can be a custom string password.
            - TEXT_LIMIT= # Text length limit, default is 4096 (2048 Chinese characters).
            - FILE_EXPIRE= # File expiration time, default is 3600 (1 hour), unit is seconds.
            - FILE_LIMIT= # File size limit, default is 104857600 (100MB), unit is bytes.
            - MKCERT_DOMAIN_OR_IP= # The domain name or IP address for mkcert, defaults to empty. You can set it to other domain names or IPs. Multiple values can be separated by spaces. Wildcards are supported for domain names only.
            - MANUAL_KEY_PATH= # Manually set the path for the key. Defaults to empty. This parameter has higher priority than MKCERT_DOMAIN_OR_IP.
            - MANUAL_CERT_PATH= # Manually set the path for the certificate. Defaults to empty. This parameter has higher priority than MKCERT_DOMAIN_OR_IP.
        volumes:
            - /path/your/dir/data:/app/server-node/data # Please change to your own directory
        image: jonnyan404/cloud-clipboard-go:latest # Or ghcr.io/jonnyan404/cloud-clipboard-go:latest

• Access homepage: http://127.0.0.1:9501
• Accessing http://127.0.0.1:9501/content/latest will always return the latest content. You can add the room parameter ?room=xxx.

Run with Homebrew

Known Issue: brew services tab completion doesn't work. Reference: https://github.com/orgs/Homebrew/discussions/6047#discussioncomment-12668536

Default configuration files are located in the etc/cloud-clipboard-go and var directories under the homebrew root directory.

brew update
# Install
brew install Jonnyan404/tap/cloud-clipboard-go
# Start the service
brew services start cloud-clipboard-go
# Check service status
brew services info cloud-clipboard-go
# Stop the service
brew services stop cloud-clipboard-go
# Restart the service
brew services restart cloud-clipboard-go

Run on OpenWrt

✅ Tested on OpenWrt 24.10.0

Check your architecture with: opkg print-architecture (the second column of the last line)

Go to the pre-release section of https://github.com/Jonnyan404/cloud-clipboard-go/releases and download the *platform.ipk file corresponding to your system and the *_all.ipk file.

Then execute the following commands in the terminal:

opkg install *platform.ipk
opkg install *_all.ipk

Click to preview LuCI interface

Run with Binary File

Go to the project Releases, download the file corresponding to your system, and run it.

Parameter priority: Command-line arguments > Configuration file

• Command-line argument: -host to customize the server listening address.
• Command-line argument: -port to customize the server listening port.
• Command-line argument: -auth to customize the password.
• Command-line argument: -config to load a custom configuration file.
• Command-line argument: -static to load custom external frontend files.

Run from Source Code

• Requires Node.js>=22.12.
• Requires Go>=1.22.

# Build frontend
cd client
npm install
npm run build

# Run backend
cd ../cloud-clip
go mod tidy
go run -tags embed .

Configuration File Description

• Please see: https://github.com/Jonnyan404/cloud-clipboard-go/blob/main/cloud-clip/config.md

HTTP API

• Please see: https://github.com/Jonnyan404/cloud-clipboard-go/blob/main/cloud-clip/config.md

Derivative Projects

• A launcher made for cloud-clipboard-go, convenient for users who don't want to or can't use the terminal: cloud-clipboard-go-launcher