darmiel/yaxc
1
1
Fork 0
mirror of https://github.com/darmiel/yaxc.git synced 2024-09-20 06:46:13 +08:00
Code Issues Packages Projects Releases Wiki Activity
Yet Another Cross Clipboard
65 commits 2 branches 4 tags 782 KiB
Go 95.3%
Makefile 2.4%
Shell 1.2%
Dockerfile 1.1%
Go to file
darmiel 9f967de8a1 bump version
2021-05-13 19:10:41 +02:00
.github/workflows (Fixed) GitHub Actions 2021-04-05 12:09:42 +02:00
cmd bump version 2021-05-13 19:10:41 +02:00
internal Updated status codes, added swagger.yml 2021-05-13 19:01:22 +02:00
.gitignore Updated .gitignore 2021-05-10 15:44:47 +02:00
docker-compose.yml Re-Enable Janitor (Fixes #10) 2021-04-06 00:50:18 +02:00
Dockerfile Added docker-compose.yml 2021-04-05 12:37:33 +02:00
go.mod Implemented custom cache 2021-04-03 12:03:09 +02:00
go.sum Implemented custom cache 2021-04-03 12:03:09 +02:00
LICENSE cobra init 2021-03-22 13:40:09 +01:00
main.go Implemented encryption (#2) 2021-03-25 14:11:01 +01:00
Makefile Added Makefile 2021-04-06 00:50:35 +02:00
README.md Updated README.md 2021-05-10 16:02:38 +02:00
swagger.yml well 2021-05-13 19:07:30 +02:00

README.md

YAxC

Yet Another Cross Clipboard

Allan, please add details!

Demo

https://youtu.be/OVpH70byKRQ

alias yfll='yaxc force pull -a daniel-temp'
alias yfsh='yaxc force push -a daniel-temp'

CLI

Send Clipboard (one-time)

HELP

Usage:
  yaxc force push [flags]

Flags:
  -h, --help   help for push

Global Flags:
  -a, --anywhere string   Anywhere Path
  -b, --base64            Use Base64
      --config string     config file (default is $HOME/.yaxc.yaml)
  -S, --hide-secret       Hide Secret
  -U, --hide-url          Hide URL
  -s, --secret string     Encryption Key
      --server string     URL of API-Server (default "https://yaxc.d2a.io")

EXAMPLE

$ yaxc force push -a mypath [-s mypassword]
# INFO | Sent -> hello wor... -> /mypath
# INFO | 🔐 mypassword
# DBUG | URL: https://yaxc.d2a.io/mypath?secret=mypassword

Receive Data And Paste To Clipboard (one-time)

HELP

Usage:
  yaxc force pull [flags]

Flags:
  -h, --help   help for pull

Global Flags:
  -a, --anywhere string   Anywhere Path
  -b, --base64            Use Base64
      --config string     config file (default is $HOME/.yaxc.yaml)
  -S, --hide-secret       Hide Secret
  -U, --hide-url          Hide URL
  -s, --secret string     Encryption Key
      --server string     URL of API-Server (default "https://yaxc.d2a.io")

EXAMPLE

$ yaxc force pull -a mypath [-s mypassword]
# INFO | Read <- hello wor...

Receive Data And Output To Stdin (one-time)

HELP

Usage:
  yaxc get [flags]

Flags:
  -a, --anywhere string     Path (Anywhere)
  -h, --help                help for get
  -s, --passphrase string   Encryption Key

Global Flags:
      --config string   config file (default is $HOME/.yaxc.yaml)
      --server string   URL of API-Server (default "https://yaxc.d2a.io")

EXAMPLE

$ yaxc get -a mypath [-s mypassword]
# Hello world!

Watch Clipboard (Clipboard Sync)

HELP

Usage:
  yaxc watch [flags]

Flags:
  -a, --anywhere string     Path (Anywhere)
  -b, --base64              Use Base64?
  -h, --help                help for watch
      --ignore-client       Ignore Client Updates
      --ignore-server       Ignore Server Updates
  -s, --passphrase string   Encryption Key

Global Flags:
      --config string   config file (default is $HOME/.yaxc.yaml)
      --server string   URL of API-Server (default "https://yaxc.d2a.io")

EXAMPLE

$ yaxc watch -a mypath [-b -s mypassword]
# INFO | Starting Watchers:
# INFO | * Server -> Client
# INFO | * Server <- Client
# INFO | Started clipboard-watcher. Press CTRL-C to stop.
# UPDT | Server <- Hello Wor...

Host Your Own Server

HELP

Usage:
  yaxc serve [flags]

Flags:
  -b, --bind string                 Bind-Address (default ":1332")
  -t, --default-ttl duration        Default TTL (default 1m0s)
  -e, --enable-encryption           Enable Encryption (default true)
  -h, --help                        help for serve
  -x, --max-body-length int         Max Body Length (default 8192)
  -s, --max-ttl duration            Max TTL (default 1h0m0s)
  -l, --min-ttl duration            Min TTL (default 5s)
      --proxy-header string         Proxy Header
  -r, --redis-addr string           Redis Address
      --redis-db int                Redis Database
      --redis-pass string           Redis Password
      --redis-prefix-hash string    Redis Prefix (Hash) (default "yaxc::hash::")
      --redis-prefix-value string   Redis Prefix (Value) (default "yaxc::val::")

Global Flags:
      --config string   config file (default is $HOME/.yaxc.yaml)
      --server string   URL of API-Server (default "https://yaxc.d2a.io")

EXAMPLE

$ yaxc serve -b :80
# INFO | Started clipboard-server. Press CTRL-C to stop.

API

Set Data

Just make a POST request to any path:

POST /hi

Hello World!

TTL

By default, the data is kept for 5 minutes. This TTL can be changed via the ttl-parameter.

POST /hi?ttl=1m30s

Hello World!

Encryption

By default, the data is not encrypted. It is not recommended to encrypt the data on server side. The data should always be encrypted on the client side.

However, if this is not possible, the secret-parameter can be used to specify a password with which the data should be encrypted.

POST /hi?secret=s3cr3tp455w0rd

Hello World!

Produces:

gwttKS3Q2l0+YR+jQF/02u3fNVmMIcVOTNSGD5vWfrYTtH8adt8r

Get Data

GET /hi

Hello World!

Encryption

If the data has been encrypted and should be decrypted on the server side (which is not recommended), the "password" can be passed via the secret-parameter. GET /hi

gwttKS3Q2l0+YR+jQF/02u3fNVmMIcVOTNSGD5vWfrYTtH8adt8r

GET /hi?secret=s3cr3tp455w0rd

Hello World!