Product Operation Guide

Document field	Value
Document	Product Operation Guide
Project	BRN WMS
Project code	200-WMS-26-001-00
Title	Operating Manual Document for System Administrators
Project period	05/01/26–24/08/26
Release	17/08/26 V1.0
Standard	ISO/IEC 29110 Basic Profile
Organizer	Apirach Supattaratpateep (Project Manager), Noppong Chareunsook (System Analyst), Thanakorn Sathitwitayakul (Developer)
Status	Final — reflects the implemented deployment mechanisms at project baseline

Objective

Guide a System Administrator through installing, configuring, operating, monitoring, backing up, and recovering BRN WMS, so operation is consistent, correct, and quickly recoverable.

1. Deployment options

BRN WMS supports two deployment paths, evidenced in the repository:

Path	Mechanism	Reference
Manual installation	One-shot database setup script	`setup.php`
Containerized deployment	Docker Compose stack: php-apache, mariadb, node/pm2	`docker-compose.yml`, `docker/`

2. Containerized installation (recommended)

Copy .env.example to .env, or run the interactive generator: docker/init-env.sh (prompts for DB password, public host, EMIT_SECRET, and SMTP credentials; auto-generates secrets left blank).
Run docker compose up -d --build. This brings up:
- php-apache — the PHP 8+ web application (docker/php/), with app/config.php generated from .env at container start by docker/php/entrypoint.sh — never baked into the image or committed.
- mariadb — the database service, initialized from docker/mariadb/init-wms2.sql and setup.php.
- node — the Node.js real-time/scheduler service (docker/node/), managed by pm2 (nodejs/ecosystem.config.js).
Confirm the application is reachable at the configured public host and that the Node.js service is running (Section 5).

3. Manual installation

Provision a PHP 8+ / MariaDB / Node.js environment.
Configure app/config.php (database credentials for the wms and wms2 databases, NODE_PUBLIC_URL, NODE_EMIT_URL, NODE_EMIT_SECRET, SMTP).
Run setup.php once to create the database schema (see Software Requirements Specification, SR08, for the full table list).
Start the Node.js services (nodejs/server.js, nodejs/scheduler.js), for example under pm2 using nodejs/ecosystem.config.js.

4. Configuration

Item	Location	Notes
Application configuration	`app/config.php`	Generated at deploy time; never committed
Environment secrets	`.env` (Docker) or shell/deployment environment (manual)	Excluded via `.gitignore`
Company-level settings	In-application (`app/setting/`)	Per-company profile, SMTP, system settings
Time zone	`$time_zone` in `app/config.php`	Fixed to `Asia/Bangkok`

5. Monitoring

Web application: confirm the PHP application responds and users can authenticate.
Database: confirm both wms and wms2 databases are reachable.
Node.js service: confirm server.js (Socket.IO) and scheduler.js (scheduled jobs) are running under pm2; review nodejs/logs/ (socket.log, scheduler.log, scheduler-error.log) for errors.
Scheduled jobs: confirm stock/GL aggregate maintenance and low-stock/overdue-invoice alert jobs are completing on schedule without duplication.

6. Backup and recovery

Item	Mechanism	Status
Source code and configuration templates	Git, two remotes (`origin`, `backup`)	See Project Repository / Project Repository (Backup), work products 9–10
Database (`wms`, `wms2`)	Scheduled `mysqldump` script, run daily, output stored off-server with a retention policy	Operated and verified manually by the Developer; a restoration has been performed successfully. Because backup operation is manual, the script location, exact schedule, off-server destination, and retention period are not recorded in a controlled configuration reference — see Section 7
SDLC documents	External PDF export package	See Project Repository (Backup), Section 3

7. Accepted operational follow-up actions

ID	Follow-up action	Owner	Target	Closure criterion
OP-001	Record the operated `mysqldump` backup control for `wms`/`wms2` in a controlled reference.	Developer	Before go-live	The controlled reference identifies the script location, exact schedule, off-server destination, retention period, responsible operator, and restoration procedure.
OP-002	Document monitoring and failure alerting for the Node.js service beyond local log review.	Developer	Before go-live	The controlled procedure identifies the health check, alert trigger, recipient, escalation path, and recovery response for `server.js` and `scheduler.js`.

8. User and access management

An Owner/Admin manages users, roles (Owner/Admin/Staff/Viewer), and application-access flags from Settings (app/setting/). Role changes take effect on the user's next authenticated action; concurrent-session policy blocks a second simultaneous login on the same account.

Approval

Prepared by

Name: Thanakorn Sathitwitayakul
Role: Developer Signature: ______________________________________________
Date: ___________________________________________________

Reviewed by

Name: Apirach Supattaratpateep
Role: Project Manager
Signature: ______________________________________________
Date: ___________________________________________________

Reviewed and authorized by

Name: Seri Viriyasakultorn
Project roles: Project Sponsor / Customer Representative / Authorized Approver
Position: Managing Director
Company: B.R.N. Enterprise Co., Ltd.
Signature: ______________________________________________
Date: ___________________________________________________

5.8 KiB Raw Blame History Unescape Escape