dockdj 1.3.0

Deploy the Django app to Ubuntu server as docker container.

Dockdj

Production Quality Django Deployments

Dockdj is a command line tool that allows you to deploy any Django app to your own server.

This tool is inspired by Meteor up tool which is used to deploy Meteor.js app.

You can install and use Dockdj on Linux, Mac and Windows. It can deploy to servers running Ubuntu 14 or newer.

Dockdj is powered by Docker, making deployment easy to manage and reducing server specific errors.

Requirement

This tool needs Python > 3.6

Install

Install the dockdj using following command

$ pip install dockdj

Usage

Lets say you have a Django project with following directory structure.

parent
    - hello_world
    |    - hello_world
    |        - wsgi.py

Create a sibling to the django project directory for saving dockdj settings files which will be used to deploy the django app

$ mkdir deploy

parent
    - hello_world
    |    -hello_world
    |        -wsgi.py
    - deploy

$ cd deploy

$ dockdj init

This will create two files dockdj.yaml and settings.py

parent
    - hello_world
    |    -hello_world
    |        -wsgi.py
    - deploy
        - dockdj.yaml
        - settings.py

Modify the dockdj.yaml file to enter server configuration and app details. Initial file looks as follows.

---
servers:
- host: 1.2.3.4
  # must be sudo without password
  username: root
  pem: "~/.ssh/id_rsa"
  # optional
  env:
    PER_SERVER: abc
app:
  # Any name used by script to name docker
  name: abc
  # Django app dir which contains wsgi.py and settings.py
  django_app: 'hello_world'
  requirements_file: 'requirements.txt'
  port: 80
  # Django app dir which contains wsgi.py and settings.py
  path: "/path/to/project"
  docker:
    image: python:3.7
  env:
    FOO: foo
    BAR: bar

settings.py fill contains settings which will be appended to your django app's settings.py file. You can enter production related settings or override development settings here. Initial settings.py file looks like as follows.

DEBUG = False

# Add the your servers host name or ip address
ALLOWED_HOSTS = ['1.2.3.4', 'www.example.com']

After editing these two files appropriately run following command to setup server. This will install docker in Ubuntu servers if not already installed.

$ dockdj setup

To deploy the django app run following.

$ dockdj deploy

This will create docker image of your Django app. Runs the Django app using gunicorn and binds the port to the port specified in dockdj.yaml.

Django manage.py

You can run manage.py script on server using manage sub command as follows.

$ dockdj manage migrate