Dockerize services

.gitignore

@@ -5,3 +5,4 @@ mail/node_modules
 app/*/node_modules
 web/tmp
 web/vendor
+.env

Dockerfile

@@ -0,0 +1,89 @@
+ARG NODE_VERSION=22.2.0
+ARG PHP_VERSION=8.3
+
+### Web Service
+FROM php:${PHP_VERSION}-alpine AS web-deps
+ARG COMPOSER_VERSION="1.8.5"
+
+WORKDIR /app
+
+RUN apk update \
+ && apk add git unzip \
+ && curl https://getcomposer.org/download/$COMPOSER_VERSION/composer.phar --output /usr/bin/composer \
+ && chmod u+x /usr/bin/composer
+
+COPY web/composer.json composer.json
+COPY web/composer.lock composer.lock
+
+RUN composer install --no-scripts --no-autoloader
+
+COPY web /app
+
+RUN composer dump-autoload --optimize
+
+FROM php:${PHP_VERSION}-fpm-alpine as web
+WORKDIR /var/www
+RUN docker-php-ext-install mysqli \
+    && docker-php-ext-enable mysqli
+COPY --from=web-deps /app /var/www/reon/web
+RUN mkdir -p /var/www/reon/web/tmp \
+    && chown www-data:www-data /var/www/reon/web/tmp
+
+
+### Mail Service
+FROM node:${NODE_VERSION}-alpine AS mail-deps
+# Check https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
+RUN apk add --no-cache libc6-compat jq
+WORKDIR /app
+COPY mail/package.json mail/package-lock.json* ./
+RUN npm ci
+
+FROM node:${NODE_VERSION}-alpine as mail
+WORKDIR /app
+COPY --from=mail-deps /app/node_modules ./node_modules
+COPY mail /app
+EXPOSE 25
+EXPOSE 110
+
+ENTRYPOINT ["/app/entrypoint.sh"]
+
+
+### Cron jobs
+
+FROM node:${NODE_VERSION}-alpine as battle-deps
+WORKDIR /app
+COPY app/pokemon-battle/package.json app/pokemon-battle/package-lock.json* ./
+RUN npm ci
+
+FROM node:${NODE_VERSION}-alpine as exchange-deps
+WORKDIR /app
+COPY app/pokemon-exchange/package.json app/pokemon-exchange/package-lock.json* ./
+RUN npm ci
+
+# Based on https://github.com/AnalogJ/docker-cron
+FROM node:${NODE_VERSION}-alpine AS cron
+COPY app/docker_entry.sh /entrypoint.sh
+ENTRYPOINT ["/entrypoint.sh"]
+
+WORKDIR /app
+
+COPY app/pokemon-battle pokemon-battle
+COPY --from=battle-deps /app/node_modules ./pokemon-battle/node_modules
+
+COPY app/pokemon-exchange pokemon-exchange
+COPY --from=exchange-deps /app/node_modules ./pokemon-exchange/node_modules
+
+COPY app/docker.crontab /etc/crontabs/root
+
+# source: `docker run --rm -it alpine  crond -h`
+# -f | Foreground
+# -l N | Set log level. Most verbose 0, default 8
+CMD ["crond", "-f", "-l", "2"]
+
+### DNS server
+
+FROM alpine:3.20 AS dns
+RUN apk --no-cache add dnsmasq
+COPY docker-dns-entry.sh /entrypoint.sh
+EXPOSE 53/udp
+ENTRYPOINT ["/entrypoint.sh"]

README.md

@@ -17,6 +17,21 @@ This repository holds various folders for the service, and each has its own READ
 3. Run tables.sql in MySQL
 4. Continue these steps later once the production server is setup.
 
+# Docker Setup
+
+A `docker-compose.yml` is provided which will run all the required services. To get started, be sure to have docker available on your system.
+
+1. Copy `config.example.json` to `config.json`
+2. Copy `example.env` to `.env` (note the `.` at the start of the file name!)
+3. Update the values in both files as needed, ensuring that the mysql options match
+   - The included compose file exposes the MySQL port, so make sure you choose secure passwords
+   - Do NOT change the `mysql_host` option in `config.json` unless you plan to use an external MySQL database
+   - MYSQL_ROOT_PASSWORD is only needed for the `db` container and is not used by the other services
+4. Run `docker compose up -d` to start the services
+5. Run `docker compose exec -w /var/www/reon/web/scripts web php add_user.php` to create an account without having to configure email delivery
+
+Your REON server should now be accessible at http://localhost/.
+
 # License
 
 This code is licenced under MIT.

app/docker.crontab

@@ -0,0 +1,3 @@
+
+0 * * * * node /app/pokemon-battle/index.js -c /app/config.json
+0 * * * * node /app/pokemon-exchange/index.js -c /app/config.json

app/docker_entry.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+env >> /etc/environment
+
+# execute CMD
+echo "$@"
+exec "$@"

app/pokemon-battle/index.js

@@ -1,7 +1,18 @@
 const fs = require("fs");
+const path = require('path');
 const mysql = require("mysql2/promise");
+const { Command } = require('commander');
+const program = new Command();
+
+const defaultPath = path.resolve(__dirname, "..", "..", "config.json");
+
+program
+  .option('-c, --config <path>', 'Config file path.', defaultPath)
+  .parse(process.argv);
+
+const options = program.opts();
+const config = JSON.parse(fs.readFileSync(options.config));
 
-const config = JSON.parse(fs.readFileSync("../../config.json"));
 const mysqlConfig = {
 	host: config["mysql_host"],
 	user: config["mysql_user"],

app/pokemon-battle/package.json

@@ -10,6 +10,7 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
+    "commander": "^12.1.0",
     "mysql2": "^3.5.2"
   }
 }

app/pokemon-exchange/index.js

@@ -1,8 +1,18 @@
 const fs = require("fs");
 const path = require('path');
 const mysql = require("mysql2/promise");
+const { Command } = require('commander');
+const program = new Command();
+
+const defaultPath = path.resolve(__dirname, "..", "..", "config.json");
+
+program
+  .option('-c, --config <path>', 'Config file path.', defaultPath)
+  .parse(process.argv);
+
+const options = program.opts();
+const config = JSON.parse(fs.readFileSync(options.config));
 
-const config = JSON.parse(fs.readFileSync(path.resolve(__dirname, "..", "..", "config.json")));
 const mysqlConfig = {
 	host: config["mysql_host"],
 	user: config["mysql_user"],

app/pokemon-exchange/package.json

@@ -10,6 +10,7 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
+    "commander": "^12.1.0",
     "mysql2": "^3.5.2"
   }
 }

config.example.json

@@ -2,9 +2,9 @@
 	"hostname": "example.net",
 	"email_domain": "example.net",
 	"email_domain_dion": "xxxx.dion.ne.jp",
-	"mysql_host": "localhost",
-	"mysql_user": "USER",
-	"mysql_password": "PASS",
+	"mysql_host": "db",
+	"mysql_user": "reon",
+	"mysql_password": "password",
 	"mysql_database": "db",
 	"amoj_regist": "h200"
 }