Try running TEKDB locally with docker #210

paigewilliams · 2025-10-25T00:32:20Z

Description

Base setup for using docker during local development. Removes or replaces some of the previous docker related code. Requires a .env file in the /docker directory.

build and start the containers with docker compose up --build (add -d to run detached)
stop the containers with docker compose down
Use docker exec -it to execute commands in the web container, such as running the tests with docker exec -it docker-web-1 python manage.py test

Phase 2

Things to explore once we feel confident in this base setup

Github Action to create a docker image and push to a registry, and deploy to AWS on release
Explore multi stage builds?
Explore having a prod and test (for running locally) images?
Dockerfile for nginx
Explore using uv
Lots of other things I have not thought of yet

Copilot

Pull Request Overview

This PR modernizes Docker configuration for the TEKDB application, introducing a complete containerization setup with proper orchestration. The changes implement database health checks, proper initialization sequencing, and production-ready configurations.

Updates entrypoint script with database readiness checks and fixture loading
Modernizes docker-compose with health checks and proper service dependencies
Adds comprehensive Dockerfile with GDAL/PostGIS support
Includes .dockerignore for optimized build context

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.

File	Description
TEKDB/docker/entrypoint.sh	Enhanced startup script with database wait logic, fixture loading, and HTTP socket configuration
TEKDB/docker-compose.yml	Restructured compose file with PostGIS 15, health checks, and environment variable configuration
TEKDB/Dockerfile	New multi-stage Python 3.11 image with geospatial dependencies and optimized layer caching
TEKDB/.dockerignore	Build context exclusions to reduce image size and avoid copying unnecessary files

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

TEKDB/docker/entrypoint.sh

TEKDB/Dockerfile

Copilot · 2025-10-28T18:56:26Z

TEKDB/docker-compose.yml

+      SQL_DATABASE: tekdb
+      SQL_USER: postgres
+      SQL_PASSWORD: postgrespw
+      SECRET_KEY: 'change-me'


Hardcoding SECRET_KEY directly in docker-compose.yml is a security risk, even with a placeholder value. This should be loaded from the .env.dev file or injected as an environment variable at runtime to prevent accidental commits of sensitive values.

Suggested change

SECRET_KEY: 'change-me'

TEKDB/docker-compose.yml

pollardld

I don't know Docker well enough to review. If it works than approved!

rhodges

Like @pollardld , I'm not confident enough in my Docker knowledge to validate the correctness of the code, but in general it looks good, and it's not going to hurt anything by including (since Docker isn't currently part of anyone's deployment). I look forward to playing with this more in the future. Approved

load fixtures if empty

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 11 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-09T17:39:09Z

TEKDB/entrypoint.sh

+echo "Checking for existing users..."
+if [ "$(python manage.py shell -c 'from django.contrib.auth import get_user_model; print(get_user_model().objects.count())')" = "0" ]; then
+    python manage.py loaddata TEKDB/fixtures/default_users_fixture.json
+fi
+# Load default lookups only if no lookups exist. Use LookupPlanningUnit as the check.
+echo "Checking for existing lookups..."
+if [ "$(python manage.py shell -c 'from TEKDB.models import LookupPlanningUnit; print(LookupPlanningUnit.objects.count())')" = "0" ]; then
+	python manage.py loaddata TEKDB/fixtures/default_lookups_fixture.json


The shell commands that execute Python code are vulnerable to command injection if SQL_HOST or other environment variables contain malicious input. While this is a development setup, it's better to avoid using shell -c with Python. Consider creating a small Django management command or Python script file to check for existing users and lookups, which would be more secure and maintainable.

Suggested change

echo "Checking for existing users..."

if [ "$(python manage.py shell -c 'from django.contrib.auth import get_user_model; print(get_user_model().objects.count())')" = "0" ]; then

python manage.py loaddata TEKDB/fixtures/default_users_fixture.json

fi

# Load default lookups only if no lookups exist. Use LookupPlanningUnit as the check.

echo "Checking for existing lookups..."

if [ "$(python manage.py shell -c 'from TEKDB.models import LookupPlanningUnit; print(LookupPlanningUnit.objects.count())')" = "0" ]; then

python manage.py loaddata TEKDB/fixtures/default_lookups_fixture.json

echo "Checking for existing users and lookups..."

counts=$(python manage.py check_counts)

user_count=$(echo "$counts" | grep '^users:' | cut -d':' -f2 | tr -d ' ')

lookup_count=$(echo "$counts" | grep '^lookups:' | cut -d':' -f2 | tr -d ' ')

if [ "$user_count" = "0" ]; then

python manage.py loaddata TEKDB/fixtures/default_users_fixture.json

fi

if [ "$lookup_count" = "0" ]; then

python manage.py loaddata TEKDB/fixtures/default_lookups_fixture.json

Copilot · 2025-12-09T17:39:09Z

TEKDB/docker-compose.yml

+    volumes:
+      - .:/usr/src/app


[nitpick] Mounting .:/usr/src/app will override the application code that was copied during the Docker build (including installed dependencies in site-packages if they were installed with --editable). This is useful for development hot-reloading, but ensure this is intentional. For production, this volume mount should be removed.

Suggested change

volumes:

- .:/usr/src/app

# volumes:

# - .:/usr/src/app

TEKDB/docker-compose.yml

TEKDB/Dockerfile

TEKDB/docker-compose.yml

TEKDB/Dockerfile

Copilot · 2025-12-09T17:39:11Z

TEKDB/entrypoint.sh

