101 lines
2.5 KiB
Markdown
101 lines
2.5 KiB
Markdown
# hydroxide
|
|
|
|
A third-party, open-source ProtonMail bridge. For power users only, designed to
|
|
run on a server.
|
|
|
|
hydroxide supports CardDAV, IMAP and SMTP.
|
|
|
|
Rationale:
|
|
|
|
* No GUI, only a CLI (so it runs in headless environments)
|
|
* Standard-compliant (we don't care about Microsoft Outlook)
|
|
* Fully open-source
|
|
|
|
Feel free to join the IRC channel: ##emersion on irc.freenode.net.
|
|
|
|
## How does it work?
|
|
|
|
hydroxide is a server that translates standard protocols (SMTP, IMAP, CardDAV)
|
|
into ProtonMail API requests. It allows you to use your preferred e-mail clients
|
|
and `git-send-email` with ProtonMail.
|
|
|
|
+-----------------+ +-------------+ ProtonMail +--------------+
|
|
| | IMAP, SMTP | | API | |
|
|
| E-mail client <-------------> hydroxide <--------------> ProtonMail |
|
|
| | | | | |
|
|
+-----------------+ +-------------+ +--------------+
|
|
|
|
## Setup
|
|
|
|
### Go
|
|
|
|
hydroxide is implemented in Go. Head to [Go website](https://golang.org) for
|
|
setup information.
|
|
|
|
### Installing
|
|
|
|
Start by installing hydroxide:
|
|
|
|
```shell
|
|
GO111MODULE=on go get github.com/emersion/hydroxide/cmd/hydroxide
|
|
```
|
|
|
|
Then you'll need to login to ProtonMail via hydroxide, so that hydroxide can
|
|
retrieve e-mails from ProtonMail. You can do so with this command:
|
|
|
|
```shell
|
|
hydroxide auth <username>
|
|
```
|
|
|
|
Once you're logged in, a "bridge password" will be printed. Don't close your
|
|
terminal yet, as this password is not stored anywhere by hydroxide and will be
|
|
needed when configuring your e-mail client.
|
|
|
|
Your ProtonMail credentials are stored on disk encrypted with this bridge
|
|
password (a 32-byte random password generated when logging in).
|
|
|
|
## Usage
|
|
|
|
hydroxide can be used in multiple modes.
|
|
|
|
> Don't start hydroxide multiple times, instead you can use `hydroxide server`.
|
|
|
|
### SMTP
|
|
|
|
To run hydroxide as an SMTP server:
|
|
|
|
```shell
|
|
hydroxide smtp
|
|
```
|
|
|
|
Once the bridge is started, you can configure your e-mail client with the
|
|
following settings:
|
|
|
|
* Hostname: `localhost`
|
|
* Port: 1025
|
|
* Security: none
|
|
* Username: your ProtonMail username
|
|
* Password: the bridge password (not your ProtonMail password)
|
|
|
|
### CardDAV
|
|
|
|
You must setup an HTTPS reverse proxy to forward requests to `hydroxide`.
|
|
|
|
```shell
|
|
hydroxide carddav
|
|
```
|
|
|
|
Tested on GNOME (Evolution) and Android (DAVDroid).
|
|
|
|
### IMAP
|
|
|
|
For now, it only supports unencrypted local connections.
|
|
|
|
```shell
|
|
hydroxide imap
|
|
```
|
|
|
|
## License
|
|
|
|
MIT
|