Add olden-mail

diff --git a/apps.gmi b/apps.gmi
index 01036818392acac22a26032d287ae80cb29bddec..a4ce40a2f3f52098443032e34af938718d2f9f73 100644 (file)
--- a/apps.gmi
+++ b/apps.gmi
@@ -3,8 +3,8 @@
 ## Apps
 Here's applications I've written, divided into three sections.
 * I are macOS apps
-* II are command line tools for macOS and Linux.
-* III are apps for iOS.
+* II-III are command line tools for macOS and Linux.
+* IV are apps for iOS.
 => / ⧍ Home
 
 ## I
@@ -26,11 +26,16 @@ Print the lyrics of your current track to the terminal. Supports Apple Music, Sp
 Author and publish an (almost) ephemeral html blog with a gemini archive.
 => /blog.gmi ./blog.gmi
 
+## III
 ### Page
 Generate HTML and static gemini websites from .gmi files.
 => /page.gmi ./page.gmi
 
-## III
+### Olden Mail
+IMAP & SMTP proxy to connect vintage clients to modern e-mail.
+=> /olden-mail.gmi ./olden-mail.gmi
+
+## IV
 ### Do
 A task manager that makes you write a journal entry when the task is done.
 => https://do.tranquil.systems/ do.tranquil.systems

diff --git a/olden-mail.gmi b/olden-mail.gmi
new file mode 100644 (file)
index 0000000..924a2c1
--- /dev/null
+++ b/olden-mail.gmi
@@ -0,0 +1,76 @@
+--- title: /olden-mail.html
+--- description: IMAP & SMTP proxy to connect vintage clients to modern e-mail.
+## Olden Mail
+
+olden-mail is an IMAP & SMTP proxy that allows you to connect to SSL
+enabled mail servers using insecure plaintext connections.
+
+This is of course very insecure, but it's intended to allow vintage
+computers that don't have SSL capability or ther right ciphers to still
+be used for e-mail.
+
+=> https://git.r.bdr.sh/rbdr/olden-mail ⧇ source
+=> https://git.sr.ht/~rbdr/olden-mail ⧉ mirror
+
+## Install
+
+### Homebrew
+You can install using homebrew.
+
+```
+% brew tap rbdr/apps git@git.sr.ht:~rbdr/homebrew-apps
+% brew install rbdr/apps/olden-mail
+```
+
+### Prebuilt Packages
+You can find pre-built packages for linux @ build.r.bdr.sh. There you can
+find a `.tar.gz` that includes only the binary, or `.rpm` and `.deb`
+distributions for fedora and debian that include a manpage.
+
+Binaries are provided for x86_64 and aarch64.
+
+Unstable releases are built directly from the main branch, while tagged
+versions have their own release and can be considered more stable.
+
+=> gemini://build.r.bdr.sh/olden-mail olden-mail pre-built releases @ gemini
+=> https://build.r.bdr.sh/olden-mail olden-mail pre-built releases @ https
+
+### From Source
+Make sure you have rust and Make installed. Clone the repository, and run:
+
+```
+% make -e profile=release
+```
+
+Then copy the file somewhere in your PATH
+
+```
+% cp ./target/release/olden-mail /usr/local/bin
+```
+
+## Usage
+
+The proxy requires you to set environment variables, but otherwise takes
+no options.
+
+* `LOCAL_IMAP_PORT` u16, the port in which the server will listen for
+  IMAP clients. Defaults to 143.
+* `LOCAL_IMAP_BIND_ADDRESS` String, the address on which to listen for
+  IMAP clients. Defaults to 0.0.0.0.
+* `REMOTE_IMAP_PORT` u16, the port to which the server will forward the
+  IMAP messages. Defaults to 993.
+* `REMOTE_IMAP_HOST` String, the host to which the server will forward the
+  IMAP messages. Required.
+
+* `LOCAL_SMTP_PORT` u16, the port in which the server will listen for
+  SMTP clients. Defaults to 25.
+* `LOCAL_SMTP_BIND_ADDRESS` String, the address on which to listen for
+  SMTP clients. Defaults to 0.0.0.0.
+* `REMOTE_SMTP_PORT` u16, the port to which the server will forward the
+  SMTP messages. Defaults to 465.
+* `REMOTE_SMTP_HOST` String, the host to which the server will forward the
+  SMTP messages. Required.
+
+## Changelog
+
+* 1.0.0 Initial Release