cookiecutter/cookiecutter-django
1
1
Fork 0
mirror of https://github.com/cookiecutter/cookiecutter-django.git synced 2024-11-25 11:04:04 +03:00
Code Issues Packages Projects Releases Wiki Activity

Clarify assumption with Mailgun on Heroku page

Browse Source 
Fix #2565
This commit is contained in:
Bruno Alla 2021-11-24 21:10:26 +00:00
parent 8b4493365c
commit f234a0b69e
2 changed files with 19 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/deployment-on-heroku.rst
View File

@ -3,8 +3,8 @@ Deployment on Heroku
.. index:: Heroku .. index:: Heroku
Commands to run Script
--------------- ------
Run these commands to deploy the project to Heroku: 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 heroku addons:create heroku-redis:hobby-dev
# Assuming you chose Mailgun as mail service (see below for others)
heroku addons:create mailgun:starter heroku addons:create mailgun:starter
heroku config:set PYTHONHASHSEED=random heroku config:set PYTHONHASHSEED=random
@ -53,11 +54,25 @@ Run these commands to deploy the project to Heroku:
heroku open 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 <https://anymail.readthedocs.io>`_ to know which environment variables to set. Heroku provides other `add-ons for emails <https://elements.heroku.com/addons#email-sms>`_ (e.g. Sendgrid) which can be configured with a similar one line command.
.. warning:: .. warning::
.. include:: mailgun.rst .. 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 Optional actions
---------------- ----------------
@ -110,12 +125,4 @@ which runs Gulp in cookiecutter-django.
If things don't work, please refer to the Heroku docs. If things don't work, please refer to the Heroku docs.
.. _multiple buildpacks: https://devcenter.heroku.com/articles/using-multiple-buildpacks-for-an-app .. _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

2
docs/mailgun.rst
View File

@ -1,7 +1,7 @@
If your email server used to send email isn't configured properly (Mailgun by default), 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. 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 which means it'll send a verification email when an unverified user tries to
log-in or when someone tries to sign-up. log-in or when someone tries to sign-up.