Deploy a Django App on App Platform :: DigitalOcean Documentation

Django is a powerful web framework that allows you to deploy your Python applications or websites. Django includes many features such as authentication, a custom database ORM (Object-Relational Mapper), and an extensible plugin architecture. Django simplifies the complexities of web development, allowing you to focus on writing code.

In this tutorial, you can configure a Django project and deploy it to DigitalOcean’s App Platform using GitHub.

Prerequisites

To complete this tutorial, you need:

A GitHub account.
Python3 installed on your local machine. You can follow the following tutorials for installing Python on Windows, Mac, or Linux.
A text editor. You can use Visual Studio Code or your favorite text editor.

Step 1: Creating a Python Virtual Environment for your Project

Before you get started, you need to set up our Python developer environment. You install your Python requirements within a virtual environment for easier management.

First, create a directory in your home directory that you can use to store all of your virtual environments:

mkdir ~/.venvs

Now create your virtual environment using Python:

python3 -m venv ~/.venvs/django

This creates a directory called django within your .venvs directory. Inside, it installs a local version of Python and a local version of pip. You can use this to install and configure an isolated Python environment for your project.

Before you install your project’s Python requirements, you need to activate the virtual environment. You can do that by typing:

source ~/.venvs/django/bin/activate

Your prompt should change to indicate that you are now operating within a Python virtual environment. It looks something like this: (django)user@host:~$.

With your virtual environment active, install Django, Gunicorn, dj-database-url, and the psycopg2 PostgreSQL adaptor with the local instance of pip:

pip install django gunicorn psycopg2-binary dj-database-url

Note

Note: When the virtual environment is activated (when your prompt has (django) preceding it), use pip instead of pip3, even if you are using Python 3. The virtual environment’s copy of the tool is always named pip, regardless of the Python version.

These packages do the following:

django - Installs the Django framework and libraries
gunicorn - A tool for deploying Django with a WSGI
dj-database-url - A Django tool for parsing a database URL
psycopg2 - A PostgreSQL adapter that allows Django to connect to a PostgreSQL database

Now that you have these packages installed, you need to save these requirements and their dependencies so App Platform can install them later. You can do this using pip and saving the information to a requirements.txt file:

pip freeze > requirements.txt

You should now have all of the software needed to start a Django project. You are almost ready to deploy.

Step 2: Creating the Django Project

Create your project using the django-admin tool that was installed when you installed Django:

django-admin startproject django_app

At this point, your current directory (django_app in your case) has the following content:

manage.py: A Django project management script.
django_app/: The Django project package. This should contain the __init__.py, settings.py, urls.py, asgi.py, and wsgi.py files.

This directory is the root directory of your project and is what we upload to GitHub. Navigate into this directory with the command:

cd django_app

Let’s adjust some settings before deployment.

Adjusting the Project Settings

Now that you’ve created a Django project, you need to modify the settings to ensure it runs properly in App Platform. Open the settings file in your text editor:

nano django_app/settings.py

Let’s examine our configuration one step at a time.

Reading Environment Variables

First, you need to add the os import statement in your django_app/settings.py file to be able to read environment variables:

import os

Setting the Secret Key

Next, you need to modify the SECRET_KEY directive in your django_app/settings.py file. This is set by Django on the initial project creation and has a randomly generated default value. It is unsafe to keep this hardcoded value in the code once it’s pushed to GitHub, so you should either read this from an environment variable or generate it when the application is started. To do this, add the following import statement at the top of the settings file:

from django.core.management.utils import get_random_secret_key

Now modify the SECRET_KEY directive to read in the value from the environment variable DJANGO_SECRET_KEY or generate the key if it does not find said environment variable:

SECRET_KEY = os.getenv("DJANGO_SECRET_KEY", get_random_secret_key())

Warning

Warning: If you don’t set this environment variable, then every time the app is re-deployed, this changes the key. This can have adverse effects on cookies and requires users to log in again every time this key changes. You can generate a key using an online password generator.

