From f234a0b69e68397b3c08b0c3ff97c06213c19867 Mon Sep 17 00:00:00 2001 From: Bruno Alla Date: Wed, 24 Nov 2021 21:10:26 +0000 Subject: [PATCH] Clarify assumption with Mailgun on Heroku page Fix #2565 --- docs/deployment-on-heroku.rst | 29 ++++++++++++++++++----------- docs/mailgun.rst | 2 +- 2 files changed, 19 insertions(+), 12 deletions(-) diff --git a/docs/deployment-on-heroku.rst b/docs/deployment-on-heroku.rst index 0681a50c..70929612 100644 --- a/docs/deployment-on-heroku.rst +++ b/docs/deployment-on-heroku.rst @@ -3,8 +3,8 @@ Deployment on Heroku .. index:: Heroku -Commands to run ---------------- +Script +------ Run these commands to deploy the project to Heroku: @@ -20,6 +20,7 @@ Run these commands to deploy the project to Heroku: heroku addons:create heroku-redis:hobby-dev + # Assuming you chose Mailgun as mail service (see below for others) heroku addons:create mailgun:starter heroku config:set PYTHONHASHSEED=random @@ -53,11 +54,25 @@ Run these commands to deploy the project to Heroku: heroku open +Notes +----- + +Email Service ++++++++++++++ + +The script above assumes that you've chose Mailgun as email service. If you want to use another one, check the `documentation for django-anymail `_ to know which environment variables to set. Heroku provides other `add-ons for emails `_ (e.g. Sendgrid) which can be configured with a similar one line command. .. warning:: .. include:: mailgun.rst +Heroku & Docker ++++++++++++++++ + +Although Heroku has some sort of `Docker support`_, it's not supported by cookiecutter-django. +We invite you to follow Heroku documentation about it. + +.. _Docker support: https://devcenter.heroku.com/articles/build-docker-images-heroku-yml Optional actions ---------------- @@ -110,12 +125,4 @@ which runs Gulp in cookiecutter-django. If things don't work, please refer to the Heroku docs. -.. _multiple buildpacks: https://devcenter.heroku.com/articles/using-multiple-buildpacks-for-an-app - -About Heroku & Docker ---------------------- - -Although Heroku has some sort of `Docker support`_, it's not supported by cookiecutter-django. -We invite you to follow Heroku documentation about it. - -.. _Docker support: https://devcenter.heroku.com/articles/build-docker-images-heroku-yml +.. _multiple buildpacks: https://devcenter.heroku.com/articles/using-multiple-buildpacks-for-an-app \ No newline at end of file diff --git a/docs/mailgun.rst b/docs/mailgun.rst index 1f34e3c8..b5f49b62 100644 --- a/docs/mailgun.rst +++ b/docs/mailgun.rst @@ -1,7 +1,7 @@ If your email server used to send email isn't configured properly (Mailgun by default), attempting to send an email will cause an Internal Server Error. -By default, django-allauth is setup to `have emails verifications mandatory`_, +By default, ``django-allauth`` is setup to `have emails verifications mandatory`_, which means it'll send a verification email when an unverified user tries to log-in or when someone tries to sign-up.