waldek
/
jetforce
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Michael Lazar 2019-08-24 00:54:53 -04:00 committed by GitHub
parent a8f4c38e00
commit 4ac15ff55b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -55,11 +55,10 @@ optional arguments:
--hostname HOSTNAME Server hostname (default: localhost) --hostname HOSTNAME Server hostname (default: localhost)
--dir DIR Path on the filesystem to serve (default: /var/gemini) --dir DIR Path on the filesystem to serve (default: /var/gemini)
--index-file INDEX_FILE --index-file INDEX_FILE
The gemini directory index file [i.e. index.html] The gemini directory index file (default: index.gmi)
(default: index.gmi)
If the TLS cert/keyfile is not provided, a self-signed certificate will If the TLS cert/keyfile is not provided, a self-signed certificate will
automatically be generated and saved to your temporary file directory. automatically be generated and saved to your temporary directory.
``` ```
### TLS Certificates ### TLS Certificates
@ -89,3 +88,15 @@ with a status of ``Proxy Request Refused``.
Using python, you can modify this behavior to do fancy things like building a proxy Using python, you can modify this behavior to do fancy things like building a proxy
server for HTTP requests. See [examples/http_proxy.py](examples/http_proxy.py) for server for HTTP requests. See [examples/http_proxy.py](examples/http_proxy.py) for
more information. more information.
## Serving Files
Jetforce serves files from the ``/var/gemini/`` directory by default:
- Files with the **.gmi** extension will be interpreted as *text/gemini*.
- Other files will have their *mimetype* guessed based on their file extensions.
- Directories will look for a file with the name **index.gmi**. If that does
not exist, a directory listing will be automatically generated to return.
There is not currently any support for CGI scripts. This feature might be added
in a future version.