the great documentation update

This commit is contained in:
randomuser 2021-07-29 23:10:25 -05:00
parent 252c63a0d5
commit 0cef6add89
1 changed files with 25 additions and 0 deletions

25
README
View File

@ -8,6 +8,8 @@ options:
-u, --user: user to change to on startup
-g, --group: group to change to on startup
-s, --host: host name
-gs, --gopherhost: host name to use for links
when parsing gophermaps
-p, --port: port
-d, --dir: directory to host from
@ -15,6 +17,29 @@ options:
PATH are not executing
-nx, --nocgi: disable cgi execution
hints:
by default python's socketserver when hosting on "localhost"
will bind to the loopback interface. this is fine for testing,
but in production you'll want to use --host '0.0.0.0' to force
socketserver to bind to your public-facing interface.
also, due to some dumb code in socketserver, IPv6 is not
supported at this time. once this server gets in a stable
condition a rewrite using system level sockets will be in
order.
note that when using the --host parameter you might want to
use --gopherhost to set a publicly facing domain name. this
name is substituted in in gophermaps that are incomplete.
(somewhat) applicable standards:
- RFC3875: The Common Gateway Interface (CGI) Version 1.1
NOTE: support for CGI/1.1 is limited and not up to spec.
this will change in the future.
- RFC1436: The Internet Gopher Protocol (a distributed
document search and retrieval protocol)
NOTE: almost to full compliance
files:
esgd.py - main executable
README - this file