Add deployment script and configuration #34

Joe-Heffer-Shef · 2025-01-08T12:25:09Z

See issue #27

Changes

Added deployment Bash script
Added service configuration files to run on the server e.g. systemd and nginx config files, etc.
Added deployment docs (docs/deployment.md)
Docs and scripts to set up nginx, gunicorn, and PostgreSQL database
Set Django settings using environment variables
DEBUG defaults to False for security reasons
Add notes on SSL certificate installation

It's a can of worms for a Django app

https://www.digitalocean.com/community/tutorials/how-to-set-up-django-with-postgres-nginx-and-gunicorn-on-ubuntu

https://docs.djangoproject.com/en/5.1/howto/static-files/#deployment

https://docs.djangoproject.com/en/5.1/ref/settings/#databases

https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_set_header

.github/workflows/lint-nginx.yaml

SORT/settings.py

f-allian

@Joe-Heffer-Shef Thanks Joe, this looks really great.

/home/runner/work/SORT/SORT/config/systemd/gunicorn.service:1:error [Security.LockPersonality] - Service should have LockPersonality being set https://www.freedesktop.org/software/systemd/man/latest/systemd.exec.html

https://docs.djangoproject.com/en/5.1/howto/deployment/checklist/

because it's used on Ubuntu 24 LTS

https://nginx.org/en/docs/http/ngx_http_v2_module.html

# Conflicts: # SORT/settings.py

f-allian

LGTM

Add deployment script

d0fb23f

Joe-Heffer-Shef linked an issue Jan 8, 2025 that may be closed by this pull request

Deploy test version of SORT #27

Closed

12 tasks

Joe-Heffer-Shef mentioned this pull request Jan 8, 2025

Deploy test version of SORT #27

Closed

12 tasks

Fix syntax error

aa78a03

Joe-Heffer-Shef changed the title ~~Add deployment script~~ Add deployment script and configuration Jan 8, 2025

Joe-Heffer-Shef requested a review from f-allian January 8, 2025 12:41

Joe-Heffer-Shef self-assigned this Jan 8, 2025

Joe-Heffer-Shef added 23 commits January 8, 2025 12:49

Add shell and systemd linting

0d7fd29

Add gunicorn systemd service

4476fd6

Don't use pyproject.toml

d75a0f4

It's a can of worms for a Django app

Install Gunicorn socket

a84d3f9

-

df44486

Fix SORT module name

249c5d8

Configure NGINX proxy pass

3ac712f

-

e2ca956

Fix nginx linter path

d363d54

Fix indent

83cb30f

Reload services on deploy

4398da4

Revert Gunicorn socket path

6251386

Add ALLOWED_HOSTS env var

b2dc7cb

Add deployment auto check workflow

2e45292

Install Django package

7dbc1f7

Install dotenv

3cac085

Serve static files

9f87479

https://www.digitalocean.com/community/tutorials/how-to-set-up-django-with-postgres-nginx-and-gunicorn-on-ubuntu

Remove spoof check

bcbfeeb

Collect static files

3479a76

https://docs.djangoproject.com/en/5.1/howto/static-files/#deployment

Collect static files on service start

bc9ecc8

Install static files in deployment script

b4b7099

Start working on PostgreSQL installation

a557a3e

Configure database using env vars

813669b

https://docs.djangoproject.com/en/5.1/ref/settings/#databases

Joe-Heffer-Shef added 2 commits January 9, 2025 12:00

Forward HTTP host to proxy

68b147f

https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_set_header

Update deployment docs

e74e8d9

Joe-Heffer-Shef marked this pull request as ready for review January 9, 2025 12:21

Joe-Heffer-Shef marked this pull request as draft January 9, 2025 12:40

Joe-Heffer-Shef added 3 commits January 9, 2025 14:34

Create UTF-8 en_GB database localisation

4a4b8b2

Ensure gunicorn is started

19af2be

-

7924f60

Joe-Heffer-Shef marked this pull request as ready for review January 9, 2025 14:42

f-allian reviewed Jan 9, 2025

View reviewed changes

.github/workflows/lint-nginx.yaml Outdated Show resolved Hide resolved

f-allian reviewed Jan 9, 2025

View reviewed changes

SORT/settings.py Outdated Show resolved Hide resolved

f-allian approved these changes Jan 9, 2025

View reviewed changes

Joe-Heffer-Shef and others added 15 commits January 10, 2025 09:33

String-to-Boolean: accept any input data type

e5e9948

Run linting on PRs and main branch only

c803dae

Merge remote-tracking branch 'origin/feat/deploy' into feat/deploy

a43a48f

Lock down the personality(2) system call

e70549d

/home/runner/work/SORT/SORT/config/systemd/gunicorn.service:1:error [Security.LockPersonality] - Service should have LockPersonality being set https://www.freedesktop.org/software/systemd/man/latest/systemd.exec.html

Add deployment check tool

2976280

https://docs.djangoproject.com/en/5.1/howto/deployment/checklist/

Add cookie security settings

59467c4

Make to-Boolean function more robust

fbe965a

Make to-Boolean function more robust

13b96cf

SECRET_KEY has min length 50 chars

0e7a2a2

Add SSL cert config

5b19e89

Suggest Python version 3.12

e29cbf4

because it's used on Ubuntu 24 LTS

Disable HTTP2

4d3adc2

https://nginx.org/en/docs/http/ngx_http_v2_module.html

Add note on self-signed certificates

b497927

Format file

bc19e29

Merge remote-tracking branch 'refs/remotes/origin/main' into feat/deploy

d825074

# Conflicts: # SORT/settings.py

Joe-Heffer-Shef changed the base branch from main to dev January 20, 2025 11:09

f-allian approved these changes Jan 20, 2025

View reviewed changes

Merge branch 'dev' into feat/deploy

fabcd5a

f-allian merged commit a42d779 into dev Jan 20, 2025
3 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add deployment script and configuration #34

Add deployment script and configuration #34

Joe-Heffer-Shef commented Jan 8, 2025 •

edited

Loading

f-allian left a comment

f-allian left a comment

Add deployment script and configuration #34

Add deployment script and configuration #34

Conversation

Joe-Heffer-Shef commented Jan 8, 2025 • edited Loading

f-allian left a comment

Choose a reason for hiding this comment

f-allian left a comment

Choose a reason for hiding this comment

Joe-Heffer-Shef commented Jan 8, 2025 •

edited

Loading