]> git.r.bdr.sh - rbdr/r.bdr.sh/blame_incremental - olden-mail.gmi
Add olden-mail
[rbdr/r.bdr.sh] / olden-mail.gmi
... / ...
CommitLineData
1--- title: /olden-mail.html
2--- description: IMAP & SMTP proxy to connect vintage clients to modern e-mail.
3## Olden Mail
4
5olden-mail is an IMAP & SMTP proxy that allows you to connect to SSL
6enabled mail servers using insecure plaintext connections.
7
8This is of course very insecure, but it's intended to allow vintage
9computers that don't have SSL capability or ther right ciphers to still
10be used for e-mail.
11
12=> https://git.r.bdr.sh/rbdr/olden-mail ⧇ source
13=> https://git.sr.ht/~rbdr/olden-mail ⧉ mirror
14
15## Install
16
17### Homebrew
18You can install using homebrew.
19
20```
21% brew tap rbdr/apps git@git.sr.ht:~rbdr/homebrew-apps
22% brew install rbdr/apps/olden-mail
23```
24
25### Prebuilt Packages
26You can find pre-built packages for linux @ build.r.bdr.sh. There you can
27find a `.tar.gz` that includes only the binary, or `.rpm` and `.deb`
28distributions for fedora and debian that include a manpage.
29
30Binaries are provided for x86_64 and aarch64.
31
32Unstable releases are built directly from the main branch, while tagged
33versions have their own release and can be considered more stable.
34
35=> gemini://build.r.bdr.sh/olden-mail olden-mail pre-built releases @ gemini
36=> https://build.r.bdr.sh/olden-mail olden-mail pre-built releases @ https
37
38### From Source
39Make sure you have rust and Make installed. Clone the repository, and run:
40
41```
42% make -e profile=release
43```
44
45Then copy the file somewhere in your PATH
46
47```
48% cp ./target/release/olden-mail /usr/local/bin
49```
50
51## Usage
52
53The proxy requires you to set environment variables, but otherwise takes
54no options.
55
56* `LOCAL_IMAP_PORT` u16, the port in which the server will listen for
57 IMAP clients. Defaults to 143.
58* `LOCAL_IMAP_BIND_ADDRESS` String, the address on which to listen for
59 IMAP clients. Defaults to 0.0.0.0.
60* `REMOTE_IMAP_PORT` u16, the port to which the server will forward the
61 IMAP messages. Defaults to 993.
62* `REMOTE_IMAP_HOST` String, the host to which the server will forward the
63 IMAP messages. Required.
64
65* `LOCAL_SMTP_PORT` u16, the port in which the server will listen for
66 SMTP clients. Defaults to 25.
67* `LOCAL_SMTP_BIND_ADDRESS` String, the address on which to listen for
68 SMTP clients. Defaults to 0.0.0.0.
69* `REMOTE_SMTP_PORT` u16, the port to which the server will forward the
70 SMTP messages. Defaults to 465.
71* `REMOTE_SMTP_HOST` String, the host to which the server will forward the
72 SMTP messages. Required.
73
74## Changelog
75
76* 1.0.0 Initial Release