commit 92d3c6dcee115edbadf1cc98b88c6860ca58025b
parent 80c6a5189ea0100e6349c0b403a9c9ba99b51e12
Author: Andrew Laack <andrew@laack.co>
Date: Thu, 1 Oct 2026 20:38:03 -0500
Updated readme ordering
Diffstat:
| M | README | | | 46 | ++++++++++++++++++++++------------------------ |
1 file changed, 22 insertions(+), 24 deletions(-)
diff --git a/README b/README
@@ -14,7 +14,7 @@ will be installed into /usr/local/bin by default).
Then run the following command to build and install foreseen:
make install
-(the above command may require root, depending on the installation location)
+(the above command may require root depending on the installation location)
Usage
=====
@@ -39,29 +39,6 @@ Optional arguments:
[default: "gemini://tlgs.one/search"]
-Identities
-==========
-These are specified in:
- $HOME/.gmi/{hostname}/client.crt
- $HOME/.gmi/{hostname}/client.key
-
-Or for a non-standard port (port != 1965):
- $HOME/.foreseen/{hostname}:{port}/client.crt
- $HOME/.foreseen/{hostname}:{port}/client.key
-
-Example:
- > tree .foreseen
- .foreseen
- └── bbs.geminispace.org
- ├── client.crt
- └── client.key
-
-(I recommend symlinking ~/.foreseen to somewhere you backup regularly)
-
-Example command to generate keys:
- openssl req -x509 -newkey rsa:2048 -nodes -days 3650 -keyout client.key \
- -out client.crt -subj "/CN=localhost"
-
Caching
=======
All caching is done in memory with a configurable fifo data structure to limit
@@ -94,3 +71,24 @@ requests to hosts you'd use an identity for.
If the page was in the prefetch cache before, it will be upgraded to the
history cache. This is because visited pages are more important than
prefetched ones. History caching is disabled when using an identity.
+
+Identities
+==========
+These are specified in:
+ $HOME/.gmi/{hostname}/client.crt
+ $HOME/.gmi/{hostname}/client.key
+
+Or for a non-standard port (port != 1965):
+ $HOME/.foreseen/{hostname}:{port}/client.crt
+ $HOME/.foreseen/{hostname}:{port}/client.key
+
+Example:
+ > tree .foreseen
+ .foreseen
+ └── bbs.geminispace.org
+ ├── client.crt
+ └── client.key
+
+Example command to generate keys:
+ openssl req -x509 -newkey rsa:2048 -nodes -days 3650 -keyout client.key \
+ -out client.crt -subj "/CN=localhost"