motorscript.com

Simple Django Deployment Cheat-sheet

Published:
Updated:
    Download form data
  • Domain Name:
  • IP Address:
  • User on Server :
  • User Password : Regenerate Copy
  • SSH Port :
  • Django Project Name :
  • Database Name :
  • Database User :
  • Database Password : Regenerate Copy

Create a sudo user

useradd -m user
echo user:JU3Jzeq1es9CuO6| chpasswd
usermod -aG sudo user
chsh --shell /bin/bash user
su - user
Add user to /etc/ssh/sshd_config AllowUsers configuration if AllowUsers is used to allow specific user logins via SSH.

Setup Database

Install Postgresql:
apt-get install postgresql postgresql-contrib
Enable and start Postgresql
systemctl enable postgresql
systemctl start postgresql
Create database and role:
sudo su - postgres
createdb db_name
echo "CREATE ROLE db_user WITH PASSWORD 'AkQ1BpZdR9zFHeI';" | psql
echo "ALTER ROLE db_user WITH LOGIN;" | psql
echo "GRANT ALL PRIVILEGES ON DATABASE "db_name" to db_user;" | psql
exit

Setup pushing via Git

cd
mkdir repo.git app conf logs media static
cd repo.git
git init --bare
git --bare update-server-info
git config core.bare false
git config receive.denycurrentbranch ignore
git config core.worktree /home/user/app/

cat > hooks/post-receive <<EOF
#!/bin/sh
git checkout -f
cd ../app/
./deploy.sh
EOF

chmod +x hooks/post-receive
cd
Add this bare repo as a remote on local.
git remote add server user@143.666.7.343:/home/user/repo.git/
ssh-copy-id user@143.666.7.343
git push server --all

You may want to modify your git post-receive hook to run custom commands on the server, like running database migrations, notifying services of new deployments, pushing static files to CDN, etc. A deploy.sh file with executable permission is expected in the project root in this example post-receive hook.

Install Required Libraries and Packages

apt install python3-pip
pip3 install virtualenv

Setup the Project

cd
virtualenv env -p python3
source env/bin/activate
cd app
pip install -r requirements/prod.txt
python manage.py migrate
python manage.py collectstatic
Also, try running ./manage.py runserver to see if everything is all right.

Install Circus

pip3 install circus
mkdir -p /etc/circus/conf.d/
vim /etc/circus/circusd.ini
[circus]
check_delay = 5
include_dir = /etc/circus/conf.d
;debug = True
;; requires circus-web to be able to start the http dashboard
;httpd = True

[plugin:flapping]
use = circus.plugins.flapping.Flapping
retry_in = 3
max_retry = 2
 vim /etc/systemd/system/circus.service
[Unit]
Description=Circus process manager
After=syslog.target network.target nss-lookup.target
[Service]
Type=simple
ExecReload=/home/user/env/bin/circusctl reload
ExecStart=/home/user/env/bin/circusd /etc/circus/circusd.ini
Restart=always
RestartSec=5
[Install]
WantedBy=default.target
systemctl --system daemon-reload
systemctl enable circus
systemctl start circus

Create circus configuration

cd
vim conf/circus.ini
[watcher:django_project]
cmd=chaussette --fd $(circus.sockets.django_project) django_project.wsgi.application
#cmd=chaussette --fd $(circus.sockets.django_project) --backend gevent django_project.wsgi.application
#cmd=chaussette --fd $(circus.sockets.django_project) --backend meinheld django_project.wsgi.application
uid = user
endpoint_owner = user
use_sockets = True
virtualenv_py_ver = 3.8
numprocesses = 2
virtualenv = /home/user/env/
copy_env = True
copy_path = True
stdout_stream.class = FileStream
stdout_stream.filename = /home/user/logs/django.log
stderr_stream.class = FileStream
stderr_stream.filename = /home/user/logs/django_err.log
stdout_stream.max_bytes = 1073741824
stdout_stream.backup_count = 3
stderr_stream.max_bytes = 1073741824
stderr_stream.backup_count = 3
working_dir = /home/user/app/

[socket:django_project]
host=127.0.0.1
port=8000
#path = /tmp/django_project.sock
#family = AF_UNIX

[env:django_project]
PYTHONPATH=/home/user/app/

# For django-q
[watcher:django_project_q]
cmd = python manage.py qcluster
numprocesses = 1
working_dir = /home/user/app/
virtualenv = /home/user/env/
copy_env = True
copy_path = True
stdout_stream.class = FileStream
stdout_stream.filename = /home/user/logs/webapp_q.log
stdout_stream.max_bytes = 1073741824
stdout_stream.backup_count = 3
stderr_stream.class = FileStream
stderr_stream.filename = /home/user/logs/webapp_q_err.log
stderr_stream.max_bytes = 1073741824
stderr_stream.backup_count = 3

[env:django_project_q]
PYTHONPATH=/home/user/app/

Soft-link our configuration to circus conf.d directory

sudo ln -s /home/user/conf/circus.ini /etc/circus/conf.d/django_project.ini
circusctl reloadconfig

Install redis

apt install redis-server
systemctl enable redis-server
systemctl start redis-server

Install nginx

apt install nginx
systemctl enable nginx
rm /etc/nginx/sites-enabled/default

Configure nginx with security headers

cd
vim conf/nginx.conf
upstream django_project {
    server 127.0.0.1:8000;
    # server unix:/tmp/django_project;
}

# Redirect www.awecode.com to awecode.com
server {
    listen 80;
    server_name  www.awecode.com;
    return       301 https://awecode.com$request_uri;
}

server {
    listen 80;
    server_name awecode.com;

    #access_log /home/user/logs/nginx.access.log;
    error_log /home/user/logs/nginx.error.log;

    #limit_conn conn_limit_per_ip 100;
    #limit_req zone=req_limit_per_ip burst=100 nodelay;

    location /robots.txt {
        alias /home/user/static/robots.txt;
    }
    
    location /favicon.ico {
        alias /home/user/static/img/favicon.ico;
    }
    
    location ~ ^/(media|static)/  {
        root    /home/user/;
        expires 30d;
    }

    location / {
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Host $http_host;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_redirect off;
        proxy_pass http://django_project;
        client_max_body_size 50m;
        add_header Strict-Transport-Security "max-age=63072000; includeSubDomains; preload" always;
        add_header X-Content-Type-Options nosniff;
        add_header X-XSS-Protection "1; mode=block";
        add_header X-Frame-Options SAMEORIGIN;
    }
    
    # Prevent hidden files (beginning with a period) from being served
    location ~ /\. { access_log off; log_not_found off; deny all; }
}

Soft-link our configuration to nginx conf.d directory

sudo ln -s /home/user/conf/nginx.conf /etc/nginx/conf.d/django_project.conf

Obtain SSL certificate with Certbot

apt install certbot python-certbot-nginx
certbot --nginx

Check configuration and restart nginx

nginx -t
systemctl restart nginx