Merge branch 'add-default-port-configuration' into 'main'

feat: Add application port configuration

See merge request !5

CHANGELOG

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.1] - 2024-06-13
+
+### Added
+
+- Application PORT is now configurable.
+
 ## [1.0.0] - 2024-04-18
 
 ### Added

copier.yml

@@ -36,6 +36,11 @@ python_version:
   help: "Python version to be used."
   default: "3.11"
 
+app_port:
+  type: int
+  help: "Default port for the application."
+  default: 8080
+
 include_tests:
   type: bool
   help: "Include test setup or not."

template/Dockerfile

@@ -10,6 +10,9 @@ FROM registry.gitlab.developers.cam.ac.uk/uis/devops/infra/dockerimages/python:3
 ENV PYTHONUNBUFFERED=1 \
     PYTHONDONTWRITEBYTECODE=1
 
+# Set the PORT env variable with a default value
+ENV PORT={{ app_port }}
+
 WORKDIR /usr/src/app
 
 # Pretty much everything from here on needs poetry.
@@ -42,7 +45,7 @@ FROM install_deps AS development
 
 RUN poetry install --only=dev --no-root
 
-CMD ["uvicorn", "{{ project_slug }}.main:app", "--reload", "--host", "0.0.0.0", "--port", "8000"]
+CMD exec uvicorn {{ project_slug }}.main:app --reload --host 0.0.0.0 --port $PORT
 
 ###############################################################################
 # The last target in the file is the "default" one. In our case it is the
@@ -54,4 +57,4 @@ FROM install_deps as production
 # The production target includes the application code.
 COPY . .
 
-CMD ["uvicorn", "{{ project_slug }}.main:app", "--host", "0.0.0.0", "--port", "8000"]
+CMD exec uvicorn {{ project_slug }}.main:app --host 0.0.0.0 --port $PORT

template/docker-compose.yml

@@ -6,7 +6,7 @@ services:
       context: .
       target: development
     ports:
-      - "8000:8000"
+      - "{{ app_port }}:{{ app_port }}"
     profiles:
       - development
     volumes:
@@ -17,7 +17,7 @@ services:
       context: .
       target: production
     ports:
-      - "8000:8000"
+      - "{{ app_port }}:{{ app_port }}"
     profiles:
       - production
     volumes: