jmug/ccclip
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README

Browse source
This commit is contained in:
Mariano Uvalle 2023-11-10 18:08:38 +00:00
parent c91fc40f99
commit f45e1129c7
1 changed files with 18 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -3,13 +3,27 @@ End to end encrypted cloud clipboard.
# Installation # Installation
Download the prebuilt latest release binary for your OS/arch and ensure that it's in your path. Download the prebuilt latest release binary for your OS/arch and ensure that it's in your PATH.
I just do `sudo mv ccclip /usr/local/bin` for either MacOS or Linux.
# Configuration # Configuration
By default, ccclip looks for a ccclip directory in the [user home directory](https://pkg.go.dev/os#UserHomeDir) and it'll store the configuration file and device keys there. By default, ccclip looks for a ccclip directory in the [user home directory](https://pkg.go.dev/os#UserHomeDir) and it'll store the configuration file and device keys there.
You don't need to do anything if you want to stores your config in the default location; to override this behavior, use the `--config-dir` global flag. You don't need to do anything if you want to stores your config in the default location; to override this behavior, use the `--config-dir` global flag.
If you're onboarding a new device (with an already created account) then you should pre-populate your config file (ccclip.yaml in your config dir) to look like this:
```json
{"Email":"{your-email}","DeviceId":""}
```
Yes, I know, the extension is yaml but the file has JSON. I'll change it, don't worry.
It's also a good idea to creat an alias for the command, here's what I do in my `.zshrc`:
```
alias ccc="ccclip"
```
`ccc` is very fun to type, but choose whatever alias make you happy.
# Instructions # Instructions
### Create an account with ### Create an account with
@ -23,7 +37,7 @@ Passwords are stored as bcrypt hashes in the server.
### Register your device ### Register your device
```bash ```bash
ccclip register. ccclip register-device
``` ```
This will prompt you for your password. This will prompt you for your password.
An [X25519](https://pkg.go.dev/crypto/ecdh) key pair is created and stored in your configuration directory. An [X25519](https://pkg.go.dev/crypto/ecdh) key pair is created and stored in your configuration directory.
@ -39,3 +53,5 @@ There's a caveat: When a clipboard is created, the sending device encrypts the d
individually. This means that if you register a new device, it won't immediately have access to the current clipboard because individually. This means that if you register a new device, it won't immediately have access to the current clipboard because
its public key wasn't available when the clipboard was created. The benefit of this is that your data is end-to-end encrypted and I'll never its public key wasn't available when the clipboard was created. The benefit of this is that your data is end-to-end encrypted and I'll never
be able to see it nor an attacker if we're compromised :) be able to see it nor an attacker if we're compromised :)
If you want your new device to have access to the current clipboard contents then just run `ccclip | ccclip` from an onboarded device.