Deploy Django on Upsun

For Django to successfully deploy and operate, after completing the Getting started guide, you still need to make a few changes to your Upsun configuration.

Before you begin

You need:

• Git. Git is the primary tool to manage everything your app needs to run. Push commits to deploy changes and control configuration through YAML files. These files describe your infrastructure, making it transparent and version-controlled.
• A Upsun account. If you don’t already have one, register for a trial account. You can sign up with an email address or an existing GitHub, Bitbucket, or Google account. If you choose one of these accounts, you can set a password for your Upsun account later.
• The Upsun CLI. This lets you interact with your project from the command line. You can also do most things through the Web Console.

1. Leverage environment variables

Your settings.py file may allow for environment variables to be set for common pieces of configuration. In this case, add and commit a .environment file that includes those details.

export DJANGO_SETTINGS_MODULE=config.settings.production
export DJANGO_SECRET_KEY="$PLATFORM_PROJECT_ENTROPY"
export DJANGO_ALLOWED_HOSTS=".platformsh.site"

2. Configure ALLOWED_HOSTS

Your settings.py file may not allow you to use an environment variable like DJANGO_ALLOWED_HOSTS. If so, to configure allowed hosts, update your settings.py file to include platformsh.site:

ALLOWED_HOSTS = [
    'localhost',
    '127.0.0.1',
    '.platformsh.site',
]

Appending .platformsh.site to ALLOWED_HOSTS allows for all URLs generated for Upsun preview environments.

3. Upsun-specific settings

Near the bottom of your settings.py file, define a block that:

• Detects when Django is running on an Upsun environment
• Override previous settings

If your configuration is split into a production.py file for production settings, place it there instead.

# Production/Upsun settings.
if (os.getenv('PLATFORM_APPLICATION_NAME') is not None):
    DEBUG = False

    # Static dir.
    if (os.getenv('PLATFORM_APP_DIR') is not None):
        STATIC_ROOT = os.path.join(os.getenv('PLATFORM_APP_DIR'), 'static')

    # Secret Key.
    if (os.getenv('PLATFORM_PROJECT_ENTROPY') is not None):
        SECRET_KEY = os.getenv('PLATFORM_PROJECT_ENTROPY')

    # Production database configuration.
    if (os.getenv('PLATFORM_ENVIRONMENT') is not None):
        DATABASES = {
            'default': {
                'ENGINE': 'django.db.backends.postgresql',
                'NAME': os.getenv('DATABASE_PATH'),
                'USER': os.getenv('DATABASE_USERNAME'),
                'PASSWORD': os.getenv('DATABASE_PASSWORD'),
                'HOST': os.getenv('DATABASE_HOST'),
                'PORT': os.getenv('DATABASE_PORT'),
            },
            'sqlite': {
                'ENGINE': 'django.db.backends.sqlite3',
                'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
            }
        }

This update includes a few important changes:

1. Overwrites. If the PLATFORM_APPLICATION_NAME Upsun built-in variable is found (that is, Django is running on an Upsun environment), override your previous settings. No matter what environment type we run on Upsun, this file uses production settings for Upsun (i.e. DEBUG = False).

2. Static. STATIC_ROOT, and the static files path is updated relative to the application root on Upsun.

3. Secret key. All Upsun projects come with a unique hash environment variable PLATFORM_PROJECT_ENTROPY that can be used to update your SECRET_KEY.

4. Databases. When Django is running on an Upsun enviroment at runtime, it has access to service containers like databases and caches. Every service container you configure in .upsun/config.yaml has a unique relationship name (applications:<APP_NAME>:relationships:<RELATIONSHIPNAME>). Upsun automatically uses this relationship name to expose connection credentials through environment variables (for example, via RELATIONSHIPNAME_HOST).
   Update settings.py according to the example above (which configures a PostgreSQL service), where the relationship database results in environment variables that are leveraged to update the DATABASES setting for your application.
   You can use the exact same logic to configure CACHES from the rediscache relationship using the exposed REDISCACHE_ environment variables to setup django_redis.cache.RedisCache.

4. Start the app

In your app configuration, locate the web:commands:start section and update it as follows:

applications:
  myapp:
    ...
    web:
      commands:
        start: "gunicorn -b unix:$SOCKET config.wsgi"
      upstream:
        socket_family: unix

Note that if your Django instance requires a different web server, Upsun also supports several other options.

5. Configure static assets

To access Django’s static assets, you need to add a second location to the web:locations section of your app configuration. Locate the web:locations section and add a location for /static:

applications:
  myapp:
    ...
    web:
      locations:
        "/":
          "passthru": true
        "/static":
          "allow": true
          "expires": "1h"
          "root": "static"

6. Install dependencies and builds

Instruct Upsun to install your Python and Node (if needed) dependencies. Locate the hooks:build section and update it as follows:

applications:
  myapp:
    ...
    build: |
      set -eux

      pip install --upgrade pip
      pip install -r requirements.txt
      npm install
      npm run build      

Remove the npm steps if not required for your app’s assets. Note that if your project uses a different package manager, Upsun also supports several other options.

7. Configure the deploy phase

In your app configuration, locate the deploy section and update it as follows:

applications:
  myapp:
    ...
    deploy: |
      set -eux

      python manage.py collectstatic --noinput
      python manage.py migrate      

8. Allow write access where needed

Since Django can require a writable locations at runtime, you need to set up writable mounts. To do so, locate the mounts section (currently commented), and update it as follows:

applications:
  myapp:
    ...
    mounts:
      "/staticfiles":
        source: "local"
        source_path: "static_assets"

You can now commit all of the above changes and push to Upsun.

git add .
git commit -m "Add changes to complete my Upsun configuration"
git push

Further resources

Documentation

• Python documentation
• Managing dependencies
• Configuring web servers

Community content

• Django topics
• Python topics

Blogs

• Up(sun) and running with Django