Setting Allowed Hosts

Now locate the ALLOWED_HOSTS directive. This defines a list of the server’s addresses or domain names that may be used to connect to the Django instance. Any incoming request with a Host header that is not in this list raises an exception. Django requires that you set this to prevent a certain class of security vulnerability.

In the square brackets, list the IP addresses or domain names that are associated with your Django server. Each item should be listed in quotations with entries separated by a comma. If you wish requests for an entire domain and any subdomains, prepend a period to the beginning of the entry.

App Platform supplies you with a custom URL as a default and then allows you to set a custom domain after you have deployed the application. Since you don’t know this custom URL until you have deployed the application, you should attempt to read the ALLOWED_HOSTS from an environment variable, so App Platform can inject this into your app when it launches.

We’ll cover this process more in-depth in a later section. But for now, modify your ALLOWED_HOSTS directive in your django_app/settings.py file to attempt to read the hosts from an environment variable. The environment variable can be set to either a single host or a comma-delimited list:

ALLOWED_HOSTS = os.getenv("DJANGO_ALLOWED_HOSTS", "127.0.0.1,localhost").split(",")

Setting the Debug Directive

Next you should modify the DEBUG directive in your django_app/settings.py file so that you can toggle this by setting an environment variable:

DEBUG = os.getenv("DEBUG", "False") == "True"

Here you used the getenv method to check for an environment variable named DEBUG. If this variable isn’t found, we should default to False for safety. Since environment variables reads as strings in App Platform, be sure to make a comparison to ensure that your variable is evaluated correctly.

Setting the Development Mode

Now create a new directive named DEVELOPMENT_MODE that you can set as an environment variable in your django_app/settings.py file. This is a helper variable that you use to determine when to connect to your Postgres database and when to connect to a local SQLite database for testing. You can use this variable later when setting up the database connection:

DEVELOPMENT_MODE = os.getenv("DEVELOPMENT_MODE", "False") == "True"

Configuring Database Access

Next, find the section that configures database access. It starts with DATABASES. The configuration in the file is for a SQLite database. App Platform allows you to create a PostgreSQL database for our project, so you need to adjust the settings to be able to connect to it.

Note

Warning: If you don’t change these settings and continue with the SQLite DB, your database is erased after every new deployment. App Platform doesn’t maintain the disk when re-deploying applications, and you lose your data.

Change the settings with your PostgreSQL database information. You can read in the database connection information and credentials from an environment variable, DATABASE_URL, that is provided by App Platform. Use the psycopg2 adaptor we installed with pip to have Django access a PostgreSQL database. You can use the dj-database-url package that was installed to get all of the necessary information from the database connection URL.

To facilitate with development of your application locally, you can also use an if statement here to determine if DEVELOPMENT_MODE is set to True and which database should be accessed. By default, this is set to False, and it attempts to connect to a PostgreSQL database. You also don’t want Django attempting to make a database connection to the PostgreSQL database when attempting to collect the static files, so you can write an if statement to examine the command that was executed and not connect to a database if you determine that the command given was collectstatic. App Platform automatically collects static files when the app is deployed.

First, in your django_app/settings.py file, install the sys library so you can determine the command that was passed to manage.py and the dj_database_url library to be able to parse the URL passed in:

import os
import sys
import dj_database_url

Next remove the current DATABASE directive block in your django_app/settings.py file and replace it with this:

if DEVELOPMENT_MODE is True:
    DATABASES = {
        "default": {
            "ENGINE": "django.db.backends.sqlite3",
            "NAME": os.path.join(BASE_DIR, "db.sqlite3"),
        }
    }
elif len(sys.argv) > 0 and sys.argv[1] != 'collectstatic':
    if os.getenv("DATABASE_URL", None) is None:
        raise Exception("DATABASE_URL environment variable not defined")
    DATABASES = {
        "default": dj_database_url.parse(os.environ.get("DATABASE_URL")),
    }

