Skip to content

Latest commit

 

History

History
71 lines (56 loc) · 2.56 KB

README.md

File metadata and controls

71 lines (56 loc) · 2.56 KB

Django Development With Docker Compose and Machine

Featuring:

  • Docker v18.09.2
  • Docker Compose v1.23.2
  • Docker Machine v0.16.1
  • Python 3.7.3
  • Postgresql
  • MySQL 5.7

Original Blog post -> https://realpython.com/blog/python/django-development-with-docker-compose-and-machine/

Building on the original repo, this repo adds the following capabilities;

  1. Is compatible with the original repo and simplifies running the compose stack
  2. Adds flexibility by using environment variables to make the service highly configurable
  3. Allows switching between postgres or mysql database.
  4. Allows the use of an existing database configured by the DB_TYPE=remote & DB_* environment variables
  5. Runs migrations before starting django
  6. Adds live reload capability for the django code

General Instructions

  1. Start new machine - docker-machine create -d virtualbox dev
  2. Configure your shell to use the new machine environment - eval $(docker-machine env dev)
  3. (Optional) Update .env to match your requirements e.g. Set HOST_NGINX_PORT=80
  4. Build and Start services - docker-compose up -d
  5. Grab IP - docker-machine ip dev - and view in your browser Example: 
    $ docker-machine ip dev
192.168.99.101
    The app will be available at http://:<HOST_NGINX_PORT>
  6. (Optional) If you did not set HOST_NGINX_PORT i.e. HOST_NGINX_PORT=0, show Ports - docker-compose ps Example: 
    $ docker-compose ps
dockerizingdjango_nginx_1   /usr/sbin/nginx    Up    0.0.0.0:33126->80/tcp
    In this example, the app is available at http://192.168.99.101:33126.

Advanced Usage

To use existing remote database, change the following in .env;

  1. DJANGO_DB_* variables to match your remote database
  2. DB_TYPE=remote
  3. Run docker-compose up -d

To switch databases, change the following in .env;

  1. DB_TYPE to mysql, postgres or sqlite
  2. If database was already started previously, run docker-compose stop database && docker-compose rm -f database
  3. Run docker-compose up -d

To clean up, reset or start over

  1. Run docker-compose down -v. Note that that this will delete all your containers and volumes defined in the compose file.

Troubleshooting

If you encounter this error

Cannot start service web: driver failed programming external connectivity on endpoint
 failed: port is already allocated
Encountered errors while bringing up the project.
  • Modify your env file and change the exposed ports on host
  • Alternatively, shut down services on the host that are bound to the ports
  • Once done run docker-compose up -d