docs: add README.md

This commit is contained in:
knoflook 2021-11-01 18:37:13 +01:00
parent 972575738d
commit 46060fb8e7
Signed by: knoflook
GPG Key ID: D6A1D0E8FC4FEF1C
1 changed files with 30 additions and 0 deletions

30
README.md Normal file
View File

@ -0,0 +1,30 @@
# croc
Easily and securely send things from one computer to another
<!-- metadata -->
- **Category**: Utilities
- **Status**: ❶💚
- **Image**: [`croc`](https://hub.docker.com/r/schollz/croc),❶💚, upstream
- **Healthcheck**: No
- **Backups**: No
- **Email**: No
- **Tests**: No
- **SSO**: No
<!-- endmetadata -->
## Basic usage
1. Set up Docker Swarm and [`abra`]
2. `abra app new croc`
3. `abra app secret generate -a <croc app name>` - this will generate server password
4. `abra app deploy <croc app name>`
done!
now you can use croc. Remember to put your password when sending/receiving files!
`croc --pass SERVER_PASSWORD --relay "server.address:9009" send [filename]` to send
`croc --pass SERVER_PASSWORD --relay "server.address:9009"` to receive
[`abra`]: https://git.coopcloud.tech/coop-cloud/abra