Next, move down to the bottom of the file and add a setting in your django_app/settings.py file indicating where the static files should be placed. When your Django app is deployed to App Platform, python manage.py collectstatic runs automatically. Set the route to match the STATIC_URL directive in the settings file:

STATIC_URL = "/static/"
STATIC_ROOT = os.path.join(BASE_DIR, "staticfiles")

Note

If you plan on storing static files in other locations outside of your individual Django-app static files, you need to add an additional directive to your django_app/settings.py file. This directive specifies where to find these files. Be aware that these directories cannot share the same name as your STATIC_ROOT. If you do not have extra static files do not include this setting.:

STATIC_URL = "/static/"
STATIC_ROOT = os.path.join(BASE_DIR, "staticfiles")
STATICFILES_DIRS = (os.path.join(BASE_DIR, "static"),)

Reviewing the Completed `settings.py` File

Your completed file should look like this:

from django.core.management.utils import get_random_secret_key
from pathlib import Path
import os
import sys
import dj_database_url

# Build paths inside the project like this: BASE_DIR / 'subdir'.
BASE_DIR = Path(__file__).resolve().parent.parent


# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/3.1/howto/deployment/checklist/

# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = os.getenv("DJANGO_SECRET_KEY", get_random_secret_key())

# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = os.getenv("DEBUG", "False") == "True"

ALLOWED_HOSTS = os.getenv("DJANGO_ALLOWED_HOSTS", "127.0.0.1,localhost").split(",")


# Application definition

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
]

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]

ROOT_URLCONF = 'django_app.urls'

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]

WSGI_APPLICATION = 'django_app.wsgi.application'


# Database
# https://docs.djangoproject.com/en/3.1/ref/settings/#databases
DEVELOPMENT_MODE = os.getenv("DEVELOPMENT_MODE", "False") == "True"

if DEVELOPMENT_MODE is True:
    DATABASES = {
        "default": {
            "ENGINE": "django.db.backends.sqlite3",
            "NAME": os.path.join(BASE_DIR, "db.sqlite3"),
        }
    }
elif len(sys.argv) > 0 and sys.argv[1] != 'collectstatic':
    if os.getenv("DATABASE_URL", None) is None:
        raise Exception("DATABASE_URL environment variable not defined")
    DATABASES = {
        "default": dj_database_url.parse(os.environ.get("DATABASE_URL")),
    }


# Password validation
# https://docs.djangoproject.com/en/3.1/ref/settings/#auth-password-validators

AUTH_PASSWORD_VALIDATORS = [
    {
        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
    },
]


# Internationalization
# https://docs.djangoproject.com/en/3.1/topics/i18n/

LANGUAGE_CODE = 'en-us'

TIME_ZONE = 'UTC'

USE_I18N = True

USE_L10N = True

USE_TZ = True


# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/3.1/howto/static-files/

STATIC_URL = "/static/"
STATIC_ROOT = os.path.join(BASE_DIR, "staticfiles")

# Uncomment if you have extra static files and a directory in your GitHub repo.
# If you don't have this directory and have this uncommented your build will fail
# STATICFILES_DIRS = (os.path.join(BASE_DIR, "static"),)

Warning

Note: There are values within settings.py that are specific to your project (such as WSGI_APPLICATION and ROOT_URLCONF) that are generated when you first setup your app. If you named your app something other than django_app and are going to copy and paste this code directly be sure to modify these settings to match your project. They are set correctly in the settings.py that was generated for you.

Save and close settings.py.

You’ve now finished configuring your Django app to run on App Platform. Next, you push the app to GitHub and deploy it to App Platform.

Step 3: Pushing the Site to GitHub

DigitalOcean App Platform deploys your code from GitHub repositories, so the first thing you need to do is get your site in a git repository and then push that repository to GitHub.

First, initialize your Django project as a git repository:

