it would be nice if it were straightforward to make vertical spacing bigger in markdown

This commit is contained in:
Ellie D 2019-06-01 13:52:37 -05:00
parent 6db18f179f
commit 7d9ae53ce6
1 changed files with 6 additions and 0 deletions

View File

@ -3,12 +3,14 @@
#### 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.
@ -34,6 +36,7 @@ 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
Enemy. That's why Sunbeam, minimal as it is, includes this functionality nonetheless.
@ -41,6 +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
@ -59,6 +63,7 @@ faster, but only `w` will print a notification to the console whenever a connect
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
resolve a domain name without depending on external crates or writing an entire DNS client from
@ -70,6 +75,7 @@ Yes, it's clunky, but the point of this program is to be minimal and simple and
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
in the sci-fi novel *The Three Body Problem* by Cixin Liu. A character discovers that, due to a