mirror of
https://github.com/cookiecutter/cookiecutter-django.git
synced 2024-11-30 05:24:01 +03:00
156 lines
3.9 KiB
ReStructuredText
156 lines
3.9 KiB
ReStructuredText
Getting Up and Running with Docker
|
|
==================================
|
|
|
|
.. index:: Docker
|
|
|
|
The steps below will get you up and running with a local development environment.
|
|
|
|
Prerequisites
|
|
--------------
|
|
|
|
* docker
|
|
* docker-machine
|
|
* docker-compose
|
|
* virtualbox
|
|
|
|
If you don't already have these installed, you can get them at:
|
|
|
|
* https://github.com/docker/toolbox/releases
|
|
* https://www.virtualbox.org/wiki/Downloads
|
|
|
|
Go to the Root of your Project
|
|
------------------------------
|
|
|
|
All of these commands assume you are in the root of your generated project.
|
|
|
|
Create the Machine
|
|
-------------------
|
|
|
|
::
|
|
|
|
$ docker-machine create --driver virtualbox dev1
|
|
|
|
**Note:** If you want to have more than one docker development environment, then
|
|
name them accordingly. Instead of 'dev1' you might have 'dev2', 'myproject',
|
|
'djangopackages', et al.
|
|
|
|
Make the new machine the active unit
|
|
-------------------------------------
|
|
|
|
This tells our computer that all future commands are specifically for the just
|
|
created machine. Using the ``eval`` command we can switch machines as needed.
|
|
|
|
::
|
|
|
|
$ eval "$(docker-machine env dev1)"
|
|
|
|
Get the IP Address
|
|
--------------------
|
|
|
|
Acquiring the IP Address is good for two reasons:
|
|
|
|
1. Confirms that the machine is up and running.
|
|
2. Tells us the IP address where our Django project is being served.
|
|
|
|
::
|
|
|
|
$ docker-machine ip dev1
|
|
123.456.789.012
|
|
|
|
Saving changes
|
|
--------------
|
|
|
|
If you are using OS X or Windows, you need to create a /data partition inside the
|
|
virtual machine that runs the docker deamon in order make all changes persistent.
|
|
If you don't do that your /data directory will get wiped out on every reboot.
|
|
|
|
To create a persistent folder, log into the virtual machine by running:
|
|
|
|
::
|
|
|
|
$ docker-machine ssh dev1
|
|
$ sudo su
|
|
$ echo 'ln -sfn /mnt/sda1/data /data' >> /var/lib/boot2docker/bootlocal.sh
|
|
|
|
|
|
In case you are wondering why you can't use a host volume to keep the files on
|
|
your mac: As of `boot2docker` 1.7 you'll run into permission problems with mounted
|
|
host volumes if the container creates his own user and chown's the directories
|
|
on the volume. Postgres is doing that, so we need this quick fix to ensure that
|
|
all development data persists.
|
|
|
|
Build the Stack
|
|
---------------
|
|
|
|
This can take a while, especially the first time you run this particular command
|
|
on your development system.
|
|
|
|
::
|
|
|
|
$ docker-compose build
|
|
|
|
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.
|
|
|
|
::
|
|
|
|
$ docker-compose -f dev.yml up
|
|
|
|
If you want to run the entire system in production mode, then run:
|
|
|
|
::
|
|
|
|
$ docker-compose up
|
|
|
|
If you want to run the stack in detached mode (in the background), use the ``-d`` argument::
|
|
|
|
::
|
|
|
|
$ docker-compose up -d
|
|
|
|
Running bash commands (i.e. management commands)
|
|
----------------------------------------------------
|
|
|
|
This is done using the ``docker-compose run`` command. In the following examples
|
|
we specify the ``django`` container as the location to run our management commands.
|
|
|
|
Example:
|
|
|
|
$ docker-compose run django python manage.py migrate
|
|
$ docker-compose run django python manage.py createsuperuser
|
|
|
|
|
|
|
|
Deprecated
|
|
==========
|
|
|
|
**Note:** This segment of documentation is being kept in this location as part of our documentation transition process.
|
|
|
|
|
|
The steps below will get you up and running with a local development environment. We assume you have the following installed:
|
|
|
|
* docker
|
|
* docker-compose
|
|
|
|
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
|
|
|
|
|
|
To migrate your app and to create a superuser, run::
|
|
|
|
$ docker-compose run django python manage.py migrate
|
|
|
|
$ docker-compose run django python manage.py createsuperuser
|