update readme
This commit is contained in:
parent
872197c558
commit
37769d6536
1 changed files with 28 additions and 0 deletions
28
README.md
28
README.md
|
@ -3,6 +3,34 @@ Sheldon Director
|
|||
|
||||
A [Gemini](https://gemini.circumlunar.space/) Server written in Rust.
|
||||
|
||||
Features
|
||||
--------
|
||||
|
||||
This can't do much right now besides hosting some static files. In fact, the
|
||||
feature set happens to be limited to what I need to host my own gemini page.
|
||||
Coincidence?
|
||||
|
||||
More is to come however. Specifically I'd want to add CGI support. And maybe
|
||||
reverse proxy support as well, depending on how much stuff I'll be hosting over
|
||||
Gemini.
|
||||
|
||||
Starting
|
||||
--------
|
||||
|
||||
Right now every relevant option needs to be given through command line
|
||||
parameters. Though handling of a configuration file is a feature I'll add
|
||||
later on.
|
||||
|
||||
An example start can look like this:
|
||||
```sh
|
||||
sudo ./sheldond -l "[::]:1965" -l "0.0.0.0:1965" -d "klockenschooster.de" -g /var/gemini/ --user gem-data --group gem-data
|
||||
```
|
||||
|
||||
This serves the content of the folder `/var/gemini/` over both IPv4 and IPv6
|
||||
on port 1965 on the domain `klockenschooster.de`. After opening the socket and
|
||||
reading the certificates the server sets its user and group id to the
|
||||
respective values for `gem-data`.
|
||||
|
||||
Why "Sheldon Director"?
|
||||
-----------------------
|
||||
|
||||
|
|
Loading…
Reference in a new issue