https://github.com/rijumia/deploy_django_application_on_shared_hosting_using_cpanel
Step-by-step guide to deploying Django applications on shared hosting with cPanel. Covers project preparation, Python app setup, database configuration, file uploads, and static/media handling with WhiteNoise. Includes instructions for both terminal and non-terminal access.
https://github.com/rijumia/deploy_django_application_on_shared_hosting_using_cpanel
cpanel deployment django django-deployment django-web-application-host djangoweb gunicorn mysql passenger python rijumia shared-hosting staticfiles vps-server vps-setup web-hosting whitenoise wsgi
Last synced: 27 days ago
JSON representation
Step-by-step guide to deploying Django applications on shared hosting with cPanel. Covers project preparation, Python app setup, database configuration, file uploads, and static/media handling with WhiteNoise. Includes instructions for both terminal and non-terminal access.
- Host: GitHub
- URL: https://github.com/rijumia/deploy_django_application_on_shared_hosting_using_cpanel
- Owner: rijumia
- License: mit
- Created: 2025-09-10T17:08:42.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-09-11T12:49:31.000Z (9 months ago)
- Last Synced: 2025-09-11T15:48:55.111Z (9 months ago)
- Topics: cpanel, deployment, django, django-deployment, django-web-application-host, djangoweb, gunicorn, mysql, passenger, python, rijumia, shared-hosting, staticfiles, vps-server, vps-setup, web-hosting, whitenoise, wsgi
- Language: HTML
- Homepage:
- Size: 190 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🚀Deploy-Django-Application-on-Shared-Hosting-using-Cpanel
## 📌Context
- [Step-01: Prepare Django Project](#step-01-prepare-django-project)
- [Step-02: Logging Into the Cpanel](#-step-02-logged-in-into-the-cpanel-dashboard)
- [Step-03: Create Subdomain](#-step-03--create-sub-domain-if-needed)
- [Step-04: Setup Application](#-step-04--setup-application)
- [Step-05: Setup MySQL Database](#-step-05--setup-mysql-database-if-you-want)
- [Step-06: Upload Project Files](#-step-06--upload-project-files)
- [Step-07: Final Setup](#-step-07--final-setup)
- [If You Have Terminal Access](#if-you-have-terminal)
- [If You Don't Have Terminal Access](#if-you-dont-have-terminal-access)
## ✅1️⃣ Step-01: Prepare Django Project
### 🔹Modify `settings.py`
- Make sure `DEBUG = False` in `settings.py`
- Set `APPOWED_HOSTS` to your domain or used `*` to accept any domain
```python
ALLOWED_HOSTS = ["yourdomain.com"] # you can used multiple domain or subdomain
# or
ALLOWED_HOSTS = ["*"]
```
- Integrate`whitenoise` inside the `INSTALLED_APPS and MIDDLEWARE` in `settings.py`:
```python
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'whitenoise.runserver_nostatic', # This must be added before 'django.contrib.staticfiles'
'django.contrib.staticfiles',
'portfolioapp',
]
```
```python
MIDDLEWARE = [
'django.middleware.security.SecurityMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'whitenoise.middleware.WhiteNoiseMiddleware', # This must be added here after SecurityMiddleware & SessionMiddleware
'django.middleware.common.CommonMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
'django.middleware.clickjacking.XFrameOptionsMiddleware',
]
```
- Set `Static & Media Files` root in `settings.py`
```python
STATIC_URL = 'static/'
MEDIA_URL = '/media/'
STATIC_ROOT = BASE_DIR / 'staticfiles/'
MEDIA_ROOT = BASE_DIR / 'media/'
STATICFILES_STORAGE = 'whitenoise.storage.CompressedStaticFilesStorage'
```
- Final Overview of the `settings.py`
```python
DEBUG = False
ALLOWED_HOSTS = ["yourdomain.com"]
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'whitenoise.runserver_nostatic', # This must be added before 'django.contrib.staticfiles'
'django.contrib.staticfiles',
'portfolioapp',
]
MIDDLEWARE = [
'django.middleware.security.SecurityMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'whitenoise.middleware.WhiteNoiseMiddleware', # This must be added here after SecurityMiddleware & SessionMiddleware
'django.middleware.common.CommonMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
'django.middleware.clickjacking.XFrameOptionsMiddleware',
]
STATIC_URL = 'static/'
MEDIA_URL = '/media/'
STATIC_ROOT = BASE_DIR / 'staticfiles/'
MEDIA_ROOT = BASE_DIR / 'media/'
STATICFILES_STORAGE = 'whitenoise.storage.CompressedStaticFilesStorage'
```
### 🔹Modify `urls.py`
- Modify main project directory `urls.py` file.
```python
from django.contrib import admin
from django.conf import settings
from django.conf.urls.static import static
from django.views.static import serve
from django.urls import path, include, re_path
urlpatterns = [
path('admin/', admin.site.urls),
# Other paths...
]
urlpatterns+=re_path(r'^static/(?P.*)$', serve, {'document_root': settings.STATIC_ROOT}),
urlpatterns+=re_path(r'^media/(?P.*)$', serve, {'document_root': settings.MEDIA_ROOT}),
```
### 🔹Prepare `requirements.txt` file
- Add all required the packages and their version that you used in this project. Also must be add `gunicorn, whitenoise` packages for development. Otherwise some time you fetch lots of issue for static and media file after deployment.:
```python
Django==5.2.3
gunicorn==23.0.0
pillow==10.3.0
whitenoise==6.9.0
```
For auto create `requirements.txt` used below code:
```python
pip freeze > requirements.txt
```
📒[Go To Context](#context)
## ✅2️⃣ Step-02: Logged-in into the Cpanel Dashboard
## ✅3️⃣ Step-03: Create Sub-Domain (if needed):
- After login search `Domains`
- From the `Domains` Page click to the `Create A New Domain` button.
- Then create and submit
```python
#Ex: test.yourmaindomain.com
```
📒[Go To Context](#context)
## ✅4️⃣ Step-04: Setup Application:
- Go to `Setup Python App` page
- Click `Create Application` button
- `Python Version:` Select Python Version
- `Application root:` Enter project directory name. Where you upload your project files.
- `Application URL:` Select the `Domain or Subdomain`
- Then hit the `Create` button.
📒[Go To Context](#context)
## ✅5️⃣ Step-05: Setup MySQL Database (If you want)
### 🔹Setup Database on the Cpanel
- Go to `Manage My Databases`
- On the Create New Database section set the Database name then hit the `Create Database` button
- Then scroll down and find `Add New User` section. Here set the database `username, password`
- Again scroll down and find `Add User To Database` section. Then select `User and Database`
- After Add it redirect to the `Manage User Privileges` from here select `ALL PRIVILEGES` then click `Make Changes` button.
`**🚨 Alert:**` Must be copy the Database Name, Username and Password. Because need to configure database on the settings.py
### 🔹Database Configuration
```python
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql',
'NAME': 'your_database_name',
'USER': 'your_database_username',
'PASSWORD': 'database_user_password',
'HOST': 'yourhostdomain.com',
'PORT': '3306',
}
}
```
📒[Go To Context](#context)
## ✅6️⃣ Step-06: Upload Project Files
- Go to `File Manager` page
- Find the Application root directory.
- Upload the project file as `zip`
- Edit the `passenger_wsgi.py` and add below line and save it.
```python
from yourProjectname.wsgi import application
```
`**🚨 Note:**` Must change the `yourProjectname` based on your project name
📒[Go To Context](#context)
## ✅7️⃣ Step-07: Final Setup
- Go to `Setup Python App` page
- Select your app and click Edit Icon
### 🔹If You Have Terminal:
- From the application copy the `virtual environment` command
- Open the Terminal and Paste the command
- Then run the below command:
- Install requirements file:
```bash
pip install -r requirements.txt
```
- Migration and Migrate the database:
```bash
python manage.py makemigrations
```
```bash
python manage.py migrate
```
- Then Apply collect static command to collects all static files from apps and puts them into one central directory for easy serving in production:
```python
python manage.py collectstatic
```
📒[Go To Context](#context)
### 🔹If You Don’t Have Terminal Access:
- From the Application Setup Page apply the command manually
- Write and Add `requirements.txt` into this section and click `Run Pip Install`. Note: Sometimes it send error message first try. If you fetch error then run again.
- Then into this section run other command and click `Run Script` button without `py or python`:
After that click the `RESTART` button. Now you can visit your application.
📒[Go To Context](#context)