How to Deploy Django App on cPanel (The Ultimate Guide)

How to Deploy Django Application and connect a Database in cPanel

Django is one of the most popular web frameworks for building scalable and secure applications. While deploying Django on cloud servers is common, many developers and website owners prefer using cPanel for hosting due to its user-friendly interface and affordability.

If you’re looking for a detailed, step-by-step guide on how to deploy a Django application on cPanel, you’re in the right place.

Deploying a Django application on cPanel might seem challenging, but with the right steps, you can get your project up and running smoothly. This guide will walk you through the process in a friendly, easy-to-follow manner.

In this comprehensive guide, we’ll walk you through every step, from setting up your Django project to configuring your database, handling static files, and securing your application.

Whether you’re a beginner or an experienced developer, you’ll find all the necessary details here to successfully deploy your Django app on cPanel.

Why Deploy Django on cPanel?

cPanel is one of the most popular web hosting control panels, widely used for managing websites, databases, and emails. Many shared hosting providers offer cPanel, making it an affordable and accessible option for hosting Django applications.

While cPanel is traditionally optimized for PHP applications, you can still run Django by using its Setup Python App feature.

Prerequisites

Before you begin, ensure you have:

• A Django project ready for deployment
• A cPanel hosting account
• SSH Access (Optional)
• A registered domain or subdomain pointed to your cPanel server
• Python 3.x support (provided by your hosting provider)
• Basic familiarity with the command line

Watch the Video Tutorial

For an easier way to deploy a Django application on cPanel, watch the YouTube video below. If you prefer a detailed, step-by-step written guide, continue reading.

Step 1: Create a Python Application in cPanel

1. Log in to your cPanel account.
2. Scroll down to the Software section and click on Setup Python App.

3. Click Create Application and select:
   • Python version (Choose the latest available 3.x version).
   • Application root: /home/yourusername/yourprojectname (or any preferred directory). For instance, if your application’s root folder is named Django-project and you are using your primary domain, the application root directory will be public_html/Django-project. In this guide, we are using a subdomain, so our application root becomes py.hostplus.top.
   • Application URL: Select the domain or subdomain you want to use.
   • Application startup file: Leave it blank for now (we’ll configure this later).
   • Application Entry point: Leave it blank for now (we’ll configure this later).

4. Click Create and note the Virtual Environment Path displayed.

Step 2: Upload Your Django Project to cPanel

You can upload your Django project in two ways:

Option 1: Upload via File Manager

1. Go to Files section in the cPanel and click File Manager.
2. Navigate to the application root directory you set in Step 1.
3. Click Upload and select your Django project’s .zip file.

4. Extract the .zip file after uploading. Right-click the uploaded ZIP file and select ‘Extract‘ to unzip it.

Ensure that all files are located in the py.hostplus.top folder (or any preferred directory). If they are not, navigate to the extracted folder, select all files, and move them to the py.hostplus.top folder or your chosen directory.

Suggested Reading: How to Upload Your Website (in 3 Simple Steps)

Option 2: Clone from GitHub

1. Open Terminal from cPanel or connect via SSH.
2. Navigate to the application directory:

cd /home/yourusername/yourprojectname

3. Clone your project from GitHub:

git clone https://github.com/yourusername/your-repository.git

Step 3: Install Dependencies

Your Django project has dependencies listed in requirements.txt. You can install them in two ways:

Method 1: Using Setup Python App Page

1. Go back to Setup Python App.
2. Click the Edit button for your application.
3. Find the Configuration files section and enter: requirements.txt then click Add button

4. Click “Run Pip Install”, then select the requirements.txt file to install the dependencies.

Method 2: Using the Terminal

1. Activate the virtual environment: copy and paste the Virtual Environment Path from Step 1 or manually activate the virtual environment.

Virtual Environment Path from Step 1

source /home/cpusrplus/virtualenv/py.hostplus.top/3.10/bin/activate && cd /home/cpusrplus/py.hostplus.top

Manually activate the virtual environment

source /home/yourusername/virtualenv/yourprojectname/3.x/bin/activate

2. Install dependencies: In the Terminal, navigate in your project directory and run the command to install the dependencies;

pip install -r requirements.txt

Step 4: Configure Application Startup File

1. Open Setup Python App and locate your application.
2. Find the Application Startup File section: Enter the location of your wsgi.py file. In my case, it is studybud/wsgi.py, then save and restart the application.

3. Alternatively, you can keep the passenger_wsgi.py file and follow the rest of the process to modify it accordingly.
4. Inside your project folder, edit the passenger_wsgi.py file and add the following code snippet:

import os
import sys

# Adjust this path
sys.path.insert(0, "/home/yourusername/yourprojectname")

os.environ['DJANGO_SETTINGS_MODULE'] = 'yourprojectname.settings'

