Skip to content

README.md

Latest commit

 

History

History
63 lines (48 loc) · 4.39 KB

README.md

File metadata and controls

63 lines (48 loc) · 4.39 KB

TNA Python Django Application

Quickstart

# Build and start the container
docker compose up -d

# When you start the app for the first time, you need to run the migrations
docker compose exec app poetry run python manage.py migrate

Add the static assets

During the first time install, your app/static/assets directory will be empty.

As you mount the project directory to the /app volume, the static assets from TNA Frontend installed inside the container will be "overwritten" by your empty directory.

To add back in the static assets, run:

docker compose exec app cp -r /app/node_modules/@nationalarchives/frontend/nationalarchives/assets /app/app/static

Run tests

docker compose exec app poetry run pytest --ds=config.settings.test

Format and lint code

docker compose exec app format

Environment variables

In addition to the base Docker image variables, this application has support for:

Variable Purpose Default
DJANGO_SETTINGS_MODULE The configuration to use config.settings.production
ALLOWED_HOSTS A comma-separated list of allowed hosts none on production and staging, * on develop and test
USE_X_FORWARDED_HOST Use the X-Forwarded-Host header in preference to Host False
DEBUG If true, allow debugging False
COOKIE_DOMAIN The domain to save cookie preferences against none
COOKIE_PREFERENCES_URL The URL for changing cookie preferences none
DATABASE_NAME The name of the Postgres database none
DATABASE_USER The username needed to access the Postgres database none
DATABASE_PASSWORD The password needed to access the Postgres database none
DATABASE_HOST The Postgres database host none
DATABASE_PORT The Postgres database port 5432
CSP_IMG_SRC A comma separated list of CSP rules for img-src 'self'
CSP_SCRIPT_SRC A comma separated list of CSP rules for script-src 'self'
CSP_STYLE_SRC A comma separated list of CSP rules for style-src 'self'
CSP_FONT_SRC A comma separated list of CSP rules for font-src 'self'
CSP_CONNECT_SRC A comma separated list of CSP rules for connect-src 'self'
CSP_MEDIA_SRC A comma separated list of CSP rules for media-src 'self'
CSP_WORKER_SRC A comma separated list of CSP rules for worker-src 'self'
CSP_FRAME_SRC A comma separated list of CSP rules for frame-src 'self'
CSP_REPORT_URL The URL to report CSP violations to none
GA4_ID The Google Analytics 4 ID none