Commit Graph

71 Commits

Author SHA1 Message Date
Shayan Karimi
a1d34a08af
Split the docs from local.yml and build the service in CI (#4909)
* Split the docs from local.yml and build the service in CI

* Change docs build in our CI docker tests
2024-03-18 19:26:18 +00:00
Vageeshan Mankala
73137e1764
Replace Mailhog with Mailpit (#4551)
* modifying cookiecutter.json with new config

* updated docker image and its local settings

* replacing  use_mailhog conditions

* replacing use_mailhog condition in docs

* Updating docs with mailpit
2023-09-06 20:41:01 +01:00
Imran Rahman
0ecb9ce299
Explicitly state that docker exec does not work for running management commands (#4487)
Co-authored-by: Imran Rahman <imranrahman.ix@gmail.com>
2023-07-27 14:42:04 +01:00
hleroy
01962fb3a1
Add Webpack instructions for developping locally with HTTPS (#4486)
* Add Webpack instructions for developping locally with HTTPS

* Fix formatting of code blocks

---------

Co-authored-by: Bruno Alla <browniebroke@users.noreply.github.com>
2023-07-27 12:28:49 +01:00
Imran Rahman
f567b5f685
update docs docker-compose -> docker compose (#4463)
Co-authored-by: Imran Rahman <imranrahman.ix@gmail.com>
2023-07-24 10:42:51 +01:00
villancikos
1507360b1f
Added webpack tip for port 3000 instead of 8000 in developing-locally… (#4413)
* Added webpack tip for port 3000 instead of 8000 in developing-locally.rst

* Rework Webpack/Gulp documentation to be more consistent across the board

---------

Co-authored-by: Bruno Alla <alla.brunoo@gmail.com>
2023-07-10 18:35:57 +01:00
Birtibu
1a9d301550
Document how to add 3rd party packages with Docker (#4279)
* Update developing-locally-docker.rst

Add 3rd party python packages

* Update docs/developing-locally-docker.rst

Co-authored-by: Bruno Alla <browniebroke@users.noreply.github.com>

* Update docs/developing-locally-docker.rst

Co-authored-by: Bruno Alla <browniebroke@users.noreply.github.com>

---------

Co-authored-by: Bruno Alla <browniebroke@users.noreply.github.com>
2023-04-18 20:42:15 +01:00
duffn
1f300e0ca2
Add note about which service to request when running locally with Docker & Webpack or Gulp (#4130)
* Add note about running Webpack locally with Docker

* Add note about running Gulp locally with Docker
2023-02-05 10:00:28 +00:00
Omer-5
ed90ead15f
Improve documentation for Getting started with Docker (#4003)
Fix https://github.com/cookiecutter/cookiecutter-django/issues/3971
2022-12-13 21:32:57 +00:00
Bruno Alla
dc8ad895bb Fix link, formatting & a typo 2022-03-20 15:43:37 +00:00
Pedro Campos
4f408810fc
Avoid docker image/volume collision by prefixing with project slug (#3528)
Co-authored-by: Bruno Alla <alla.brunoo@gmail.com>
Co-authored-by: Bruno Alla <browniebroke@users.noreply.github.com>
2022-01-17 08:53:56 +00:00
Bruno Alla
407a7d8bbc
Setup pre-commit for the template files (#3433) 2021-11-26 15:41:50 +00:00
Meraj
112c29d77b
Updated developing-locally-docker.rst
changed wrong hyperlink in Prerequisites section
2021-10-01 17:02:07 +03:30
Keith Callenberg
a4a6cbf90c
Fix several minor typos 2021-08-19 16:43:44 -04:00
Abdul Qoyyuum
3dfb5d1564
Update developing-locally-docker.rst 2021-08-07 16:43:47 +01:00
Abdul Qoyyuum
370cefdf24
How to pre-commit in Docker Development
It is clear that pre-commit cannot work inside Docker containers and it can only work with git stored on the local machine since its not in a shared volume with the containers. Therefore, it should be noted that anyone who uses this cookicutter with pre-commit already generated by default in every project, should start using pre-commit into their general workflow.
2021-08-06 15:55:40 +01:00
Corey Garvey
4f72047446
Updating production path to be hidden folder 2020-08-19 15:40:13 +01:00
Jimmy Gitonga
ddcafff94f
Update docs/developing-locally-docker.rst
Co-authored-by: Bruno Alla <browniebroke@users.noreply.github.com>
2020-08-14 01:01:17 +03:00
Jimmy Gitonga
59d92d9eb4
Update docs/developing-locally-docker.rst
Co-authored-by: Bruno Alla <browniebroke@users.noreply.github.com>
2020-08-14 01:00:17 +03:00
Jimmy Gitonga
bd0ed76421 ADD instructions not include the security certificates in the repo. 2020-07-07 08:07:51 +03:00
Jimmy Gitonga
aacdd97c4e ADD instructions on how to set up a secure development environment. 2020-07-07 01:59:25 +03:00
Hannah Lazarus
f9c20af456 Add container_names for docker commands
container_names make it possible to run docker commands
without looking up container hash
use in dev.yml
2020-04-24 16:31:20 -04:00
Bruno Alla
d04b128e0f Typo in doc reference 2019-05-29 14:55:38 +01:00
Bruno Alla
3de1715b12 Add troubleshooting section regarding Posgres auth issues - fixes #1678 2019-05-29 14:54:18 +01:00
Bruno Alla
edf2eba6af Remove outdated warning in Local docker docs 2019-04-02 10:36:42 +01: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
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
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 P. Shupeyko
906299ae39 Refactor POSTGRES_HOST env 2018-05-09 12:58:33 +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
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
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
4b06fe3958 Node.JS + docker-compose = ♥ (#1128)
* Introduce static asset build infrastructure

* Enhance gulpfile.js

* Introduce node service

* BrowserSync debug-only support

* Remove newline before  BrowserSync debug-only support section

* FIx node Dockerfile package.json COPY

* Try fiixing node Dockerfile package.json COPY ones again

* Switch to `node:7-slim`

* Try switching to node:6

To account for possible node:7 docker-compose incompatibiltiy

* Revert "Try switching to node:6"

This reverts commit 62cc02df1a.

* Try switcging workdir to /app

* Try utilizing relative package.json path

* Resetting to the last version working locally with docker-compose 1.11.x

* Build upon the latest node:7.9-slim

* Stop dockerignoring package.json

* Fix typo

* Try a different package.json path

* Revert "Try a different package.json path"

This reverts commit f29f8500b8.

* Revert "Fix typo"

This reverts commit 02033729b5.

* Revert "Stop dockerignoring package.json"

This reverts commit 63c5491546.

* Upgrade docker-engine and docker-compose used by Travis CI

* Fix .travis.yml comments

* Inline docker-engine and docker-compose versions

* DEBUG: pwd

* Revert "DEBUG: pwd "

This reverts commit 6c2ed4321a.

* Try copying package.json to the same dir as node Dockerfile's

* Revert "Try copying package.json to the same dir as node Dockerfile's"

This reverts commit 24340a0783.

* Try out node:7.9

* Revert "Try out node:7.9"

This reverts commit 32286d33c2.

* Revert "Upgrade docker-engine and docker-compose used by Travis CI"

* Get rid of npm-check-updates

Reason: Reserved for the upcoming PR

* Get rid of npm-check

Reason: Reserved for the upcoming PR

* Get rid of 'standard' npm package

Reason: Reserved for the upcoming PR

* Clean up package.json

* Preserve package.json uncoditionally

Since we now have *unconditional* node.js integration, `package.json` must be out there whenever `node` service gets built

* Upgrade node service image to 7.10

* Document Node.js-Docker integration

* Fix gulpfile.js images region name

* Get rid of Gulp migrate task

* Document Gulp-Docker integration

* Introduce static asset build infrastructure

* Enhance gulpfile.js

* Introduce node service

* BrowserSync debug-only support

* Remove newline before  BrowserSync debug-only support section

* FIx node Dockerfile package.json COPY

* Try fiixing node Dockerfile package.json COPY ones again

* Switch to `node:7-slim`

* Try switching to node:6

To account for possible node:7 docker-compose incompatibiltiy

* Revert "Try switching to node:6"

This reverts commit 62cc02df1a.

* Try switcging workdir to /app

* Try utilizing relative package.json path

* Resetting to the last version working locally with docker-compose 1.11.x

* Build upon the latest node:7.9-slim

* Stop dockerignoring package.json

* Revert "Stop dockerignoring package.json"

This reverts commit 63c5491546.

* Fix typo

* Revert "Fix typo"

This reverts commit 02033729b5.

* Try a different package.json path

* Revert "Try a different package.json path"

This reverts commit f29f8500b8.

* Upgrade docker-engine and docker-compose used by Travis CI

* Fix .travis.yml comments

* Inline docker-engine and docker-compose versions

* DEBUG: pwd

* Revert "DEBUG: pwd "

This reverts commit 6c2ed4321a.

* Try copying package.json to the same dir as node Dockerfile's

* Revert "Try copying package.json to the same dir as node Dockerfile's"

This reverts commit 24340a0783.

* Try out node:7.9

* Revert "Try out node:7.9"

This reverts commit 32286d33c2.

* Revert "Upgrade docker-engine and docker-compose used by Travis CI"

* Get rid of npm-check-updates

Reason: Reserved for the upcoming PR

* Get rid of npm-check

Reason: Reserved for the upcoming PR

* Get rid of 'standard' npm package

Reason: Reserved for the upcoming PR

* Clean up package.json

* Preserve package.json uncoditionally

Since we now have *unconditional* node.js integration, `package.json` must be out there whenever `node` service gets built

* Upgrade node service image to 7.10

* Document Node.js-Docker integration

* Fix gulpfile.js images region name

* Get rid of Gulp migrate task

* Document Gulp-Docker integration

* Remove Gulp-Docker integraton not supported initialization message
2017-06-20 22:48:17 +03:00
Cristian Samaniego
7c7176d4f9 Fix ipdb docker-compose needed command (#1175)
'run' must be after the -f flag
2017-05-19 21:26:20 +03:00
Jimmy Gitonga
f4ef73efbf ADDED: HTTPS is on by default (#1025)
ADDED: HTTPS is on by default. This will give a new user an
understanding of why Cookie Django is set up securely for deployment in
a production environment.
2017-02-13 12:27:09 -08:00
Michael Gecht
3a7a75ad9c Add documentation for Docker users on Windows (#845)
* Added usage notice for Windows users with Docker

* Updated CONTRIBUTORS.rst
2016-11-02 10:12:06 +01:00
Andreas
9f2fa4a0a9 Update to use Docker for Mac/Windows (#786)
Removed sections about using Docker Toolbox with virtualbox and added links to Docker for Mac/Windows.
Docker for Mac/Windows uses native virtual machines instead of virtualbox and introduces many improvements.
See: https://blog.docker.com/2016/03/docker-for-mac-windows-beta/

Resolves: #706
2016-09-12 15:53:21 +02:00
Daniel Roy Greenfeld
0a6b06ebe4 Breakup the backups section for docker into its own document 2016-06-14 14:32:14 -07:00
Audrey Roy Greenfeld
ad4082ceae Minor doc improvements 2016-06-13 08:40:48 -07:00
kappataumu
eeae4e8978 Move e-mail backend setup info for docker to the appropriate section 2016-06-13 12:56:12 +00:00
mjsisley
fd9795992a sync with master 2016-06-03 17:21:24 -07:00
mjsisley
6885547b6a Adding documentation for debugging with Docker (#575)
* Adding documentation for debugging with Docker

* Add -f dev.yml
2016-06-03 12:50:23 -07:00
mjsisley
329ff57551 Adding documentation for debugging with Docker 2016-06-03 06:04:16 -07:00