Version bump

Bumps [nodemon](https://github.com/remy/nodemon) from 3.1.10 to 3.1.11.
- [Release notes](https://github.com/remy/nodemon/releases)
- [Commits](https://github.com/remy/nodemon/compare/v3.1.10...v3.1.11)

---
updated-dependencies:
- dependency-name: nodemon
  dependency-version: 3.1.11
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

.envdev

@@ -3,6 +3,8 @@ WEB_PORT=3100
 WEB_ORIGIN=http://localhost:3001
 
 DB_HOSTNAME=localhost
+DB_PORTNAME=3306
+
 DB_DATABASE=news
 DB_USERNAME=news
 DB_PASSWORD=venusaur

.github/dependabot.yml

@@ -0,0 +1,10 @@
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+

.github/workflows/docker.yml

@@ -5,19 +5,21 @@ on:
   push:
     tags:
       - v1.*
+  workflow_dispatch:
+
 jobs:
   push_to_registry:
     name: Push Docker Image to Docker Hub
     runs-on: ubuntu-latest
     steps:
-      - name: Check Out The Repo
+      - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v5
 
-      - name: Set up QEMU
+      - name: Setup QEMU
-        uses: docker/setup-qemu-action@v1
+        uses: docker/setup-qemu-action@v3
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v1
+        uses: docker/setup-buildx-action@v3
 
       - name: Get Smart Tag
         id: prepare
@@ -26,13 +28,13 @@ jobs:
           docker_image: krgamestudios/news-server
 
       - name: Login to DockerHub
-        uses: docker/login-action@v1
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}
 
       - name: Push to Docker Hub
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v6
         with:
           push: true
           tags: ${{ steps.prepare.outputs.tag }}

Dockerfile

@@ -1,8 +1,8 @@
 
-FROM node:21-bookworm-slim
+FROM node:22-bookworm-slim
 WORKDIR "/app"
 COPY package*.json /app
-RUN npm install --production
+RUN npm install --omit=dev
 COPY . /app
 EXPOSE 3100
 USER node

README.md

@@ -6,7 +6,7 @@ This server is available via docker hub at krgamestudios/news-server.
 
 # Setup
 
-There are multiple ways to run this app - it can run on it's own via `npm start` (for production) or `npm run dev` (for development). it can also run inside docker using `docker-compose up --build` - run `node configure-script.js` to generate docker-compose.yml and startup.sql.
+There are multiple ways to run this app - it can run on it's own via `npm start` (for production) or `npm run dev` (for development). it can also run inside docker using `docker compose up --build` - run `node configure-script.js` to generate docker-compose.yml and startup.sql.
 
 To generate an authorization token, use [auth-server](https://github.com/krgamestudios/auth-server). A public-facing development auth-server is available here (tokens are valid for 10 minutes):
 

configure-script.js

@@ -33,6 +33,25 @@ const question = (prompt, def = null) => {
 	const appWebOrigin = await question('Web Origin', `https://example.com`); //TODO: clean these up properly
 	const appPort = await question('App Port', '3100');
 
+  //configure the database address
+  let dbLocation = '';
+  while (typeof dbLocation != 'string' || /^[le]/i.test(dbLocation[0]) == false) {
+    dbLocation = await question('[l]ocal or [e]xternal database?');
+  }
+
+  let appDBHost = '';
+  let appDBPort = '';
+
+  if (/^[l]/i.test(dbLocation[0])) {
+    appDBHost = 'database';
+    appDBPort = '3306';
+  }
+  else {
+    appDBHost = await question('DB Host');
+    appDBPort = await question('DB Port', '3306');
+  }
+
+  //configure the database account
 	const appDBUser = await question('DB User', appName);
 	const appDBPass = await question('DB Pass', 'venusaur');
 	const dbRootPass = await question('DB Root Pass');
@@ -43,38 +62,43 @@ const question = (prompt, def = null) => {
 
 	//generate the files
 	const ymlfile = `
-version: '3.8'
 services:
   ${appName}:
     build:
       context: .
     ports:
-      - "${appPort}"
+      - ${appPort}
     labels:
-      - "traefik.enable=true"
+      - traefik.enable=true
-      - "traefik.http.routers.${appName}router.rule=Host(\`${appWebAddress}\`)"
+      - traefik.http.routers.${appName}router.rule=Host(\`${appWebAddress}\`)
-      - "traefik.http.routers.${appName}router.entrypoints=websecure"
+      - traefik.http.routers.${appName}router.entrypoints=websecure
-      - "traefik.http.routers.${appName}router.tls.certresolver=myresolver"
+      - traefik.http.routers.${appName}router.tls.certresolver=myresolver
-      - "traefik.http.routers.${appName}router.service=${appName}service@docker"
+      - traefik.http.routers.${appName}router.service=${appName}service@docker
-      - "traefik.http.services.${appName}service.loadbalancer.server.port=${appPort}"
+      - traefik.http.services.${appName}service.loadbalancer.server.port=${appPort}
     environment:
       - WEB_PORT=${appPort}
       - WEB_ORIGIN=${appWebOrigin}
-      - DB_HOSTNAME=database
+      - DB_HOSTNAME=${appDBHost}
+      - DB_PORTNAME=${appDBPort}
       - DB_DATABASE=${appName}
       - DB_USERNAME=${appDBUser}
       - DB_PASSWORD=${appDBPass}
       - DB_TIMEZONE=Australia/Sydney
       - PAGE_SIZE=10
       - SECRET_ACCESS=${appSecretAccess}
+    volumes:
+      - /etc/timezone:/etc/timezone:ro
+      - /etc/localtime:/etc/localtime:ro
     networks:
-      - app-network
+      - app-network${ appDBHost != 'database' ? '' : `
     depends_on:
       - database
+
   database:
     image: mariadb:latest
     environment:
       MYSQL_DATABASE: ${appName}
+      MYSQL_TCP_PORT: ${appDBPort}
       MYSQL_USER: ${appDBUser}
       MYSQL_PASSWORD: ${appDBPass}
       MYSQL_ROOT_PASSWORD: ${dbRootPass}
@@ -83,35 +107,39 @@ services:
     volumes:
       - ./mysql:/var/lib/mysql
       - ./startup.sql:/docker-entrypoint-initdb.d/startup.sql:ro
+      - /etc/timezone:/etc/timezone:ro
+      - /etc/localtime:/etc/localtime:ro`}
+
   traefik_${appName}:
-    image: "traefik:v2.10"
+    image: traefik:latest
     command:
-      - "--log.level=ERROR"
+      - --log.level=ERROR
-      - "--api.insecure=false"
+      - --api.insecure=false
-      - "--providers.docker=true"
+      - --providers.docker=true
-      - "--providers.docker.exposedbydefault=false"
+      - --providers.docker.exposedbydefault=false
-      - "--entrypoints.websecure.address=:443"
+      - --entrypoints.websecure.address=:443
-      - "--certificatesresolvers.myresolver.acme.tlschallenge=true"
+      - --certificatesresolvers.myresolver.acme.tlschallenge=true
-      - "--certificatesresolvers.myresolver.acme.email=${supportEmail}"
+      - --certificatesresolvers.myresolver.acme.email=${supportEmail}
-      - "--certificatesresolvers.myresolver.acme.storage=/letsencrypt/acme.json"
+      - --certificatesresolvers.myresolver.acme.storage=/letsencrypt/acme.json
     ports:
-      - "80:80"
+      - 80:80
-      - "443:443"
+      - 443:443
     volumes:
-      - "./letsencrypt:/letsencrypt"
+      - ./letsencrypt:/letsencrypt
-      - "/var/run/docker.sock:/var/run/docker.sock:ro"
+      - /var/run/docker.sock:/var/run/docker.sock:ro
     networks:
       - app-network
+
 networks:
   app-network:
     driver: bridge
 `;
 
 	const dockerfile = `
-FROM node:21-bookworm-slim
+FROM node:22-bookworm-slim
 WORKDIR "/app"
 COPY package*.json /app
-RUN npm install --production
+RUN npm install --omit=dev
 COPY . /app
 EXPOSE ${appPort}
 USER node

package.json

@@ -1,6 +1,6 @@
 {
   "name": "news-server",
-  "version": "1.7.0",
+  "version": "1.7.5",
   "description": "An API centric news server. Uses Sequelize and mariaDB by default.",
   "main": "server/server.js",
   "scripts": {
@@ -13,21 +13,21 @@
     "url": "git+https://github.com/krgamestudios/news-server.git"
   },
   "author": "Kayne Ruse",
-  "license": "ISC",
+  "license": "Zlib",
   "bugs": {
     "url": "https://github.com/krgamestudios/news-server/issues"
   },
   "homepage": "https://github.com/krgamestudios/news-server#readme",
   "dependencies": {
     "cors": "^2.8.5",
-    "dotenv": "^16.3.1",
+    "dotenv": "^17.2.3",
-    "express": "^4.18.2",
+    "express": "^5.2.1",
-    "jsonwebtoken": "^9.0.2",
+    "jsonwebtoken": "^9.0.3",
-    "mariadb": "^3.2.3",
+    "mariadb": "^3.4.5",
-    "markdown-it": "^13.0.2",
+    "markdown-it": "^14.1.0",
-    "sequelize": "^6.35.2"
+    "sequelize": "^6.37.7"
   },
   "devDependencies": {
-    "nodemon": "^3.0.2"
+    "nodemon": "^3.1.11"
   }
 }

server/database/index.js

@@ -2,6 +2,7 @@ const Sequelize = require('sequelize');
 
 const sequelize = new Sequelize(process.env.DB_DATABASE, process.env.DB_USERNAME, process.env.DB_PASSWORD, {
 	host: process.env.DB_HOSTNAME,
+	port: process.env.DB_PORTNAME,
 	dialect: 'mariadb',
 	timezone: process.env.DB_TIMEZONE,
 	logging: process.env.DB_LOGGING ? console.log : false

server/news/index.js

@@ -12,10 +12,10 @@ const edit = require('./edit');
 const remove = require('./remove');
 
 //basic route management (all query possibilities)
-router.get('/:id(\\d+)?', cors(), query(false, false));
+router.get('/{:id}', cors(), query(false, false));
-router.get('/archive/:id(\\d+)?', cors(), query(true, false));
+router.get('/archive/{:id}', cors(), query(true, false));
-router.get('/metadata/:id(\\d+)?', cors(), query(false, true));
+router.get('/metadata/{:id}', cors(), query(false, true));
-router.get('/archive/metadata/:id(\\d+)?', cors(), query(true, true));
+router.get('/archive/metadata/{:id}', cors(), query(true, true));
 
 //use middleware to authenticate the rest of the routes
 router.use(cors({
@@ -37,7 +37,7 @@ router.use((req, res, next) => {
 
 //authenticated routes
 router.post('/', publish);
-router.patch('/:id(\\d+)', edit);
+router.patch('/{:id}', edit);
-router.delete('/:id(\\d+)', remove);
+router.delete('/{:id}', remove);
 
 module.exports = router;

server/server.js

@@ -16,7 +16,7 @@ const database = require('./database');
 app.use('/news', require('./news'));
 
 //error on access
-app.get('*', (req, res) => {
+app.get('/{*any}', (req, res) => {
 	res.redirect('https://github.com/krgamestudios/news-server');
 });
 
@@ -24,4 +24,5 @@ app.get('*', (req, res) => {
 server.listen(process.env.WEB_PORT || 3100, async (err) => {
 	await database.sync();
 	console.log(`listening to localhost:${process.env.WEB_PORT || 3100}`);
+	console.log(`database located at ${process.env.DB_HOSTNAME || '<default>'}:${process.env.DB_PORTNAME || '<default>'}`);
 });

tools/debug-startup.sql

@@ -1,4 +1,4 @@
 #use this while debugging
-CREATE DATABASE IF NOT EXISTS news;
+CREATE DATABASE news;
-CREATE USER IF NOT EXISTS 'news'@'%' IDENTIFIED BY 'venusaur';
+CREATE USER 'news'@'%' IDENTIFIED BY 'venusaur';
 GRANT ALL PRIVILEGES ON news.* TO 'news'@'%';