Getting Up and Running Locally With Docker¶
The steps below will get you up and running with a local development environment. All of these commands assume you are in the root of your generated project.
Prerequisites¶
You’ll need at least Docker 1.10.
If you don’t already have it installed, follow the instructions for your OS:
- On Mac OS X, you’ll need Docker for Mac
- On Windows, you’ll need Docker for Windows
- On Linux, you’ll need docker-engine
Attention Windows users¶
Currently PostgreSQL (psycopg2 python package) is not installed inside Docker containers for Windows users, while it is required by the generated Django project. To fix this, add psycopg2 to the list of requirements inside requirements/base.txt:
# Python-PostgreSQL Database Adapter
psycopg2==2.6.2
Doing this will prevent the project from being installed in an Windows-only environment (thus without usage of Docker). If you want to use this project without Docker, make sure to remove psycopg2 from the requirements again.
Build the Stack¶
This can take a while, especially the first time you run this particular command on your development system:
$ docker-compose -f dev.yml build
If you want to build the production environment you don’t have to pass an argument -f, it will automatically use docker-compose.yml.
Boot the System¶
This brings up both Django and PostgreSQL.
The first time it is run it might take a while to get started, but subsequent runs will occur quickly.
Open a terminal at the project root and run the following for local development:
$ docker-compose -f dev.yml up
You can also set the environment variable COMPOSE_FILE pointing to dev.yml like this:
$ export COMPOSE_FILE=dev.yml
And then run:
$ docker-compose up
Running management commands¶
As with any shell command that we wish to run in our container, this is done
using the docker-compose run command.
To migrate your app and to create a superuser, run:
$ docker-compose -f dev.yml run django python manage.py migrate
$ docker-compose -f dev.yml run django python manage.py createsuperuser
Here we specify the django container as the location to run our management commands.
Production Mode¶
Instead of using dev.yml, you would use docker-compose.yml.
Other Useful Tips¶
Make a machine the active unit¶
This tells our computer that all future commands are specifically for the dev1 machine.
Using the eval command we can switch machines as needed.
$ eval "$(docker-machine env dev1)"
Detached Mode¶
If you want to run the stack in detached mode (in the background), use the -d argument:
$ docker-compose -f dev.yml up -d
Debugging¶
ipdb¶
If you are using the following within your code to debug:
import ipdb; ipdb.set_trace()
Then you may need to run the following for it to work as desired:
$ docker-compose run -f dev.yml --service-ports django
django-debug-toolbar¶
In order for django-debug-toolbar to work with docker you need to add your docker-machine ip address (the output of `Get the IP ADDRESS`_) to INTERNAL_IPS in local.py
You may need to add the following to your css in order for the django-debug-toolbar to be visible (this applies whether Docker is being used or not):
/* Override Bootstrap 4 styling on Django Debug Toolbar */
#djDebug[hidden], #djDebug [hidden] {
display: block !important;
}
#djDebug [hidden][style='display: none;'] {
display: none !important;
}