~ivilata/gwit-spec

6c1103f566ece4f75a5bad23ac2827dd9b71db76 — Ivan Vilata-i-Balaguer 1 year, 3 months ago c6e727b
The Well-Known URI file can only have one `site` section.

This should be the norm, but unless the spec gets more strict with the
contents of INI files, it is possible for the file to contain more than one
such section (with different IDs), and then the reader would not be able to
tell which one it should use as a site introduction.

Please note that a site hosted in both Web and Gemini should use two different
gwit sites for combined support.
1 files changed, 1 insertions(+), 1 deletions(-)

M README.md
M README.md => README.md +1 -1
@@ 358,7 358,7 @@ One of gwit's goals is to make existing Web or Gemini static sites easy to publi

For a more seamless integration, it should be possible to use the other protocols supported by such a **combined site** to both identify it as such and get the information needed to access it over gwit. However, since the `_gwit` directory is always found in the Git repository's top directory, if the site is configured to use a different root directory (i.e. `site.<ID>.root` in `_gwit/self.ini`), those files may not be available via legacy URIs.

A Well-Known URI ([RFC8615][]) MAY be used to provide such site metadata, accessible via the `/.well-known/gwit.ini` legacy URI path, i.e. `<SITE-ROOT>/.well-known/gwit.ini`. The format and features of this file are those of a site introduction (see further above), where the site introduces itself.
A Well-Known URI ([RFC8615][]) MAY be used to provide such site metadata, accessible via the `/.well-known/gwit.ini` legacy URI path, i.e. `<SITE-ROOT>/.well-known/gwit.ini`. The format and features of this file are those of a site introduction file (see further above), where the site introduces itself: there MUST be exactly one `[site "<ID>"]` section.

[RFC8615]: https://www.rfc-editor.org/rfc/rfc8615.html
    "Well-Known Uniform Resource Identifiers (URIs) (RFC 8615)"