sjs/agate
1
0
Fork 0
mirror of https://github.com/samsonjs/agate.git synced 2026-03-25 09:05:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update & rephrase readme

Browse source
This commit is contained in:
Johann150 2021-01-16 21:30:52 +01:00 committed by Matt Brubeck
parent 6d51e97649
commit 21e16e9a9c
1 changed files with 3 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -33,16 +33,15 @@ openssl req -x509 -newkey rsa:4096 -keyout key.rsa -out cert.pem \
agate --content path/to/content/ \
--key key.rsa \
--cert cert.pem \
--addr :: \
--addr 0.0.0.0 \
--port 1965 \
--addr :::1965 \
--addr 0.0.0.0:1965 \
--hostname example.com \
--lang en-US
```
All of the command-line arguments are optional. Run `agate --help` to see the default values used when arguments are omitted.
When a client requests the URL `gemini://example.com/foo/bar`, Agate will respond with the file at `path/to/content/foo/bar`. If the requested file or directory name starts with a dot, agate will respond with a status code 52, even if the file does not exist. If there is a directory at that path, Agate will look for a file named `index.gmi` inside that directory. If there is no such file, but a file named `.directory-listing-ok` exists inside that directory, a basic directory listing is displayed. Files whose name starts with a dot (e.g. `.hidden`) are omitted from the list.
When a client requests the URL `gemini://example.com/foo/bar`, Agate will respond with the file at `path/to/content/foo/bar`. If any segment of the requested path starts with a dot, agate will respond with a status code 52, even if the file does not exist (this behaviour can be disabled with `--serve-secret`). If there is a directory at that path, Agate will look for a file named `index.gmi` inside that directory. If there is no such file, but a file named `.directory-listing-ok` exists inside that directory, a basic directory listing is displayed. Files or directories whose name starts with a dot (e.g. the `.directory-listing-ok` file itself) are omitted from the list.
[Gemini]: https://gemini.circumlunar.space/
[Rust]: https://www.rust-lang.org/