+# Load default users only if no users exist
+echo "Checking for existing users..."
+if [ "$(python manage.py shell -c 'from django.contrib.auth import get_user_model; print(get_user_model().objects.count())')" = "0" ]; then
+    python manage.py loaddata TEKDB/fixtures/default_users_fixture.json


Inconsistent indentation: lines 10, 12-16, and 29 use tabs, while line 24 uses spaces. Shell scripts should consistently use either tabs or spaces (tabs are conventional for shell scripts). Update line 24 to use tabs to match the rest of the file.

Copilot · 2025-12-09T17:39:11Z

TEKDB/requirements.txt

 ipdb
 ipython
+
+# Serve static files in production containers


The whitenoise dependency should be pinned to a specific version or version range for reproducible builds, similar to other dependencies in the file (e.g., django >=4.2.16,<4.3). Consider specifying a version like whitenoise>=6.0.0,<7.0.0.

TEKDB/docker-compose.yml

Copilot · 2025-12-09T17:39:12Z

TEKDB/.dockerignore

+# Docker
+Dockerfile
+docker-compose*.yml


The .dockerignore file excludes Dockerfile and docker-compose*.yml files from the Docker build context. While docker-compose.yml doesn't need to be in the image, the Dockerfile exclusion is unusual and could cause issues if the build process references it. Consider removing the Dockerfile line from .dockerignore.

paigewilliams · 2025-12-11T19:34:26Z

@rhodges @pollardld This is ready for a second review! Would love if y'all could try to run locally and let me know how it goes!

pollardld

Wonderful! I got TEK running locally.

One note for posterity, I had to edit DATABASES in my local_settings.py which now looks like:

DATABASES = {
    "default": {
        "ENGINE": os.environ.get("SQL_ENGINE", "django.contrib.gis.db.backends.postgis"),
        "NAME": os.environ.get("SQL_DATABASE", "tekdb"),
        "USER": os.environ.get("SQL_USER", "postgres"),
        "PASSWORD": os.environ.get("SQL_PASSWORD", ""),
        "HOST": (
            os.environ.get("SQL_HOST")
            or os.environ.get("DB_HOST")
            or "localhost"
        ),
        "PORT": (
            os.environ.get("SQL_PORT")
            or os.environ.get("DB_PORT")
            or "5432"
        ),
    }
}

paigewilliams · 2025-12-17T00:43:59Z

yes, I forgot to add that. Thanks for mentioning. I can update the docs.

paigewilliams · 2025-12-18T21:35:50Z

TEKDB/entrypoint.sh

+    uwsgi --http :8000 --master --enable-threads --module TEKDB.wsgi
+elif [ "$1" = "dev" ]; then
+    echo "Starting python development server on :8000"
+    python manage.py runserver 0.0.0.0:8000


@rhodges added some logic to the entrypoint to support dev or prod servers. The Dockerfile uses test by default, but added a docker-compose.prod.yaml to pass the prod arg

paigewilliams · 2025-12-18T22:06:13Z

I added docs on how to run with docker! https://github.com/Ecotrust/TEKDB/wiki/Local-Development-with-Docker

paigewilliams added 2 commits October 24, 2025 16:39

first pass at docker setup

3d2e247

run loaddata in entrypoint

a802708

paigewilliams requested review from pollardld and rhodges October 25, 2025 00:32

paigewilliams self-assigned this Oct 25, 2025

paigewilliams requested a review from Copilot October 28, 2025 18:52

Copilot AI reviewed Oct 28, 2025

View reviewed changes

add whitenoise for static file loading

d2f3550

pollardld approved these changes Oct 30, 2025

View reviewed changes

pollardld added archive and removed archive labels Oct 30, 2025

rhodges approved these changes Oct 31, 2025

View reviewed changes

paigewilliams added 5 commits November 17, 2025 09:26

Merge branch 'main' into paige-docker-testing

b4f224c

Merge branch 'main' into paige-docker-testing

a4f3daf

remove postgresql from web dockerfile

c0f2143

load fixtures if empty

Merge branch 'main' into paige-docker-testing

f5af575

Merge branch 'main' into paige-docker-testing

c153dd7

paigewilliams requested a review from Copilot December 9, 2025 17:29

Copilot started reviewing on behalf of paigewilliams December 9, 2025 17:30 View session

Copilot AI reviewed Dec 9, 2025

View reviewed changes

paigewilliams added 8 commits December 9, 2025 12:59

remove unnecessary installs

5b31f6c

remove to enforce password auth

d22dc0c

remove unused docker related files

0463e13

use env vars in docker-compose.yaml

8244f52

pin whitenoise version

d896048

ruff format

c4679e6

wip: organize docker directory

75b42b2

fix volumes location

10d2628

paigewilliams marked this pull request as ready for review December 11, 2025 19:29

pollardld self-requested a review December 16, 2025 22:33

pollardld approved these changes Dec 16, 2025

View reviewed changes

add commands for dev and prod server options

11d6c85

paigewilliams commented Dec 18, 2025

View reviewed changes

update local_settings.py template

a7cb16c

Try running TEKDB locally with docker #210

Are you sure you want to change the base?

Try running TEKDB locally with docker #210

Uh oh!

Conversation

paigewilliams commented Oct 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Phase 2

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pollardld left a comment

Choose a reason for hiding this comment

Uh oh!

rhodges left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

paigewilliams commented Dec 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pollardld left a comment

Choose a reason for hiding this comment

Uh oh!

paigewilliams commented Dec 17, 2025

Uh oh!

paigewilliams Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

paigewilliams commented Dec 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

paigewilliams commented Oct 25, 2025 •

edited

Loading

paigewilliams commented Dec 11, 2025 •

edited

Loading