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 documents for 3.3.0

Browse source
This commit is contained in:
Johann150 2023-03-18 08:39:48 +01:00
parent 48da55cf42
commit d72cdad0aa
No known key found for this signature in database
GPG key ID: 9EE6577A2A06F8F1
4 changed files with 31 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
CHANGELOG.md
View file

@ -6,13 +6,17 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
Thank you to @equalsraf for contributing to this release.
## [3.3.0] - 2023-03-18
Thank you to @equalsraf, @michaelnordmeyer and @wanderer1988 for contributing to this release.
### Added
* listening on unix sockets (#244)
### Fixed
* updated dependencies
* misstyped email address in section on how to report security vulnerabilities (#239)
* wrong language code in README (#189)
## [3.2.4] - 2022-05-18
Thank you to @06kellyjac, @albertlarsan68 and @kahays for contributing to this release.
@ -343,7 +347,8 @@ Thank you to @m040601 for contributing to this release.
## [1.0.0] - 2020-05-21
[Unreleased]: https://github.com/mbrubeck/agate/compare/v3.2.4...HEAD
[Unreleased]: https://github.com/mbrubeck/agate/compare/v3.3.0...HEAD
[3.3.0]: https://github.com/mbrubeck/agate/compare/v3.2.4...v3.3.0
[3.2.4]: https://github.com/mbrubeck/agate/compare/v3.2.3...v3.2.4
[3.2.3]: https://github.com/mbrubeck/agate/compare/v3.2.2...v3.2.3
[3.2.2]: https://github.com/mbrubeck/agate/compare/v3.2.1...v3.2.2

2
Cargo.lock generated
View file

@ -4,7 +4,7 @@ version = 3
[[package]]
name = "agate"
version = "3.2.4"
version = "3.3.0"
dependencies = [
"anyhow",
"configparser",

2
Cargo.toml
View file

@ -1,6 +1,6 @@
[package]
name = "agate"
version = "3.2.4"
version = "3.3.0"
authors = ["Matt Brubeck <mbrubeck@limpet.net>", "Johann150 <johann+agate@qwertqwefsday.eu>"]
description = "Very simple server for the Gemini hypertext protocol"
keywords = ["server", "gemini", "hypertext", "internet", "protocol"]

27
content/index.gmi
View file

@ -123,7 +123,7 @@ Such a configuration file might look like this:
# This line will be ignored.
**/*.de.gmi: ;lang=de
nl/**/*.gmi: ;lang=nl
index.gmi: ;lang=en-UK
index.gmi: ;lang=en-GB
LICENSE: text/plain;charset=UTF-8
gone.gmi: 52 This file is no longer here, sorry.
```
@ -131,7 +131,7 @@ gone.gmi: 52 This file is no longer here, sorry.
If this is the `.meta` file in the content root directory and the `-C` flag is used, this will result in the following response headers:
```
`/` or `/index.gmi`
-> `20 text/gemini;lang=en-UK`
-> `20 text/gemini;lang=en-GB`
`/LICENSE`
-> `20 text/plain;charset=UTF-8`
`/gone.gmi`
@ -189,13 +189,19 @@ The files for a certificate/key pair have to be named `cert.der` and `key.der` r
## Logging
All requests will be logged using this format:
All requests via TCP sockets will be logged using this format:
```
<local ip>:<local port> <remote ip or dash> "<request>" <response status> "<response meta>"[ error:<error>]
```
The "error:" part will only be logged if an error occurred. This should only be used for informative purposes as the status code should provide the information that an error occurred. If the error consisted in the connection not being established (e.g. because of TLS errors), the status code `00` will be used.
All requests via Unix sockets will be logged using this format:
```
unix:[<unix socket name>] - "<request>" <response status> "<response meta>"[ error:<error>]
```
Square brackets indicate optional parts.
By default, Agate will not log the remote IP addresses because that might be an issue because IPs are considered private data under the EU's GDPR. To enable logging of IP addresses, you can use the `--log-ip` option. Note that in this case some error conditions might still force Agate to log a dash instead of an IP address.
The "error:" part will only be logged if an error occurred. This should only be used for informative purposes as the status code should provide the information that an error occurred. If the error consisted in the connection not being established (e.g. because of TLS errors), special status codes listed below may be used.
By default, Agate will not log the remote IP addresses because that might be an issue because IPs are considered private data under the EU's GDPR. To enable logging of IP addresses, you can use the `--log-ip` option. Note that in this case some error conditions might still force Agate to log a dash instead of an IP address. IP addresses can also not be logged for connections via Unix sockets.
There are some lines apart from these that might occur in logs depending on the selected log level. For example the initial "Listening on..." line or information about listing a particular directory.
@ -215,6 +221,17 @@ The format is based on Keep a Changelog and this project adheres to Semantic Ver
=> https://keepachangelog.com/en/1.0.0/ Keep a Changelog home page
=> https://semver.org/spec/v2.0.0.html Semantic versioning standard v2.0.0
## [3.3.0] - 2023-03-18
Thank you to @equalsraf, @michaelnordmeyer and @wanderer1988 for contributing to this release.
### Added
* listening on unix sockets (#244)
### Fixed
* updated dependencies
* misstyped email address in section on how to report security vulnerabilities (#239)
* wrong language code in README (#189)
## [3.2.4] - 2022-05-18
Thank you to @06kellyjac, @albertlarsan68 and @kahays for contributing to this release.