Carperis/clipboard-online

Share content between 💻Windows and 📱iOS

clipboard-online

clipboard-online is an application to share cilpboard text between Windows and iOS

Documentation

【中文】【English】

Download

1. Directly download

   You can download latest release exe from here

2. From source code(only windows now)

   Before you build, make sure you have installed golang. If not, maybe you need this

   • git clone git@github.com:YanxinTang/clipboard-online.git
   • cd clipboard-online
   • go get github.com/akavel/rsrc
   • Build
     • Bash: ./build.sh
     • PowerShell：.\build.ps1
   • You can find release bin at release directory

Usage

1. Run clipboard-online on your windows
2. Setup shortcuts on you iPhone/iPad (Open link from safari)
   • Copy:
     • iCloud: https://www.icloud.com/shortcuts/f463a1e431c94c60b8a5c65305eb819f
     • 
   • Paste:
     • iCloud: https://www.icloud.com/shortcuts/11cf614a6a2842f38d14a6796642ef71
     • 
3. Set ip address and authkey (default is empty string)
4. Have fun...😊

Configuration

clipboard-online.exe will create two file which are config.json and log.txt in the execute path when first running

You can make customization by editing config.json

config.json

• port

  • type: string
  • default: "8086"

• logLevel

  • type: string
  • default: "warning"
  • values: "panic", "fatal", "error", "warning", "info", "debug", "trace"

• authkey

  • type: string
  • default: ''

• authkeyExpiredTimeout

  • type: int64
  • default: 30

• tempDir

  • type: string
  • default: ./temp

• reserveHistory

  • type: Boolean
  • default: false

• notify

  • type: object
  • children:
    • copy
      • type: Bollean
      • default: false
    • paste
      • type: Boolean
      • default: false

API

The default http server will listen 8086 port and you can't chanage that since hardcoded.

Common headers

Required

• X-API-Version: indicates version of api

Optional

• X-Client-Name: indicates name of device
• X-Auth: hashed authkey. Value from md5(config.authkey + timestamp/30)

1. Get windows clipboard

Request

• URL: /
• Method: GET

Reponse

• Body: json

// 200 ok

{
  "type": "text",
  "data": "clipboard text on the server"
}

{
  "type": "file",
  "data": [
    {
      "name": "filename",
      "content": "base64 string of file bytes"
    }
    ...
  ]
}

2. Set windows clipboard

Request

• URL: /

• Method: POST

• Headers:

  • X-Content-Type: indicates type of request body content
    • required
    • values: text, file, media

• Body: json

For text:

{
  "data": "text you want to set"
}

For file:

{
  "data": [
    {
      "name": "filename",
      "base64": "base64 string of file bytes"
    }
  ]
}

Reponse

Reponse body is empty. If set successfully, status code will be 200