docs: add README.md
This commit is contained in:
parent
972575738d
commit
46060fb8e7
|
@ -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
|
Loading…
Reference in New Issue