darmiel/yaxc
1
1
Fork 0
mirror of https://github.com/darmiel/yaxc.git synced 2024-11-15 12:25:19 +08:00
Code Issues Projects Releases Packages Wiki Activity
Yet Another Cross Clipboard
13 commits 2 branches 4 tags 782 KiB
Go 95.3%
Makefile 2.4%
Shell 1.2%
Dockerfile 1.1%
Find a file
darmiel 8633f5d380 Merge remote-tracking branch 'origin/main' into main
2021-03-26 11:00:39 +01:00
cmd Implemented GET hash for redis (cache is currently fucked up) 2021-03-26 11:00:31 +01:00
internal Implemented GET hash for redis (cache is currently fucked up) 2021-03-26 11:00:31 +01:00
.gitignore Added .gitignore 2021-03-22 13:24:10 +01:00
go.mod Implemented redis backend 2021-03-24 16:33:28 +01:00
go.sum Implemented redis backend 2021-03-24 16:33:28 +01: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
README.md Updated README.md 2021-03-25 14:18:42 +01:00

README.md

YAxC

Yet Another Cross Clipboard

Allan, please add details!

Server

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!

CLI

Run the YAxC server

Usage:
  yaxc serve [flags]

Flags:
  -b, --bind string            Bind-Address (default ":1332")
  -t, --default-ttl duration   Default TTL (default 1m0s)
  -h, --help                   help for serve
  -x, --max-body-length int    Max Body Length (default 1024)
  -s, --max-ttl duration       Max TTL (default 5m0s)
  -l, --min-ttl duration       Min TTL (default 5s)
  -r, --redis-addr string      Redis Address
      --redis-db int           Redis Database
      --redis-pass string      Redis Password
      --redis-prefix string    Redis Prefix (default "yaxc::")

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