git init

When you work on your Django app locally, certain files get added that are unnecessary for deployment. Let’s exclude that directory by adding it to Git’s ignore list. Create a new file called .gitignore:

nano .gitignore

Now add the following code to the .gitignore file:

db.sqlite3
*.pyc

Save and close the file.

Now execute the following command to add files to your repository:

git add django_app/ manage.py requirements.txt static/

Make your initial commit:

git commit -m "Initial Django App"

Your files committed:

[master (root-commit) eda5d36] Initial Django App
 8 files changed, 238 insertions(+)
 create mode 100644 django_app/__init__.py
 create mode 100644 django_app/asgi.py
 create mode 100644 django_app/settings.py
 create mode 100644 django_app/urls.py
 create mode 100644 django_app/wsgi.py
 create mode 100644 manage.py
 create mode 100644 requirements.txt
 create mode 100644 static/README.md

Open your browser and navigate to GitHub, log in with your profile, and create a new repository called django-app. Create an empty repository without a README or license file.

Once you’ve created the repository, return to the command line to push your local files to GitHub.

First, add GitHub as a remote repository:

git remote add origin https://github.com/your_username/django-app

Next, rename the default branch main, to match what GitHub expects:

git branch -M main

Finally, push your main branch to GitHub’s main branch:

git push -u origin main

Your files transferred:

Enumerating objects: 12, done.
Counting objects: 100% (12/12), done.
Delta compression using up to 8 threads
Compressing objects: 100% (9/9), done.
Writing objects: 100% (12/12), 3.98 KiB | 150.00 KiB/s, done.
Total 12 (delta 1), reused 0 (delta 0)
remote: Resolving deltas: 100% (1/1), done.
To github.com:yourUsername/django-app.git
 * [new branch]      main -> main
Branch 'main' set up to track remote branch 'main' from 'origin'.

Enter your GitHub credentials when prompted to push your code.

Your code is now on GitHub and accessible through a web browser. Now you deploy your site to DigitalOcean’s App Platform.

Step 4: Deploying to DigitalOcean with App Platform

Once the code is pushed, visit https://cloud.digitalocean.com/apps and click Create App.

You are prompted to connect your GitHub account. Connect your account and allow DigitalOcean to access your repositories. You can then choose to let DigitalOcean have access to all of your repositories or to the ones you wish to deploy.

Click Install and Authorize to return to your DigitalOcean dashboard and continue creating your app.

Under the Repository section, select the your_account/django-app repository from the dropdown menu. Select your branch name and source directory. Choose whether to enable autoscaling. Then, click Next.

DigitalOcean detects that your project is a Python app and automatically populates a partial run command.

Click the Edit pencil icon next to the app. Then, click Edit to the right of the Run Command section. Your completed run command needs to reference your project’s WSGI file. In this example, this is at django_app.wsgi. So, your completed run command should be gunicorn --worker-tmp-dir /dev/shm django_app.wsgi.

Click Save to confirm the change, then click Back at the bottom of the page to return to the Resources page.

Here, you can click Edit Plan to select the appropriate plan to fit your needs, whether in Basic App or Professional App.

To set up your database, click the Add Resource button, then select Database and click Add. You are presented with the option of creating a new development database or using a previously-created DigitalOcean database. For this deployment, select the development database and name it db. Then, click the Create and Attach button.

Finally, click Next to proceed.

Next, you need to define the environment variables you declared in your project’s settings. App Platform has a concept of App-Wide Variables, which are environment variables that are provided by App Platform, such as APP_URL and APP_DOMAIN. The platform also maintains Component-Specific Variables, which are variables that are exported from your components. These are useful for determining your APP_DOMAIN beforehand so you can properly set DJANGO_ALLOWED_HOSTS. You can also use these variables to copy configuration settings from your database.

To read more about these different variables, consult the App Platform Environment Variable Documetation.

For your Django app to function, you need to set the following environment variables like so:

