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

change readme to make automatic cert gen more obvious

Browse source
This commit is contained in:
Johann150 2021-11-15 19:52:33 +01:00
parent e764d03458
commit b5d479f315
No known key found for this signature in database
GPG key ID: 9EE6577A2A06F8F1
1 changed files with 6 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -66,6 +66,12 @@ When a client requests the URL `gemini://example.com/foo/bar`, Agate will respon
## Configuration
### Automatic Ceritificate generation
If the `--hostname` argument is used, Agate will generate keys and self signed certificates for each hostname specified. For Gemini it is recommended by the specification to use self signed certificates because Gemini uses the TOFU (Trust on first use) principle for certificates. Because of this, the generated certificates will also have a long expiration time of `4096-01-01`.
For manual configuration of keys and certificates see the [section on certificates](#certificates) below.
### TLS versions
Agate by default supports TLSv1.2 and TLSv1.3. You can disable support for TLSv1.2 by using the flag `--only-tls13` (or its short version `-3`). This is *NOT RECOMMENDED* as it may break compatibility with some clients. The Gemini specification requires compatibility with TLSv1.2 "for now" because not all platforms have good support for TLSv1.3 (cf. §4.1 of the specification).
@ -173,7 +179,6 @@ This would be understood like this:
Using a directory named just `.` causes undefined behaviour as this would have the same meaning as the top level certificate/key pair (pair (1) in the example above).
The files for a certificate/key pair have to be named `cert.der` and `key.der` respectively. The certificate has to be a X.509 certificate in a DER format file and has to include a subject alt name of the domain name. The private key has to be in DER format and must be either an RSA, ECDSA or Ed25519 key.
If the `--hostname` argument is used, Agate will generate certificates and Ed25519 certificates for each hostname specified.
## Logging