extend readme

This commit is contained in:
Richard Garai 2022-07-21 15:53:01 +02:00
parent 4925631ce3
commit ccda74ef06
No known key found for this signature in database
GPG Key ID: 874C665319A8FA05

View File

@ -1,13 +1,13 @@
# hydroxide docker # hydroxide docker
This image is used for `okki.hu` services. This image is used for `okki.hu` services to provide a proton based smtp server. It is based on [hydroxide](https://github.com/emersion/hydroxide) - a lightweight proton bridge implementation.
# usage # usage
## fetch the image ## fetch the image
``` ```
docker pull garricasaurus/hydroxide-docker docker pull garric/hydroxide-docker
``` ```
## config dir ## config dir
@ -46,4 +46,13 @@ docker run -d --name hydroxide \
-v $HOME/.config/hydroxide:/.config/hydroxide \ -v $HOME/.config/hydroxide:/.config/hydroxide \
-p 1025:1025 \ -p 1025:1025 \
hydroxide smtp hydroxide smtp
``` ```
# requirements
* proton paid subscription
* docker
# security notes
Do __NOT__ expose the smtp port to the public world. It is insecure, and only intended for intranet usage.