diff --git a/README.md b/README.md index 9805799..8c8f8ec 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ # 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 ## fetch the image ``` -docker pull garricasaurus/hydroxide-docker +docker pull garric/hydroxide-docker ``` ## config dir @@ -46,4 +46,13 @@ docker run -d --name hydroxide \ -v $HOME/.config/hydroxide:/.config/hydroxide \ -p 1025:1025 \ hydroxide smtp -``` \ No newline at end of file +``` + +# 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. \ No newline at end of file