This repository has been archived on 2021-07-08. You can view files and clone it, but cannot push or open issues or pull requests.
opensend/README.md

49 lines
1.4 KiB
Markdown
Raw Normal View History

2020-12-03 10:55:46 +00:00
# OpenSend
## Send files between systems quickly and securely
### Usage
#### Receiver
2020-12-03 10:58:38 +00:00
- Use `opensend -r` to start the receiver
2020-12-03 10:55:46 +00:00
#### Sender
2020-12-03 10:58:38 +00:00
- Use `opensend -s -t <type> -d <data>`
2020-12-06 00:58:19 +00:00
- `type` can be
- `url`
- `file`
- `dir`
- `data` can be
- A website URL
- A file path
- A directory path
- Example: `opensend -s -t url -d "https://google.com"`
2020-12-05 08:27:50 +00:00
- Example: `opensend -s -t file -d ~/file.txt`
2020-12-06 00:58:19 +00:00
- Example: `opensend -s -t dir -d /home/user`
2020-12-03 10:55:46 +00:00
### Building
2020-12-03 10:58:38 +00:00
- This project uses go modules, so building is easy
- First, go 1.14+ must be installed (use buster-backports on debian)
- Then, run `make` inside the project's directory.
2020-12-03 10:58:38 +00:00
- This will get the dependencies and compile all the files.
2020-12-03 10:55:46 +00:00
### Installing
To install, simply follow the building instructions and then run
- Linux: `sudo make install`
- macOS: `sudo make install-macos`
2020-12-03 10:55:46 +00:00
### Using on iOS
Opensend can run on iOS using the [iSH app](https://apps.apple.com/us/app/ish-shell/id1436902243).
- Install go using `apk add go`
- Clone this repository
- Run `make`
- Use opensend as normal, but skip device discovery
- Device discovery does not work properly in iSH due to Alpine Linux
- When running receiver, add `--skip-mdns`
- When running sender, add `--send-to <IP>`
- This applies bidirectionally
- Known issues
2020-12-05 08:24:23 +00:00
- Opensend takes a while to become ready on iOS
### Ports to whitelist
- TCP 9797 for key exchange
2020-12-06 00:58:19 +00:00
- TCP 9898 for file transfer