diff --git a/README.md b/README.md index 16657b5..2aa3c40 100644 --- a/README.md +++ b/README.md @@ -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/