from django.core.wsgi import get_wsgi_application
application = get_wsgi_application()

Remember to update the following with your Django project directory:

sys.path.insert(0, "/home/yourusername/yourprojectname")

For example, in my case, since I’m using a subdomain, it would be:

sys.path.insert(0, "/home/cpusrplus/py.hostplus.top/studybud")

Additionally, update your Django settings module:

os.environ['DJANGO_SETTINGS_MODULE'] = 'yourprojectname.settings'

For example:

os.environ['DJANGO_SETTINGS_MODULE'] = 'studybud.settings'

5. Restart the application in Setup Python App.

Suggested Reading:

• How to Set Up a MySQL Database & User in cPanel (2 Easy Methods)
• How to Set Up a PostgreSQL Database and User in cPanel

Step 5: Configure Allowed Hosts

Edit the settings.py file inside your Django project:

ALLOWED_HOSTS = ['yourdomainname.com', 'www.yourdomainname.com']

If your site is on a subdomain:

ALLOWED_HOSTS = ['sub.yourdomainname.com']

Save the file and restart your application.

How to Use MySQL Instead of SQLite3 in Django on cPanel

Step 1: Create a MySQL Database in cPanel

1. Navigate to MySQL® Databases under the Databases section.
2. Under Create New Database, enter a name (e.g., mydjango_db) and click Create Database.
3. Scroll down to MySQL Users and create a new database user (e.g., mydjango_user).
4. Assign a strong password and click Create User.
5. Scroll to Add User to Database, select your database and user, then click Add.
6. Grant All Privileges and click Make Changes.

For a step-by-step guide on creating a MySQL database in cPanel, follow this illustrated tutorial: How to Set Up a MySQL Database & User in cPanel (2 Easy Methods).

Step 2: Install MySQL Connector for Python

If you haven’t installed mysqlclient, do so via:

1. Execute Python Script. Go back to Setup Python App and click to edit your application. Scroll to the Configuration files section.

2. Terminal. Activate the virtual environment. source /home/yourusername/virtualenv/yourprojectname/3.x/bin/activate && cd /home/yourusername/yourprojectname

pip install mysqlclient

If that fails, try:

pip install pymysql

Then, add this to your Django project’s __init__.py file (same directory as settings.py):

import pymysql
pymysql.install_as_MySQLdb()

Step 3: Configure MySQL in Django settings.py

Open your settings.py and replace the SQLite3 settings with the MySQL configuration:

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'yourusername_mydjango_db',  # Replace with your cPanel database name
        'USER': 'yourusername_mydjango_user',  # Replace with your cPanel MySQL username
        'PASSWORD': 'your_password',  # Replace with your MySQL password
        'HOST': 'localhost',  # cPanel MySQL host
        'PORT': '3306',  # Default MySQL port
    }
}

Step 4: Apply Migrations

Run the following commands to apply database changes:

python manage.py migrate

If you need a superuser, create one:

python manage.py createsuperuser

Step 5: Restart the Application

1. Go to cPanel > Setup Python App.
2. Restart your Django application.
3. Visit your site and check if everything is working.

Step 6: Common Errors and Fixes

Error 1: Module Not Found

Solution:

• Make sure dependencies are installed correctly using: pip install -r requirements.txt
• Restart the application in Setup Python App.

Error 2: Internal Server Error (500 Error)

Solution:

• Check your passenger_wsgi.py file for any incorrect paths.
• Review stderr.log in the Django application project folder.
• Verify that ALLOWED_HOSTS includes your domain.

Error 3: Static Files Not Loading

Solution:

1. Add the following to settings.py:

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

2. Run:

python manage.py collectstatic

3. Ensure the static files directory is accessible.

Error 4: Database Connection Issues

Solution:

• If using SQLite, check that the database file is in the correct location.
• If using MySQL/PostgreSQL, ensure the credentials in settings.py match your cPanel database.
• If migrations fail, ensure MySQL user privileges are set correctly.
• If you see mysqlclient errors, try installing pymysql instead.
• Verify that the database host is set to localhost.

Conclusion

Deploying a Django application on cPanel is straightforward when you follow the correct steps. From setting up your Python environment to configuring the startup file, this guide provides everything you need to launch your app successfully.

Still facing issues? Drop a comment or reach out to Aveshost support for additional assistance!

Happy coding! 🚀

Suggested Reading:

• How to Deploy Angular App on cPanel: CSR & SSR Guide
• How To Deploy a Node.js App on cPanel (The Ultimate Guide)
• How to Deploy Laravel Project on cPanel
• How to Set Up a PostgreSQL Database and User in cPanel
• How to Set Up a MySQL Database & User in cPanel (2 Easy Methods)

Frequently Asked Questions (FAQs)