DJANGO_ALLOWED_HOSTS -> ${APP_DOMAIN}
- This allows us to know the randomly generated URL that App Platform provides and provide it to our app.
DATABASE_URL -> ${<NAME_OF_YOUR_DATABASE>.DATABASE_URL}
- In this case, we named our database db in the previous step, so this should be ${db.DATABASE_URL}
DEBUG -> True
- Set this to True for now to verify your app is functioning and set to False when it’s time for this app to be in production.
DJANGO_SECRET_KEY -> <A RANDOM SECRET KEY>
- You can either allow your app to generate this at every launch or pick a strong password with at least 32 characters to use as this key. Using a secure password generator is a good option for this.
- Don’t forget to click the Encrypt check box to ensure that your credentials are encrypted for safety.

Click Save.

Click Next until you reach the Review page. Review your app’s configuration and click Create Resources at the bottom of the page.

Once the build process completes, the interface shows you a healthy site. Now you need to access your app’s console through the Console tab and perform the Django first launch tasks by running the following commands:

python manage.py migrate - This performs your initial database migrations.
python manage.py createsuperuser - This prompts you for some information to create an administrative user.

Once you are done with that, click on the link to your app provided by App Platform.

This link should take you to the standard initial Django page.

And now you have a Django app deployed to App Platform. Any changes that you make and push to GitHub and automatically deploy.

Step 5: Deploying Your Static Files

Now that you’ve deployed your app, you may notice that your static files aren’t being loaded if you have DEBUG set to False. Django doesn’t serve static files in production and instead wants you to deploy them using a web server or CDN. Luckily, App Platform can do just that. App Platform provides free static asset serving if you are running a service alongside it, as you are doing with your app. So you’re going to deploy your same Django app but as a static site this time.

Once your app is deployed, click the Create button and choose Create Resources From Source Code to add a static site component.

Select the same GitHub repository as your deployed Django service. Click Next to continue.

Next, ensure that the main branch and Autodeploy are selected. Click Next to continue.

Click the Edit pencil icon next to the app. Then, click Edit to the right of the Resource Type section. Select Static Site from the dropdown menu, then click Save to confirm your change.

Click Edit to the right of the Output Directory section and set it to staticfiles. Your static files are collected into Output Directory of your app to match its STATIC_ROOT setting in settings.py. Click Save to confirm your change.

Then, click Edit to the right of the HTTP Request Routes section, then enter /static in the Routes field. Essentially we’ll have Django gather our static files and serve them. Set the route to what you set your STATIC_URL directive in your settings file. Click Save to confirm your change.

Click Back at the bottom of the page to return to the Resources page, then click Next until you finalize creation. When static files are paired with a service, it is free, so you don’t see any change in your bill. Now, if you have Debug set to False, you can see your static files properly displayed.

Summary

In this tutorial, you:

Set up a Django project.
Configured the Django project to connect to a database.
Deployed the app and its static files onto App Platform.

Any changes you commit and push to your repository are re-deployed, so you can now expand your application. You can find the example code for this tutorial in the DigitalOcean Sample Images Repository.

The example in this tutorial is a minimal Django project. Your app might have more applications and features, but the deployment process is the same.

What’s Next?

Once you have deployed the app and used it, you can delete the application or deploy other sample applications.

Deploy a Django App on App Platform

Prerequisites

Step 1: Creating a Python Virtual Environment for your Project

Step 2: Creating the Django Project

Adjusting the Project Settings

Reading Environment Variables

Setting the Secret Key

Setting Allowed Hosts

Setting the Debug Directive

Setting the Development Mode

Configuring Database Access

Reviewing the Completed settings.py File

Step 3: Pushing the Site to GitHub

Step 4: Deploying to DigitalOcean with App Platform

Step 5: Deploying Your Static Files

Summary

What’s Next?

We can't find any results for your search.

Reviewing the Completed `settings.py` File