Document dummy smtp option for dev
@@ -152,6 +152,21 @@ If you want to test support for well-known identity providers, you will need
to configure them. For Google, you can request credentials through their
`API Manager`_.
+It is not necessary to run your own email server to test it. Instead, use
+`MailCatcher`_ or `MailHog`_ to get a dummy smtp inteface. The relevant part of
+the config.toml to use MailCatcher with default settings can look like this:
+
+.. code-block:: shell
+
+ [smtp]
+ # Display name for confirmation emails - Default: "Portier"
+ from_name = "Portier"
+ # Sender address for confirmation emails - Default: (none)
+ from_address = "test@example.com"
+ # Outgoing mailserver address - Default: (none)
+ server = "127.0.0.1:1025"
+
+
To test your changes, you will need to set up a Relying Party; so far, the
Python `demo-rp` code has been used. This is a very bare-bones implementation
that only serves to prove authentication to the broker.
@@ -159,3 +174,5 @@ that only serves to prove authentication to the broker.
.. _demo-rp: https://github.com/portier/demo-rp
.. _Let's Encrypt: https://letsencrypt.org/
.. _API Manager: https://console.developers.google.com/apis/credentials
+.. _MailCatcher: https://mailcatcher.me/
+.. _MailHog: https://github.com/mailhog/MailHog
