Setup/Help

* be more clear that connecting to auth and characters db is conditional
 * updated some lost references to renamed databases and config options
This commit is contained in:
Sarjuuk 2026-04-08 14:43:30 +02:00
parent 20f38e1c2b
commit 725686d1cd
5 changed files with 21 additions and 8 deletions

View file

@ -51,7 +51,7 @@ audio processing may require [lame](https://sourceforge.net/projects/lame/files/
`git clone git@github.com:Sarjuuk/MPQExtractor.git MPQExtractor`
#### 2. Prepare the database
Ensure that the account you are going to use has **full** access on the database AoWoW is going to occupy and ideally only **read** access on the world database you are going to reference.
Ensure that the account you are going to use has **full** access on the database AoWoW is going to occupy and ideally only **read** access on the world and optionally auth and characters databases you are going to reference.
Import files 01 - 03 from `setup/sql/` in order into the AoWoW database `mysql --default-character-set=utf8 -p {your-db-here} < setup/sql/01-db_structure.sql`, etc.
**Optional**: If you are using MySQL ≥ 8.4.0 and want to support fulltext search for locale zhCN, additionally import `setup/sql/04-db_optional_mysql_only.sql`. Enables this in settings after AoWoW has been set up.
@ -104,7 +104,7 @@ When you've created your admin account you are done.
## Troubleshooting
Q: The Page appears white, without any styles.
A: The static content is not being displayed. You are either using SSL and AoWoW is unable to detect it or STATIC_HOST is not defined properly. Either way this can be fixed via config `php aowow --siteconfig`
A: The static content is not being displayed. You are either using SSL and AoWoW is unable to detect it or STATIC_HOST is not defined properly. Either way this can be fixed via config `php aowow --configure`
Q: Fatal error: Can't inherit abstract function \<functionName> (previously declared abstract in \<className>) in \<path>
A: You are using multiple cache optimization modules for php that are in conflict with each other. (Zend OPcache, XCache, ..) Disable all but one.

View file

@ -257,7 +257,7 @@ class Profiler
{
self::getRealms();
// sort depends on encountered order in `logon`.`realmlist`. Is that a problem?
// sort depends on encountered order in `auth`.`realmlist`. Is that a problem?
return array_unique(array_column(self::$realms, 'region'));
}

View file

@ -85,7 +85,7 @@ CLISetup::registerUtility(new class extends UtilityScript
{
CLI::write();
if (!DB::isConnectable(DB_AUTH) || !$this->test())
CLI::write('[db] auth server not yet set up.', CLI::LOG_ERROR);
CLI::write('[db] auth db not yet set up.', CLI::LOG_ERROR);
else if ($realms = DB::Auth()->selectAssoc('SELECT `id` AS "0", `name` AS "1", `icon` AS "2", `timezone` AS "3", `allowedSecurityLevel` AS "4" FROM realmlist'))
{
$tbl = [['Realm Id', 'Name', 'Type', 'Region', 'GMLevel', 'Status']];
@ -309,15 +309,21 @@ CLISetup::registerUtility(new class extends UtilityScript
$buff[] = $dbInfo['prefix'] ? 'pre.: '.$dbInfo['prefix'] : '';
$buff[] = $note;
}
else if ($idx == DB_AUTH)
$buff[] = CLI::bold('<optional>');
else
$buff[] = CLI::bold('<empty>');
$buff[] = CLI::bold('<required>');
return $buff;
}
public function writeCLIHelp() : bool
{
CLI::write(' Remember to use the correct Realm Id from '.CLI::bold('`logon`.`realmlist`').' when connecting to your characters DB.', -1, false);
CLI::write(' Connecting to '.CLI::bold('`auth`').' is optional and only required when using the character profiler tool or using the game accounts for login.', -1, false);
CLI::write();
CLI::write(' Connecting to '.CLI::bold('`characters`').' is optional and only required when using the character profiler tool.', -1, false);
CLI::write(' Remember to use the correct Realm Id from '.CLI::bold('`auth`.`realmlist`').' when connecting to your characters DB.', -1, false);
CLI::write();
CLI::write(' To remove a db entry edit it and leave all fields empty.', -1, false);
CLI::write();
CLI::write();

View file

@ -170,8 +170,10 @@ CLISetup::registerUtility(new class extends UtilityScript
CLI::write(' usage: php aowow --setup [--locales: --datasrc:] [--step=<step>]', -1, false);
CLI::write();
CLI::write(' Initially essential connection information are set up and basic connectivity tests run afterwards.', -1, false);
CLI::write();
CLI::write(' In the main stage dbc and world data is compiled into the database and required sound, image and data files are generated.', -1, false);
CLI::write(' This should not require further input and will take about 15-20 minutes, plus 10 minutes per additional locale.', -1, false);
CLI::write();
CLI::write(' Lastly pending updates are applied and you are prompted to create an administrator account.', -1, false);
if (($startStep = $this->getSavedStartStep()) !== 0)

View file

@ -111,8 +111,13 @@ CLISetup::registerUtility(new class extends UtilityScript
CLI::write();
CLI::write(' Checks /setup/sql/updates for new *.sql files and applies them. If required by an applied update, the --sql and --build command are triggered afterwards.', -1, false);
CLI::write(' Use this after fetching the latest rev. from Github.', -1, false);
CLI::write();
CLI::write(' Last Update: '.date(Util::$dateFormatInternal, $this->date).' (Part #'.$this->part.')', -1, false);
if ($this->date)
{
CLI::write();
CLI::write(' Last Update: '.date(Util::$dateFormatInternal, $this->date).' (Part #'.$this->part.')', -1, false);
}
CLI::write();
CLI::write();