|
207 | 207 | </description> |
208 | 208 | </parent-class-prefix> |
209 | 209 |
|
| 210 | + <!-- ═══════════════════════════════════════════════════════════════════ |
| 211 | + SCRIPT DESCRIPTORS |
| 212 | + Title Case names and purpose descriptions for all NWE scripts. |
| 213 | + Scripts read this section at invocation to print their identity. |
| 214 | + Format: <script file="filename.sh" title="Title Case Name"> |
| 215 | + Description of what the script does. |
| 216 | + </script> |
| 217 | +
|
| 218 | + Capitalization rules from this file apply to all titles: |
| 219 | + • Proper nouns from <proper-nouns> always InitialCap |
| 220 | + • Acronyms from <preserved-acronyms> always UPPERCASE |
| 221 | + • All other words in Title Case (first letter uppercase) |
| 222 | + ════════════════════════════════════════════════════════════════════ --> |
| 223 | + <script-descriptors> |
| 224 | + |
| 225 | + <!-- Orchestration --> |
| 226 | + <script file="start-all.sh" title="Start All Services"> |
| 227 | + Complete system startup: MySQL → Backend TCP Servers → Tomcat Frontend Webapps. |
| 228 | + </script> |
| 229 | + <script file="shutdown-all.sh" title="Shutdown All Services"> |
| 230 | + Complete system shutdown: Frontends → Backends → MySQL. Reverse startup order. |
| 231 | + </script> |
| 232 | + <script file="start-backends.sh" title="Start All Backend Modules"> |
| 233 | + Launches individual TCP backend servers for all configured modules. |
| 234 | + </script> |
| 235 | + <script file="shutdown-backends.sh" title="Shutdown All Backend Modules"> |
| 236 | + Stops all running TCP backend servers by PID file. |
| 237 | + </script> |
| 238 | + <script file="start-frontends.sh" title="Start All Frontend Modules"> |
| 239 | + Deploys all module webapps to Tomcat and verifies HTTP endpoints. |
| 240 | + </script> |
| 241 | + <script file="shutdown-frontends.sh" title="Shutdown All Frontend Modules"> |
| 242 | + Undeploys all module webapps from Tomcat. |
| 243 | + </script> |
| 244 | + <script file="start-mysql.sh" title="Start MySQL Database"> |
| 245 | + Detects MySQL location (main drive or block storage) and starts the service. |
| 246 | + </script> |
| 247 | + <script file="shutdown-mysql.sh" title="Shutdown MySQL Database"> |
| 248 | + Gracefully stops the MySQL service. |
| 249 | + </script> |
| 250 | + <script file="startup.sh" title="Start NWE Main Process"> |
| 251 | + Launches Main.java with G1GC, 4GB heap. All core servers start internally. |
| 252 | + </script> |
| 253 | + <script file="start-backend-modules.sh" title="Start NWE Main With Port Verification"> |
| 254 | + Launches Main.java and monitors all 19 expected TCP ports until bound. |
| 255 | + </script> |
| 256 | + <script file="status.sh" title="System Status Report"> |
| 257 | + Reports running state of MySQL, all backend TCP servers, and Tomcat frontends. |
| 258 | + </script> |
| 259 | + |
| 260 | + <!-- Build and Compile --> |
| 261 | + <script file="compile-all-modules.sh" title="Compile All Modules"> |
| 262 | + Compiles all JAVA source (core + FBI + CIA + NSA + Duke + Library + Gray + Futures) into out/. |
| 263 | + </script> |
| 264 | + <script file="build-jar.sh" title="Build Fat JAR"> |
| 265 | + Compiles source and packages a runnable nwe.jar with all dependencies. |
| 266 | + </script> |
| 267 | + <script file="generate-structure.sh" title="Generate Project Structure"> |
| 268 | + Scans the project tree and writes STRUCTURE.txt with all directories and files. |
| 269 | + </script> |
| 270 | + |
| 271 | + <!-- Deployment --> |
| 272 | + <script file="post-clone.sh" title="Post-Clone Server Setup"> |
| 273 | + First-time install: JAVA 21, MySQL, Tomcat, firewall ports, databases, webapp deploy. |
| 274 | + </script> |
| 275 | + <script file="deploy-all.sh" title="Deploy All Web Modules"> |
| 276 | + Reads web-deploy-config.xml and deploys all enabled modules to Tomcat. |
| 277 | + </script> |
| 278 | + <script file="deploy-all-macos.sh" title="Deploy All Web Modules (macOS)"> |
| 279 | + macOS variant: deploys all modules to Homebrew Tomcat. |
| 280 | + </script> |
| 281 | + <script file="deploy-missing.sh" title="Deploy Missing Webapps"> |
| 282 | + Re-deploys individual modules that are returning HTTP 404. |
| 283 | + </script> |
| 284 | + <script file="patch-webinf-and-ssl.sh" title="Patch WEB-INF and SSL Configuration"> |
| 285 | + Ensures all module WEB-INF directories have correct db.properties and SSL settings. |
| 286 | + </script> |
| 287 | + <script file="setup-all-databases.sh" title="Setup All Module Databases"> |
| 288 | + Creates MySQL databases and tables for all modules that have setup-db.sh scripts. |
| 289 | + </script> |
| 290 | + |
| 291 | + <!-- Testing --> |
| 292 | + <script file="test-local.sh" title="Master Local Test Suite"> |
| 293 | + Full test: TCP ports, HTTP status codes, XML validity, settings integrity, memory. |
| 294 | + </script> |
| 295 | + <script file="test-module-db-connectivity.sh" title="Test Module Database Connectivity"> |
| 296 | + Verifies JDBC connectivity and db.properties for all module databases. |
| 297 | + </script> |
| 298 | + |
| 299 | + <!-- Infrastructure --> |
| 300 | + <script file="ufw-allow-all.sh" title="Open All NWE Firewall Ports"> |
| 301 | + Configures UFW to allow TCP traffic on all 29 NWE service ports. |
| 302 | + </script> |
| 303 | + <script file="detect-mysql.sh" title="Detect MySQL Location"> |
| 304 | + Detects MySQL datadir (main drive or block storage) and exports connection variables. |
| 305 | + </script> |
| 306 | + <script file="migrate-mysql-to-blockstorage.sh" title="Migrate MySQL to Block Storage"> |
| 307 | + Moves MySQL datadir to /mnt/blockstorage with symlink preservation. |
| 308 | + </script> |
| 309 | + <script file="fix-missing-deploy-scripts.sh" title="Fix Missing Deploy Scripts"> |
| 310 | + Auto-generates deploy-local.sh for modules that are missing one. |
| 311 | + </script> |
| 312 | + |
| 313 | + <!-- Utility --> |
| 314 | + <script file="run-module.sh" title="Run Single Module"> |
| 315 | + Starts a single named module (Futures, FBI, CIA, NSA, Duke, Library). |
| 316 | + </script> |
| 317 | + <script file="run-jar.sh" title="Run NWE From JAR"> |
| 318 | + Launches nwe.jar with DJL native library on classpath. |
| 319 | + </script> |
| 320 | + <script file="generate-website.sh" title="Generate Static Website"> |
| 321 | + Builds the NWE static HTML website from module metadata and templates. |
| 322 | + </script> |
| 323 | + <script file="discover-subjects.sh" title="Discover Website Subjects"> |
| 324 | + Scans modules for subject XML definitions used by the website generator. |
| 325 | + </script> |
| 326 | + <script file="send-transfer-summary.sh" title="Send Transfer Summary Email"> |
| 327 | + Emails a daily transfer/activity summary via SMTP. |
| 328 | + </script> |
| 329 | + |
| 330 | + <!-- Module-Level (per-module scripts) --> |
| 331 | + <script file="start-backend.sh" title="Start Module Backend Server"> |
| 332 | + Starts this module's TCP backend server and writes PID to data/pids/backend.pid. |
| 333 | + </script> |
| 334 | + <script file="shutdown-backend.sh" title="Shutdown Module Backend Server"> |
| 335 | + Stops this module's TCP backend server by PID file. |
| 336 | + </script> |
| 337 | + <script file="start-frontend.sh" title="Start Module Frontend Webapp"> |
| 338 | + Deploys this module's webapp to Tomcat and verifies the HTTP endpoint. |
| 339 | + </script> |
| 340 | + <script file="shutdown-frontend.sh" title="Shutdown Module Frontend Webapp"> |
| 341 | + Undeploys this module's webapp from Tomcat. |
| 342 | + </script> |
| 343 | + <script file="start.sh" title="Start Module (Legacy)"> |
| 344 | + Deploys webapp to Tomcat and starts Tomcat if not running. |
| 345 | + </script> |
| 346 | + <script file="shutdown.sh" title="Shutdown Module (Legacy)"> |
| 347 | + Undeploys webapp from Tomcat. Use --stop-tomcat to also stop Tomcat. |
| 348 | + </script> |
| 349 | + |
| 350 | + <!-- GitHub --> |
| 351 | + <script file="pull-newer-only.sh" title="Pull Newer Files Only"> |
| 352 | + Git pull with conflict resolution: keeps newer local files, pulls newer remote files. |
| 353 | + </script> |
| 354 | + |
| 355 | + </script-descriptors> |
| 356 | + |
210 | 357 | <!-- ═══════════════════════════════════════════════════════════════════ |
211 | 358 | GRACE — fade animation timing |
212 | 359 | ════════════════════════════════════════════════════════════════════ --> |
|
0 commit comments