From 6f916853196bc1ee03f7be4b5d624202de37d589 Mon Sep 17 00:00:00 2001 From: uprightbass360 Date: Sun, 9 Nov 2025 02:55:00 -0500 Subject: [PATCH] docs: clarify ImportBackup usage --- docs/GETTING_STARTED.md | 7 +++++-- docs/SCRIPTS.md | 10 +++++++--- docs/TROUBLESHOOTING.md | 6 ++++-- 3 files changed, 16 insertions(+), 7 deletions(-) diff --git a/docs/GETTING_STARTED.md b/docs/GETTING_STARTED.md index b24dfab..16b6dd0 100644 --- a/docs/GETTING_STARTED.md +++ b/docs/GETTING_STARTED.md @@ -422,8 +422,11 @@ open http://localhost:8081 docker exec -it ac-mysql mysql -u root -p # Manual backup operations -./scripts/bash/backup-export.sh [output_dir] # Export user accounts & characters -./scripts/bash/backup-import.sh [backup_dir] # Import user data from backup +# Export user accounts & characters to a named directory +./scripts/bash/backup-export.sh storage/backups/ExportBackup_manual_$(date +%Y%m%d_%H%M%S) + +# Import data from a directory that contains the SQL dumps +./scripts/bash/backup-import.sh --backup-dir storage/backups/ImportBackup --password azerothcore123 # View available backups ls -la storage/backups/ diff --git a/docs/SCRIPTS.md b/docs/SCRIPTS.md index d319cdb..1291281 100644 --- a/docs/SCRIPTS.md +++ b/docs/SCRIPTS.md @@ -127,10 +127,14 @@ ExportBackup_YYYYMMDD_HHMMSS/ Restores user accounts and characters from backup while preserving world data. ```bash -./scripts/bash/backup-import.sh # Import from ImportBackup/ -./scripts/bash/backup-import.sh /path/to/backup # Import from specific directory +./scripts/bash/backup-import.sh --backup-dir storage/backups/ImportBackup --password azerothcore123 + +# Restore directly from an ExportBackup archive you just unpacked +./scripts/bash/backup-import.sh --backup-dir ExportBackup_20241029_120000 --password azerothcore123 --all ``` +> The importer always requires `--backup-dir`. A common workflow is to extract an `ExportBackup_*` archive into `storage/backups/ImportBackup/` and pass that directory to the script, but you can point to any folder that contains the SQL dumps. + **Required Files:** - `acore_auth.sql[.gz]` - User accounts (required) - `acore_characters.sql[.gz]` - Character data (required) @@ -401,4 +405,4 @@ sudo chown -R $USER:$USER storage/ --- -For additional help and troubleshooting information, refer to the main README.md file or check the project repository issues. \ No newline at end of file +For additional help and troubleshooting information, refer to the main README.md file or check the project repository issues. diff --git a/docs/TROUBLESHOOTING.md b/docs/TROUBLESHOOTING.md index c84f130..924623a 100644 --- a/docs/TROUBLESHOOTING.md +++ b/docs/TROUBLESHOOTING.md @@ -105,10 +105,12 @@ ExportBackup_YYYYMMDD_HHMMSS/ # Created by scripts/bash/backup-export.sh ├── acore_characters.sql.gz # Character data └── manifest.json -ImportBackup/ # Used by scripts/bash/backup-import.sh +ImportBackup/ # Optional staging area (use with --backup-dir) ├── acore_auth.sql[.gz] # Required: accounts ├── acore_characters.sql[.gz] # Required: characters └── acore_world.sql[.gz] # Optional: world data + +Place extracted dumps from any `ExportBackup_*` archive into this directory (or any other directory you prefer) and pass it to `scripts/bash/backup-import.sh --backup-dir ` when performing a manual restore. ``` --- @@ -124,4 +126,4 @@ ImportBackup/ # Used by scripts/bash/backup-import.sh For additional support: 1. Check the [AzerothCore Wiki](https://www.azerothcore.org/wiki/home) 2. Visit the [AzerothCore Discord](https://discord.gg/gkt4y2x) -3. Review [GitHub Issues](https://github.com/azerothcore/azerothcore-wotlk/issues) for known problems \ No newline at end of file +3. Review [GitHub Issues](https://github.com/azerothcore/azerothcore-wotlk/issues) for known problems