Commit Graph

289 Commits

Author SHA1 Message Date
Curtis St Pierre
4bf795a908 1989 - reworked postgres version options 2019-05-20 08:53:07 -07:00
Tano Abeleyra
de7be3652a Make cloud_provider optional
Some projects may not need AWS or GCS
2019-05-19 12:45:28 -03:00
Bruno Alla
3b96afc559 Deduplicate troubleshooting sections about Mailgun 2019-05-12 21:57:16 +01:00
Bruno Alla
39df72669e Merge branch 'master' into upgrade/django-2.1
# Conflicts:
#	README.rst
2019-04-17 08:33:54 +01:00
Bruno Alla
cd13ab4c82 Update docs/settings.rst
Documented GOOGLE_APPLICATION_CREDENTIALS env var

Co-Authored-By: vladdoster <Dosterm@wit.edu>
2019-04-16 11:30:22 -05:00
Bruno Alla
f6cac35b87 Update docs/project-generation-options.rst
Clearer diction describing cloud provider roles

Co-Authored-By: vladdoster <Dosterm@wit.edu>
2019-04-16 11:23:41 -05:00
Vlad
c041453bef Updated project-generation-options.rst to provide helpful links in case a user needs to decide between AWS s3 and GCS and added myself to contributors.rst 2019-04-14 12:07:37 -05:00
Vlad
7c8a473460 Updated settings.rst to reflect new GS env variable 2019-04-14 11:57:48 -05:00
Vlad
56aa332e01 Documented Google Cloud Storage integration as an alternative to AWS S3 2019-04-14 11:43:05 -05:00
Bruno Alla
2dcbaca3ee Update documentation 2019-04-02 19:38:23 +01:00
Bruno Alla
81851ffb6d Merge branch 'master' into mailgun_api_url 2019-04-02 15:45:37 +01:00
Bruno Alla
eacfd0e447 Merge branch 'master' into aws_s3_backup_commands 2019-04-02 15:43:56 +01:00
Jelmert
7e23327fe2 Added DJANG_AWS_S3_REGION_NAME to settings docs 2019-04-02 15:45:58 +02:00
Jelmert
27d806fab1 Typo 2019-04-02 15:36:44 +02:00
Jelmert
8851ac13ef Added the awscli container for uploading and downloading backups from and to Amazon S3 2019-04-02 15:36:44 +02:00
Jelmert
f6f2942a91 Listed MAILGUN_API_URL in settings docs 2019-04-02 15:17:22 +02:00
Bruno Alla
edf2eba6af Remove outdated warning in Local docker docs 2019-04-02 10:36:42 +01:00
Bruno Alla
6d48275e5f Fix Heroku docs 2019-04-02 10:33:38 +01:00
Bruno Alla
74ed3ab715
Merge pull request #1996 from pydanny/docs/heroku
Docs/heroku
2019-03-29 17:00:52 +00:00
Bruno Alla
55ef75e7a0
Merge pull request #1991 from hanaquadara/issue-1590/add-plugins-to-reqs
Add pylint plugins to requirements.txt
2019-03-26 21:45:51 +00:00
Bruno Alla
eb3325f767 Add documentation about Mailgun setup fixes #1705 2019-03-26 21:36:38 +00:00
Bruno Alla
9e93adaf98 Add documentation to include optional integrations fixes #449 2019-03-26 21:20:56 +00:00
Bruno Alla
b91c70d755
Add a node image to run Gulp when selecting it with Docker (#1687)
## Description

Following up on @webyneter attempt in #1205, which is now getting outdated, I've tried to make Gulp task runner work with Docker. There is no documentation yet, but this seems to work locally with the custom bootstrap compilation...

- [x] Add a node image for local developement
- [x] Proxy the django image rather than localhost in Browser sync, pass header to keep hostname
- [x] Don't call the runserver command from Gulp, let docker-compose handle
- [x] Update package.json & gulpfile.js templates to reduce the number of unwanted empty lines
- [x] Use [multi-stage build](https://docs.docker.com/develop/develop-images/multistage-build/) in production to make sure the static assets are produced
- [x] Update documentation
- [x] Verify that the previous issue with static assets missing from production isn't there 

## Rationale

Currently, the static build isn't working nicely with Docker, extra manual setup is required.

Fixes #1762
2019-03-25 12:10:55 +00:00
Hana Quadara
85aea55fc6 add plugins to req file; remove pylint-common 2019-03-23 00:01:23 -04:00
Guilherme Fabrizio
7d1e90bdf5 Migrate to unified Sentry SDK (#1820)
The raven library is deprecated. Replace it by the new sentry-sdk library:

https://docs.sentry.io/error-reporting/quickstart/?platform=python

fixes #1818
2019-03-20 10:04:44 +00:00
Demetris
b312d516a4 Replace Caddy with Traefik (#1714)
## Description

Replace Caddy with Traefik

## Rationale

There is some trouble with the Caddy license (https://github.com/pydanny/cookiecutter-django/pull/1282#issuecomment-329617536) 

@drdaeman suggested using Traefik (https://github.com/pydanny/cookiecutter-django/pull/1282#issuecomment-353655273) which supports ACME and also plays very nice with Docker.

## Comments

I am currently using the proposed setup on a live site and it working great so far. If this PR is of interest to the maintainers, then I could commit more changes and take care of the documentation. Of course, any suggestions by the more experienced people around here, are welcome!
2019-03-19 09:32:45 +00:00
Bruno Alla
b142713ec6 Remove running collectstatic from Heroku docs, it's done during deployments 2019-03-13 14:31:17 +00:00
yunti
1c5c4e52c0 Add automatic migrations to heroku deploys (#1951)
heroku now has a new feature for running tasks as part of deployment. Perfect for automatic migrations.
https://devcenter.heroku.com/articles/release-phase#specifying-release-phase-tasks
2019-03-11 21:05:31 +00:00
keithjeb
aea5c807f6 Change eager celery setting in local Docker (#1945)
[//]: # (Thank you for helping us out: your efforts mean great deal to the project and the community as a whole!)

[//]: # (Before you proceed:)

[//]: # (1. Make sure to add yourself to `CONTRIBUTORS.rst` through this PR provided you're contributing here for the first time)
[//]: # (2. Don't forget to update the `docs/` presuming others would benefit from a concise description of whatever that you're proposing)


## Description

[//]: # (What's it you're proposing?)

Added a note around CELERY_TASK_ALWAYS_EAGER = True in docker config for local development. This causes tasks to be executed on the 'main' thread rather than by the workers. I understand why that might be desirable, but thought it worth calling out incase (like me) it makes people think something is broken.


## Rationale

[//]: # (Why does the project need that?)

Ease of use/troubleshooting


## Use case(s) / visualization(s)

[//]: # ("Better to see something once than to hear about it a thousand times.")
2019-03-02 13:51:30 +00:00
Anuj
feebcf117f Added help for startapp 2018-12-18 17:07:35 +05:30
Gabriel Le Breton
aada594ada
Fix a typo in the documentation ✌️ 2018-12-01 03:13:15 -05:00
Fábio C. Barrionuevo da Luz
43559defad
Merge pull request #1871 from Afrowave/master
ADDED documentation on testing when developing locally with and without Docker.
2018-11-24 14:36:59 -03:00
Afrowave
53940411cc EDITED the developing locally doc. 2018-11-20 00:06:54 +03:00
canonnervio
197ab7f36e Modified command for Windows users (#1850)
* Modified command for Windows users

Added comment to use double quotes for heroku pg:backups setup under Windows.

* Added name to list
2018-11-17 09:59:38 +00:00
Bruno Alla
0de682f22d Update database setup instructions for developing locally 2018-09-29 12:30:19 +01:00
Bruno Alla
46ab5aefc7
Use a more specific version of python for venv 2018-09-16 20:04:50 +01:00
Bruno Alla
fa162dc970 Update linters page for better syntax highlighting 2018-09-15 21:26:13 +01:00
Bruno Alla
c51fd710d2 Update settings page
- Add a few missing settings
- Remove outdated ones
- Detail behaviour with URL for databases
2018-09-15 21:25:40 +01:00
Bruno Alla
993de2d409 Remove unused details for installing PostgreSQL, link to the official website 2018-09-15 21:24:22 +01:00
Bruno Alla
49e12332e8 Add a _static folder to silence Sphinx' warning 2018-09-15 21:23:29 +01:00
Bruno Alla
6dd64ddd53 Update documentation for bare metal local development
- Mention the need for Redis if Celery is selected
- Link to PostgreSQL & Redis download pages
- Detail better how to set the environment
- Improve internal links using Sphinx' :ref
- Remove unused link
2018-09-15 21:23:06 +01:00
Bruno Alla
078c1fb8ba Remove references to Compass as it's no longer required
Also it's no longer maintained: https://github.com/Compass/compass
2018-09-01 11:43:07 +01:00
Bruno Alla
ebcd5ec098 Cleanup outdated references to Grunt - fixes #1721 2018-08-30 20:34:56 +01:00
Diane DeMers Chen
0a858bf512 Add note about using keep_local_envs_in_vcs (#1735)
* Add note about using keep_local_envs_in_vcs

As a newbie, I wasn't sure about `keep_local_envs_in_vcs`, so I said yes, and when CC was building, it gave me the message: 
"[INFO]: .env(s) are only utilized when Docker Compose and/or Heroku support is enabled so keeping them does not make sense given your current setup." 
Seems like it could go in this documentation, and make things easier for newbies.

* Add me to CONTRIBUTORS.RST
2018-08-13 15:57:28 +03:00
Fábio C. Barrionuevo da Luz
b8e5896133
Merge pull request #1698 from pydanny/remove-inline-comments
remove inline comments of on heroku tutorial
2018-06-28 09:23:13 -03:00
Fábio C. Barrionuevo da Luz
49c73feebb
remove inline comments of on heroku tutorial 2018-06-28 09:00:53 -03:00
Nikita P. Shupeyko
3ac9902670 Rename project template Docker Compose volumes
Rationale: consistent image, volume etc. naming conventions
2018-06-27 19:52:06 +03:00
Nikita Shupeyko
275c13292c
Integrate Flower with Docker Compose setup (#1655)
* Integrate Flower with Docker Compose setup locally

* Remove alien worker celeryd option

* Move Flower COPY section below the worker's

* Remove set -o pipefail command from Flower start script

* Flower client authentication

* Override flower service image name

* Move flower service to the end of local.yml

* Install flower==0.9.2 in all environments

* Introduce production flower service

* Fix local flower start script

* Document Flower integration

* Prettify *.django envs

Rationale: consistency.

* Reference local environment Flower docs from the production's

* 'two more services' -> 'three more services'
2018-06-27 19:33:21 +03:00
Nikita Shupeyko
fe3f45ba7d
Rename DJANGO_SENTRY_DSN env to SENTRY_DSN (#1663)
Rationale: so that Heroku auto-provisioned Sentry addon, with its SENTRY_DSN config var is being connected to out-of-box
2018-05-27 22:36:13 +03:00
Nikita P. Shupeyko
ac82eab61c Remove cookiecutter option defaults from docs
Rationale: duplicate values
2018-05-21 21:35:49 +03:00
Emile Petrone
32f303f619 Added documentation for Docker deployment in detached mode 2018-05-20 12:37:36 -04:00
Bruno Alla
105f18efd0 Update deployment on Heroku to run migrations - refs #1646 2018-05-14 08:39:46 +01:00
saschalalala
6d4be405d8 Migrate to Django2 path urls (#1637)
* Change users urls to Django 2 paths

* Change config urls to Django 2 paths

* Change admin url setting to Django 2 path syntax

* Replace more admin urls

* Add myself to contributors.rst
2018-05-14 10:09:24 +03:00
Nikita P. Shupeyko
be1024cd06 Drop Grunt support
Closes #1636.
2018-05-13 13:51:01 +03:00
Nikita P. Shupeyko
906299ae39 Refactor POSTGRES_HOST env 2018-05-09 12:58:33 +03:00
Nikita Shupeyko
5c166b28a9
Remove "My Favorite Cookie" tutorial (#1633)
Closes #1611.
2018-05-06 19:37:57 +03:00
Nikita P. Shupeyko
a22390ad4f Introduce debug cookiecutter option 2018-05-05 13:47:25 +03:00
Marlon
21dd198761 Update deployment-on-heroku.rst (#1630)
`heroku python manage.py migrate` no longer necessary, since it's now run by the release process in the Procfile. Related to https://github.com/pydanny/cookiecutter-django/pull/1615
2018-05-05 12:28:46 +03:00
Nikita Shupeyko
b4d0416530
Fix PostgreSQL backup restore (#1628)
* Export PG* envs when backing up postgres

* Export PG* envs when restoring postgres from backup

* Prevent postgres connection from dropping all at ones

* Alter postgres backups docs  

Include another crucial prerequisite.

* "feel free switching" -> "feel free to switch"

* Address the feedback
2018-05-05 12:27:27 +03:00
Daniel Roy Greenfeld
3f753e0411
First pass at running black across the project (#1602) 2018-04-08 17:03:29 -05:00
MaziyarMK
0e7005d3d1
Fixes heroku deployment error
Specifically fixes this confusing error: ModuleNotFoundError: No module named "'config"
The single quotes are not required in the heroku config vars.
2018-04-08 10:04:31 +04:00
Nikita P. Shupeyko
418b53bf77 Rename use_sentry_for_error_reporting to use_sentry
Rationale: consistency
2018-04-03 12:12:26 +03:00
Bruno Alla
53623ae1fe Document server error when missing Mailgun config
Fixes #789
2018-03-26 23:31:10 +01:00
Wan Liuyang
d1198f63b1
Drop Opbeat (#1578) 2018-03-21 19:54:27 +08:00
Nikita Shupeyko
bcd0a8c46e
Fix & improve PostgreSQL backup/restore scripts (#1571)
* Fix & imporve postgres backup/restore scripts

* Update PostgreSQL backup/restore docs

* Fix postgres Dockerfile regression

* Extend error messages in PostgreSQL maintenance scipts
2018-03-14 13:44:16 +03:00
Nikita P. Shupeyko
a31f5090d1 Update the docs 2018-03-09 21:55:30 +03:00
Nikita P. Shupeyko
9cd0ee0272 Document merge_production_dotenvs_in_dotenv.py usage 2018-03-09 13:16:56 +03:00
Nikita P. Shupeyko
5543359382 Distinguish between POSTGRES_DB and POSTGRES_USER
Closes #1301.
2018-03-08 19:04:10 +03:00
Nikita Shupeyko
3f8aa26d0f
Group environment variables by the corresponding directories (#1295)
* Update generated project's .gitignore

* Post-gen gitignore .env/ and .env

* Fix linesep between gitignored entries

* Persist `.env/**/*` files into cookiecutter-django's VCS

* Rename .env/ to .envs/

* Reference the newly created .envs/**/.* files in local.yml

* Reference the newly created .envs/**/.* files in production.yml

* Delete .env.example

* Refactor post-gen-project.py

Closes #1299.

* Implement production-dotenv-files-to-dotenv-file merge script

* Create shared PyCharm Run Configuration for the automation script

* Randomize POSTGRES_PASSWORD in ./envs/(.local|.production)/.postgres

* Default POSTGRES_PASSWORD and POSTGRES_USER to random values

* Fix jinja linebreaks in local.yml

* Spaces in production.yml

* Fix post-merge leftovers & set DJANGO_ADMIN_URL automatically

* Prettify here and there

* Fix FileNotFoundError

* Leave a TODO in post_gen_hook.py

* Introduce keep_local_envs_in_vcs option

* Remove envs when not opted for

* Inline pre_gen_project.py if-condition

* Get rid of PROJECT_DIR_PATH in post_gen_project.py

* Clean up the docs

* Match copyright notices

* Document envs ins and outs
2018-03-08 15:56:15 +03:00
Eric Groom
f67f37a463 update grunt-sass to latest version (#1544)
* update grunt-sass

* add to contributors

* update gulp deps

* update grunt deps

* add convenience run script to grunt and gulp configurations
2018-03-06 19:46:21 +03:00
Bruno Alla
6ef30b1741 Merge branch 'master' into simplify-environment
# Conflicts:
#	docs/deployment-on-heroku.rst
2018-03-06 09:55:28 +00:00
Nicholas
b4738d2ff3 Update Heroku deployment docs (#1548)
* Update Heroku deployment

Remove duplicate DJANGO_ADMIN_URL config, add SENTRY config

* Update deployment-on-heroku.rst
2018-03-06 12:44:44 +03:00
Melanie Crutchfield
9fca6019ec Update project-generation-options.rst (#1547)
Change small typo. "ones" should be "once".
2018-03-05 23:55:15 +01:00
Bruno Alla
82dcd2d30c Simplify Mailgun settings
When creating a Mailgun add-on on Heroku, the app gets some environment
variables by default:

    MAILGUN_API_KEY
    MAILGUN_DOMAIN

However, the cookiecutter names do not match and requires a manual step
from the user deploying. It's used elsewhere but shouldn't harm the
other deployment methods to rename these variables.

While updating the docs I noticed a variable that appear unused
DJANGO_MAILGUN_SERVER_NAME so this removes it from the documentation.
2018-03-05 17:56:45 +00:00
Bruno Alla
baf08b2f5f Document Gunicorn worker concurrency 2018-03-05 17:30:13 +00:00
Nikita P. Shupeyko
e4353a41ed Update project generation options docs 2018-03-05 13:54:35 +03:00
Nikita P. Shupeyko
00fbf63939 Document use_travisci cookiecutter option 2018-03-05 13:12:33 +03:00
Wan Liuyang
5f068dd972 Revert environment variables and update docs 2018-02-28 11:33:39 +08:00
Wan Liuyang
39d2000856 Merge branch 'master' of github.com:sfdye/cookiecutter-django into use-aws-roles 2018-02-28 10:16:48 +08:00
Nikita Shupeyko
86e33e8714
Refactor *_gen_project hooks (#1490)
* Fix ./hooks/pre_gen_project.py asking user to select an option once only

+ prettify output

* Fix pre_gen hook not really exiting when it should

* Refactor & prettify ./hooks/post_gen_project.py

* Ensure same POSTGRES_USER is set across environments

+ get rid of env.example in favor of pre-generated .env.
2018-02-07 22:52:52 +03:00
Bruno Alla
090c81731b
Merge pull request #1418 from reggieriser/django_python_upgrade_cleanups
Fixing leftovers from migration to Django 1.11 and Python 3.6.
2018-02-07 14:52:27 +00:00
Reggie Riser
3512bb6c32
Delete deployment-with-elastic-beanstalk.rst 2018-02-06 17:18:03 -05:00
Wan Liuyang
7aabfa0c36 Fix typo and revert AWS environment variable 2018-02-06 15:52:34 +08:00
Wan Liuyang
fd2e917ceb Use AWS IAM roles
- Remove usage of AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
- Add instructions to set up IAM role
2018-02-06 15:14:37 +08:00
Bruno Alla
af12f39996 Improve custom_bootstrap_compilation option (#1429)
* Add Bootstrap to package.json in case of custom_bootstrap_compilation

* Update JS task runners and base HTML to handle custom scss compilation

* Generate a vendors.js with custom bootstrap compilation + Gulp

* Update documentation accordingly

* Add missing if/endif in gulpfile

* Update to Bootstrap v4 final
2018-01-20 17:05:12 -08:00
Daniel Roy Greenfeld
793a46ba45 Removed expiramental elastic beanstalk support and bumped official Django version to 1.11.9 2018-01-15 12:33:51 -08:00
pdehaye
184b3584a0 Helpful warning for Beanstalk/python 3.6 (#1432) 2018-01-04 17:54:58 -08:00
Reggie Riser
f7bd7a5814 Fixing leftovers from migration to Django 1.11 and Python 3.6. 2018-01-03 08:44:54 -05:00
Rafael Laverde
1d55a608c0 Change pep 8 for pycodestyle in docs and project requirements (#1332)
* Change pep8 for pycodestyle in the docs.

* Change pep8 for pycodestyle in project requirements.
2017-09-17 21:56:15 +03:00
Jannis Gebauer
5492a2b387 update with instructions for caddy, removing nginx 2017-08-14 11:48:17 +02:00
Jannis Gebauer
8801c50867 switch to caddy (#1282) 2017-08-11 11:16:15 +02:00
Ben Warren
ffedad9103 Add project generation option docs (#1267)
* Add project generation option docs

* Alter wording
2017-08-01 20:06:07 +03:00
Nathan Victor
b4e68a6bf1 Update 404 with how to link (#1244) 2017-07-31 16:57:33 +03:00
Shupeyko Nikita
fe903e5c14 Fix docs erros/typos (#1264)
* Fix #.1

* Fix #.2

[Running management commands: "docker-compose -f production.yml run" to "docker-compose -f local.yml run'](https://cookiecutter-django.readthedocs.io/en/latest/developing-locally-docker.html#running-management-commands).

* Fix #.3

Designate @bertdemiranda as a contributor (#1242).
2017-07-31 13:27:58 +03:00
Bert de Miranda
ce33b0c498 Update developing-locally-docker.rst (#1242) 2017-07-31 13:16:38 +03:00
Shupeyko Nikita
37837e9902 Fix ALLOWED_HOSTS (#1164) 2017-07-30 15:43:01 +03:00
Shupeyko Nikita
e889316b11 Rename dev.yml to local.yml (#1227)
* Rename dev.yml to local.yml

Closes #1226.

* Rename docker-compose.yml to production.yml
2017-07-14 17:09:41 +03:00
Shupeyko Nikita
1f7be4eb57 Revert "Node.JS + docker-compose = ♥" (#1206)
* Revert "[Fix] #1173 Nginx SSL redirect loop (#1174)"

This reverts commit cabcc7b106.

* Revert "Fix Getting Up and Running Locally With Docker doc sphinx warnings (#1165)"

This reverts commit 83c8594203.

* Revert "Fix index.rst sphinx warnings (#1166)"

This reverts commit 51dd0b5e73.

* Revert "Pin mailhog Docker image to v1.0.0 (#1201)"

This reverts commit d9f870461b.

* Revert "Node.JS + docker-compose = ♥ (#1128)"

This reverts commit 4b06fe3958.
2017-06-21 23:12:22 +03:00
Shupeyko Nikita
83c8594203 Fix Getting Up and Running Locally With Docker doc sphinx warnings (#1165) 2017-06-20 23:29:56 +03:00
Shupeyko Nikita
51dd0b5e73 Fix index.rst sphinx warnings (#1166) 2017-06-20 23:29:31 +03:00