$OpenBSD: README,v 1.0 2020/09/07 15:38:20 jxl Exp $

+-----------------------------------------------------------------------
| Running ${PKGSTEM} on OpenBSD
+-----------------------------------------------------------------------

-- NOTE: the following is a liberal rewording of the instructions found
in hydroxide's project README.

Setup
-----
Initially, you'll want to authenticate to ProtonMail via hydroxide, so
that it can retrieve emails, contacts and calendar events from
ProtonMail. This can be done via the `auth` subcommand.

  hydroxide auth <username>

This will prompt you for your ProtonMail password. After authenticating
hydroxide will produce a new password. This is the bridge password and
is used to authenticate your mail client with hydroxide.

The password is also used to encrypt your ProtonMail credentials for
storing on disk.

To authenticate for multiple users, simply repeat this process for each
user.


Usage
-----
Hydroxide provides SMTP, IMAP and CardDAV services, on ports 1025, 1143
and 8080 respectively.

These can be changed by providing the following options to hydroxide:

  -smtp-port <port>
  -imap-port <port>
  -carddav-port <port>

Individual services can be started by invoking hydroxide as follows:

  hydroxide smtp
  hydroxide imap
  hydroxide carddav

To start all services, instead of launching hydroxide multiple times,
use the serve subcommand, which will start all of them:

  hydroxide serve

To exclude a service from being started, for example carddav, you can
use the -disable-<service> options:

  hydroxide -disable-carddav serve

By default, hydroxide will listen on only on the host local interface.
To expose individual services on other networks, you can use the
-<service>-host option(s), for example:

  hydroxide -carddav-host 192.168.0.2 carddav

Finally, to secure the communications channel between clients and
hydroxide, the following tls options are available:

  -tls-cert /path/to/cert.pem
    To specify the certificate to use for incoming connections
  -tls-key /path/to/key.pem
    To specify the certificate key to use for incoming connections
  -tls-client-ca /path/to/ca.pem
    To specify the certificate authority used to sign client
    certificates

After all that is done, configure your mail client accordingly and
you should be good to go!
