From 581a96d634644977f4f572646c1e36d515af2e8d Mon Sep 17 00:00:00 2001 From: Steve Dogiakos Date: Tue, 1 Apr 2025 21:53:25 -0600 Subject: [PATCH] Lint and update docker-compose.yml - Fixed port variable interpolation to use ${PORT:-8000} for a default value. - Updated volume configuration to use a named volume (guestbook_data) mounted at /data. - Improved YAML formatting for clarity. --- .env | 11 +++++++++++ Dockerfile | 35 +++++++++++++++++++++-------------- app.py | 17 ++++++++++++++--- docker-compose.yml | 15 +++++++++++++++ production.Dockerfile | 14 ++++++++++++++ requirements.txt | 2 +- scripts/guestbook.db | Bin 0 -> 12288 bytes templates/index.html | 4 ++-- 8 files changed, 78 insertions(+), 20 deletions(-) create mode 100644 .env create mode 100644 docker-compose.yml create mode 100644 production.Dockerfile diff --git a/.env b/.env new file mode 100644 index 0000000..dabc748 --- /dev/null +++ b/.env @@ -0,0 +1,11 @@ +# Port to expose (default 8000) +PORT=5000 +# Flask environment setting (production) +FLASK_ENV=production +# Path to the SQLite database (this file will be stored in the mounted /data volume) +DATABASE_PATH=/data/scripts/guestbook.db +# Number of Gunicorn workers (adjust as needed) +GUNICORN_WORKERS=3 +PID=1000 +GID=1000 + diff --git a/Dockerfile b/Dockerfile index 63e2086..45e6801 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,14 +1,21 @@ -FROM python:3.9-slim - -WORKDIR /app - -# Copy and install Python dependencies. -COPY requirements.txt requirements.txt -RUN pip install --no-cache-dir -r requirements.txt - -# Copy the rest of the app code. -COPY . . - -EXPOSE 5000 - -CMD ["python", "app.py"] +# Use a lightweight Python image +FROM python:3.9-slim + +# Set the working directory +WORKDIR /app + +# Install dependencies +COPY requirements.txt . +RUN pip install --no-cache-dir -r requirements.txt + +# Copy the application code +COPY . . + +# Set environment variables (can be overridden by .env) +ENV FLASK_ENV=production + +# Expose the port (Gunicorn will run on 8000) +EXPOSE 8000 + +# Run the app with Gunicorn; use 3 workers (can be tuned via .env) +CMD ["gunicorn", "--bind", "0.0.0.0:8000", "app:app", "--workers", "3"] diff --git a/app.py b/app.py index 53124aa..94380b7 100644 --- a/app.py +++ b/app.py @@ -9,7 +9,9 @@ logging.basicConfig(level=logging.INFO) logger = logging.getLogger(__name__) app = Flask(__name__) -DATABASE = 'guestbook.db' + +# Use an environment variable for the database path (defaulting to 'guestbook.db') +DATABASE = os.environ.get('DATABASE_PATH', 'guestbook.db') def load_banned_words(): """Load a set of banned words from a local file. @@ -48,6 +50,7 @@ def contains_banned_words(text): return False def init_db(): + """Initialize the SQLite database and create the guests table if it doesn't exist.""" conn = sqlite3.connect(DATABASE) c = conn.cursor() c.execute(''' @@ -66,9 +69,15 @@ def init_db(): logger.info("Database initialized.") def is_valid_email(email): + """Simple regex-based email validation.""" pattern = r'^[\w\.-]+@[\w\.-]+\.\w+$' return re.match(pattern, email) +@app.before_first_request +def initialize_database(): + """Ensure the database is initialized before handling the first request.""" + init_db() + @app.route('/', methods=['GET', 'POST']) def index(): error = None @@ -109,6 +118,7 @@ def index(): logger.info("New guest entry added: %s from %s.", first_name, location) return redirect(url_for('index')) + # For GET requests, retrieve guest entries to display. conn = sqlite3.connect(DATABASE) c = conn.cursor() c.execute('SELECT first_name, location FROM guests ORDER BY id DESC') @@ -118,6 +128,7 @@ def index(): return render_template('index.html', error=error, guests=guests) if __name__ == '__main__': + # For development use; production (gunicorn) will not execute this block. init_db() - logger.info("Starting Flask app on host 0.0.0.0, port 5000.") - app.run(host='0.0.0.0', port=5000) + logger.info("Starting Flask app on host 0.0.0.0, port 8000.") + app.run(host='0.0.0.0', port=8000) diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..920785c --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,15 @@ +version: "3.8" +services: + guestbook: + build: . + container_name: guestbook + ports: + - "${PORT:-8000}:8000" + env_file: + - .env + volumes: + # Mount a named volume at /data so that the database file (configured in .env) persists + - /home/steve/kiosk-guestbook:/data + +volumes: + guestbook_data: diff --git a/production.Dockerfile b/production.Dockerfile new file mode 100644 index 0000000..63e2086 --- /dev/null +++ b/production.Dockerfile @@ -0,0 +1,14 @@ +FROM python:3.9-slim + +WORKDIR /app + +# Copy and install Python dependencies. +COPY requirements.txt requirements.txt +RUN pip install --no-cache-dir -r requirements.txt + +# Copy the rest of the app code. +COPY . . + +EXPOSE 5000 + +CMD ["python", "app.py"] diff --git a/requirements.txt b/requirements.txt index 3487e0d..4f020a3 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,3 @@ Flask==2.2.5 Werkzeug>=3.0.6 - +gunicorn \ No newline at end of file diff --git a/scripts/guestbook.db b/scripts/guestbook.db index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..2512fc7ebfa9a09784d834989d1d759a9253a188 100644 GIT binary patch literal 12288 zcmeI&L2uJA6bEoSMZhMpajSYjdT5tT>!z%whwZei^-x99mDH7}I8-L{(r8VxH7*iY z#5dtn@WFPUvob_01YFQ0^nZ%&IP$aQ-_1z|Z~eq*y2xj#GSpc?>w&V?(&gQ zAEvsvp4v0#xX{;gokgqNN;?#u6ePV9U(m|f?M$V*ZZmg2cleWPt;WAZcXP&bU6^7~ zJ4-Vxp3(L?{S?VLb$e3079sV+Zs3I@dLu^U4dq$4XVU}Gll7&Hi)2=qak)H6@lI0j z%$A|=FOQn4zZj%bl}ztuSxL?#Ws*Gm-2zdbraCjf$Tmr82~>JT9m^-XfuN2!^@hHr z_Am_XhQ{T?f%Jm@kDcw5XLG*!mDvjc0SG_<0uX=z1Rwwb2tWV=5P-nL3B2b|S@p%i z)?ssC^he#v<3wHN#rgO4I4)l&?AsRu?MZI5n%60ia-y=!qWr8+Hf8q7Op+{q*>D@J zJ@?g~+aR}j)H*n7xr_7v4cokVxD8@u2tWV=5P$##AOHafKmY;|fB*#kfxsHC)YcaN GMce}Riko@> literal 0 HcmV?d00001 diff --git a/templates/index.html b/templates/index.html index 5a4d72b..bd42d02 100644 --- a/templates/index.html +++ b/templates/index.html @@ -4,7 +4,7 @@ - The Montana Dinosaur Center Visitor Guestbook + The Montana Dinosaur Center Visitor Log