update(docker): expanded on existing examples

.env.example

@@ -1,12 +1,26 @@
-KENER_SECRET_KEY=please_change_me
-NODE_ENV=production
-PORT=3000
-KENER_BASE_PATH=""
-RESEND_API_KEY=
-ORIGIN=http://localhost:3000
+TZ=Etc/UTC
+KENER_SECRET_KEY=please_change_me_to_something_secure
+
+# For SQLite database...
 DATABASE_URL=sqlite://./database/kener.sqlite.db
-TZ=UTC
+
+# For PostgreSQL database...
+# DATABASE_URL=postgresql://db_user:db_password@localhost:5432/kener_db
+# POSTGRES_PASSWORD=some_super_random_secure_password
+
+# For MySQL database...
+# DATABASE_URL=mysql://db_user:db_password@127.0.0.1:3306/kener_db
+# MYSQL_PASSWORD=some_super_random_secure_password
+
+KENER_BASE_PATH=""
+ORIGIN=http://localhost:3000
+
+RESEND_API_KEY=""
 RESEND_SENDER_EMAIL=Accounts <accounts@resend.dev>
 
-# DATABASE_URL=postgresql://myuser:mypassword@localhost:5432/mydatabase
-# DATABASE_URL=mysql://root:password@127.0.0.1:3306/kener
+# Likely no need to change...
+# NODE_ENV=production   # already defined in container
+# PORT=3000   # default port Kener service is exposed upon
+
+# Add the below variable if you would like to ‘white-label’ the product (aka. remove some of the attributions scattered throughout the app)
+# WHITE_LABEL=true

docker-compose.yml

@@ -1,26 +1,61 @@
+# Docker Compose Configuration
+# Description: This file sets up a multi-container environment for Kener (https://github.com/rajnandan1/kener).
+# Last Updated: 2025-02-08
+# Docker Compose Version: 3.8
+# Notes: Ensure that you specify a random value for the `KENER_SECRET_KEY` environment variable before running `docker-compose up -d`.
+
 version: '3.8'
+
 services:
   kener:
-    image: rajnandan1/kener:latest 
+    image: rajnandan1/kener:latest      # Change to 'rajnandan1/kener:alpine' for an even smaller image! 😁🚀
     container_name: kener
-    #env_file: .env #uncomment this, if you are using .env file
+    # env_file: custom.env              # Uncomment this if you are needing to export environment variables from a custom environment file. By default, Docker will import any variables that exist in `.env`
     environment:
-      - TZ=Etc/UTC
-      - NODE_ENV=production
-      #- PORT=3000
-      #- KENER_BASE_PATH=
-      #- RESEND_API_KEY=
-      #- ORIGIN=
-      #- KENER_SECRET_KEY=
-      #- RESEND_SENDER_EMAIL=
-      #- DATABASE_URL=
+      TZ: Etc/UTC
+      KENER_SECRET_KEY: replace_me_with_a_random_string   # Keep private!! - best to define in `.env` file or through Docker Secret
+      # DATABASE_URL: custom_db_url     # By default, a SQLite database is used - you may override the database url/type here
+      # RESEND_API_KEY: 
+      # RESEND_SENDER_EMAIL: 
 
+      ### You most likely will NOT need to change anything below this line. Be sure you know what you're doing!! (https://kener.ing/docs/deployment/#docker-environment-variables)
 
-      ### Most likely DO NOT need to change anything below this ###
-
-      #- PORT=3000 Port app listens on IN CONTAINER
+      # PORT: 3000                      # Port that app listens on in the container
+      # KENER_BASE_PATH:                # By default, Kener runs at `/`. You may change this to be, e.g. `/status`, etc. Do NOT add a trailing slash!! (more info here: https://kener.ing/docs/deployment/#docker-environment-variables)
+      # ORIGIN: http://localhost:3000
+      # NODE_ENV: production            # This is already set to "production" by default within the container
     ports:
       - '3000:3000/tcp'
     volumes:
-      - '.:/app/database:rw'
-      - '.:/app/uploads:rw'
+      - data:/app/database              # We suggest using a Docker named volume, which is more performant for databases
+      - $(pwd)/uploads:/app/uploads
+    # read_only: true                   # Uncommenting this fortifies security by marking the container's filesystem as read-only (aka no data can be written to the container's filesystem except for explicitly defined writable volumes and bind mounts, an exception has already been defined for `/database` and `/uploads`)
+    restart: unless-stopped
+    # depends_on:                       #  <-- Uncomment if you would like to use PostgreSQL or MySQL
+    #   - postgres                      #       ...instead of SQLite
+    #   - mysql                         #
+
+  # Only use below section if you would like to utilize PostgreSQL instead of Kener's default SQLite database. (Don't forget to set `DATABASE_URL` in `kener` service to be: `DATABASE_URL=postgresql://db_user:db_password@localhost:5432/kener_db`)
+  postgres:
+    image: postgres:alpine
+    name: kener_db
+    environment:
+      POSTGRES_USER: user
+      POSTGRES_PASSWORD: some_super_random_secure_password   # Best to define this in `.env` or via Docker Secret!!
+      POSTGRES_DB: kener_db
+    restart: unless-stopped
+
+  # Only use below section if you would like to utilize MySQL instead of Kener's default SQLite database. (Don't forget to set `DATABASE_URL` in `kener` service to be: `DATABASE_URL=mysql://db_user:db_password@localhost:3306/kener_db`)
+  mysql:
+    image: mariadb:11
+    name: kener_db
+    environment:
+      MYSQL_USER: user
+      MYSQL_PASSWORD: some_super_random_secure_password   # Best to define this in `.env` or via Docker Secret!!
+      MYSQL_DATABASE: kener_db
+      MYSQL_RANDOM_ROOT_PASSWORD: true
+    restart: unless-stopped
+
+volumes:
+  data:
+    name: kener_db