Skip to content

Latest commit

 

History

History
61 lines (46 loc) · 4.74 KB

README.md

File metadata and controls

61 lines (46 loc) · 4.74 KB
Raw

TNA Python Flask Application

Quickstart

# Build and start the container
docker compose up -d

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 dev poetry run python -m pytest

Format and lint code

docker compose exec dev format

Environment variables

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

Variable Purpose Default
CONFIG The configuration to use config.Production
DEBUG If true, allow debugging[^1] False
COOKIE_DOMAIN The domain to save cookie preferences against none
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_SCRIPT_SRC_ELEM A comma separated list of CSP rules for script-src-elem 'self'
CSP_STYLE_SRC A comma separated list of CSP rules for style-src 'self'
CSP_STYLE_SRC_ELEM A comma separated list of CSP rules for style-src-elem '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_FEATURE_FULLSCREEN A comma separated list of rules for the fullscreen feature policy 'self'
CSP_FEATURE_PICTURE_IN_PICTURE A comma separated list of rules for the picture-in-picture feature policy 'self'
FORCE_HTTPS Redirect requests to HTTPS as part of the CSP none
CACHE_TYPE https://flask-caching.readthedocs.io/en/latest/#configuring-flask-caching none
CACHE_DEFAULT_TIMEOUT The number of seconds to cache pages for production: 300, staging: 60, develop: 0, test: 0
CACHE_DIR Directory for storing cached responses when using FileSystemCache /tmp
GA4_ID The Google Analytics 4 ID none

[^1] Debugging in Flask