readme: add more user-friendly instructions
This commit is contained in:
parent
3ac9a25ddb
commit
acf2a5ee5b
56
README.md
56
README.md
|
@ -11,32 +11,68 @@ Rationale:
|
||||||
* Standard-compliant (we don't care about Microsoft Outlook)
|
* Standard-compliant (we don't care about Microsoft Outlook)
|
||||||
* Fully open-source
|
* Fully open-source
|
||||||
|
|
||||||
|
## 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
|
## Setup
|
||||||
|
|
||||||
### Go
|
### Go
|
||||||
|
|
||||||
hydroxide is implemented with Go. Head to [Go website](https://golang.org)
|
hydroxide is implemented in Go. Head to [Go website](https://golang.org) for
|
||||||
for setup information.
|
setup information.
|
||||||
|
|
||||||
### Install and Setup
|
### Installing
|
||||||
|
|
||||||
Install hydroxide
|
Start by installing hydroxide:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
go get github.com/emersion/hydroxide/cmd/hydroxide
|
go get github.com/emersion/hydroxide/cmd/hydroxide
|
||||||
```
|
```
|
||||||
|
|
||||||
Your credentials will be stored on disk encrypted with a 32-byte random
|
Then you'll need to login to ProtonMail via hydroxide, so that hydroxide can
|
||||||
password. When configuring your client, you'll need this password.
|
retrieve e-mails from ProtonMail. You can do so with this command:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
hydroxide auth <username>
|
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
|
## Usage
|
||||||
|
|
||||||
hydroxide can be used in multiple modes.
|
hydroxide can be used in multiple modes.
|
||||||
|
|
||||||
|
### 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
|
### CardDAV
|
||||||
|
|
||||||
You must setup an HTTPS reverse proxy to forward requests to `hydroxide`.
|
You must setup an HTTPS reverse proxy to forward requests to `hydroxide`.
|
||||||
|
@ -55,14 +91,6 @@ For now, it only supports unencrypted local connections.
|
||||||
hydroxide imap
|
hydroxide imap
|
||||||
```
|
```
|
||||||
|
|
||||||
### SMTP
|
|
||||||
|
|
||||||
For now, it only supports unencrypted local connections.
|
|
||||||
|
|
||||||
```shell
|
|
||||||
hydroxide smtp
|
|
||||||
```
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
MIT
|
MIT
|
||||||
|
|
Loading…
Reference in New Issue