jarno
/
hydroxide-push
1
0
Fork 0
Code Issues Pull Requests Wiki Activity

Update README

This commit is contained in:
emersion 2017-12-03 12:32:33 +01:00
parent 90d494b130
commit d4ba998bb2
No known key found for this signature in database
GPG Key ID: 0FDE7BE0E88F5E48
1 changed files with 20 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -1,22 +1,38 @@
# hydroxide
A third-party, open-source ProtonMail CardDAV bridge. For power users only,
designed to run on a server.
A third-party, open-source ProtonMail bridge. For power users only, designed to
run on a server.
hydroxide supports CardDAV and SMTP.
## Usage
Your credentials will be stored on disk encrypted with a 32-byte random
password. When configuring your CardDAV client, you'll need this password.
You must setup an HTTPS reverse proxy to forward requests to `hydroxide`.
password. When configuring your client, you'll need this password.
```shell
go get github.com/emersion/hydroxide
hydroxide auth <username>
```
### CardDAV
You must setup an HTTPS reverse proxy to forward requests to `hydroxide`.
```shell
hydroxide carddav
```
Tested on GNOME (Evolution) and Android (DAVDroid).
### SMTP
For now, it only supports unencrypted local connections.
```shell
hydroxide smtp
```
## License
MIT