we can't remember. are horizontal rules between sections a good plan?
This commit is contained in:
parent
7d9ae53ce6
commit
1a1e0591a1
12
README.md
12
README.md
|
@ -2,14 +2,14 @@
|
|||
#### Elizabeth Evelene Amelia Diode, June 2019
|
||||
#### AGPL v3
|
||||
|
||||
|
||||
---
|
||||
|
||||
### Oh no, what is it this time?
|
||||
Sunbeam is a simple and fast multi-endpoint TCP relay for
|
||||
for um
|
||||
we swear we had a perfectly reasonable use in mind, but we honestly can't remember it now.
|
||||
|
||||
|
||||
---
|
||||
|
||||
### What it does
|
||||
Sunbeam is a little tiny server that passes data between TCP connections.
|
||||
|
@ -35,7 +35,7 @@ can also pass the `-l` flag to require Sunbeam to run in loopback mode.
|
|||
General usage looks like the following:
|
||||
`sunbeam [-l] [local port] [remote address]:[port]`
|
||||
|
||||
|
||||
---
|
||||
|
||||
### How to block IP addresses
|
||||
It's 2019, and a server that can't filter incoming connections is a server that belongs to The
|
||||
|
@ -44,7 +44,7 @@ You can create the file `.nosunbeam` in the directory where Sunbeam runs. Sunbea
|
|||
parse each line as an IP address (v4 or v6 are both fine), and immediately drop any incoming
|
||||
connections from those addresses.
|
||||
|
||||
|
||||
---
|
||||
|
||||
### How to make ports private
|
||||
In case you want a port only to be accessible locally - e.g. if you're running a streaming server
|
||||
|
@ -62,7 +62,7 @@ table of allowed addresses and drops them if they are not found. `p` is likely a
|
|||
faster, but only `w` will print a notification to the console whenever a connection is rejected.
|
||||
If a port is suffixed with both `w` and `p`, whichever is listed last will take precedence.
|
||||
|
||||
|
||||
---
|
||||
|
||||
### Why you can't give it domain names
|
||||
Rust has a minimal standard library. One consequence of this is the fact that there's no way to
|
||||
|
@ -74,7 +74,7 @@ way, like by running `dig`at the command line to look up the IP address for the
|
|||
Yes, it's clunky, but the point of this program is to be minimal and simple and reliable, not to
|
||||
be easier to use at the expense of those things.
|
||||
|
||||
|
||||
---
|
||||
|
||||
### Why it's called that
|
||||
This program is called "Sunbeam" because of a particular plot device that we thought was clever
|
||||
|
|
Loading…
Reference in New Issue