aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 0e03ba69c97fb44e42a8a37abcdfa6df3366e078 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# Send Over HTTP

Share a file with someone on your local network using QR Code.

Inspired by the android app [Share Via HTTP](https://github.com/marcosdiez/shareviahttp).

## Benefits

 - Files are shared directly over the local network.  An internet connection is
   not required.
 - Others can receive the file without installing any special applications.

## Downsides

 - Others may be able to see the file as the file transfer is not encrypted.
 - Some networks, at bars and cafes, will block connecting to others.

## Usage

```
send-over-http --help
# Usage send-over-http <options> [target]
#
#   target: file or directory to share (default: .)
#
# Options:
#
#   -address string
#     	network address to accept connections (127.0.0.1:0)
#   -net string
#     	network type to listen on (tcp, tcp4, tcp6) (default "tcp")
```

## Build Requirements

 - [Golang](go.dev)

## How to Install

You can install the project using Golang's standard install process from the
projects root directory.

```
go install ./cmd/send-over-http
```

Or you can build the command into the project's root directory.

```
go build ./cmd/send-over-http
```