search

getfider / fider

Open platform to collect and prioritize feedback
https://fider.io
GNU Affero General Public License v3.0
2.75k stars 620 forks source link

Documentation not good enough regarding mailgun #1077

Closed modir closed 1 year ago

modir commented 2 years ago

The only thing written about mailgun in the documentation at https://fider.io/docs/hosting-instance is those two lines of configuration:

      # EMAIL_MAILGUN_API: key-yourkeygoeshere
      # EMAIL_MAILGUN_DOMAIN: yourdomain.com

Sadly this is not good enough. Officially mailgun is using these terms:

API key: 7a8b7251a4991a206b06d151e12cf3bb-8d821f0c-XXXXXXXX
API base URL:https://api.mailgun.net/v3/sandbox58bc7147a870420bXXXXXX25948b7.mailgun.org

There are three problems:

  1. First it looks like I need to prefix EMAIL_MAILGUN_API with "key-".
  2. It is not sure which domain we are talking about. In the curl example on the mailgun website the URL is written like this: https://api.mailgun.net/v3/YOUR_DOMAIN_NAME/messages Do you need here now the full domain or only sandbox58bc7147a870420bXXXXXX25948b7.mailgun.org?
  3. If it is only the sandbox part how can I switch to the EU servers? Because there the servers would behttps://api.eu.mailgun.net/
satoshinotdead commented 2 years ago

Could you handle it?

modir commented 2 years ago

@satoshinotdead no, I am still waiting till the documentation is updated.

goenning commented 2 years ago

If you feel like the docs could be more explicit, please send a PR.

All Mailgun code used in Fider is here: https://github.com/getfider/fider/tree/main/app/services/email/mailgun

That should help clarify those questions.

modir commented 2 years ago

Sadly I don't feel that confortable with this programming language. I created now a PR but I am not sure if it is correct.