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

Added additional setup details

This commit is contained in:
Josh Smith 2017-12-09 08:22:54 -05:00
parent 7f930e072f
commit a7692bcf1f
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -11,16 +11,32 @@ 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
## Usage ## Setup
### Golang
hydroxide is implemented with Go. Head to [Golang website](https://golang.org)
for setup information.
### Install and Setup
Install hydroxide
```shell
go get github.com/emersion/hydroxide/cmd/hydroxide
```
Your credentials will be stored on disk encrypted with a 32-byte random Your credentials will be stored on disk encrypted with a 32-byte random
password. When configuring your client, you'll need this password. password. When configuring your client, you'll need this password.
```shell ```shell
go get github.com/emersion/hydroxide/cmd/hydroxide
hydroxide auth <username> hydroxide auth <username>
``` ```
## Usage
hydroxide can be used in multiple modes.
### 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`.