From 743c3f2c54f179c83d40dcc299483fd63293f921 Mon Sep 17 00:00:00 2001 From: Deckard Date: Sat, 27 Sep 2025 03:09:14 -0400 Subject: [PATCH] Update documentation and remove CMS components - Update readme.md to reflect new docker-compose.yml structure - Remove obsolete portainer-env-template.txt file - Update PORTAINER_DEPLOYMENT.md to reference docker-compose.yml - Remove assets/ directory with CMS interface files - Clean up CMS references from documentation - Streamline project to focus on core AzerothCore functionality --- PORTAINER_DEPLOYMENT.md | 6 +-- portainer-env-template.txt | 103 ------------------------------------- readme.md | 43 +++++----------- 3 files changed, 16 insertions(+), 136 deletions(-) delete mode 100644 portainer-env-template.txt diff --git a/PORTAINER_DEPLOYMENT.md b/PORTAINER_DEPLOYMENT.md index d945e84..68b635c 100644 --- a/PORTAINER_DEPLOYMENT.md +++ b/PORTAINER_DEPLOYMENT.md @@ -5,8 +5,8 @@ This guide will help you deploy AzerothCore in Portainer using your existing NFS storage structure. ### **📁 Files Needed:** -- `portainer-stack.yml` - Main docker-compose stack file -- `portainer-env-template.txt` - Environment variables template +- `docker-compose.yml` - Main docker-compose stack file +- `.env` - Environment variables (set DEPLOYMENT_MODE=portainer) - `backup-scripts/` Storage directory of backup and restoration scripts --- @@ -49,7 +49,7 @@ cp -r ./backup-scripts/ ${STORAGE_PATH_CONTAINERS}/azerothcore/ 3. Build method: Web editor ### **2.2 Copy Stack Configuration** -Copy the contents of `portainer-stack.yml` into the web editor. +Copy the contents of `docker-compose.yml` into the web editor. ### **2.3 Configure Environment Variables** In the Environment variables section, add all variables from `portainer-env-template.txt`: diff --git a/portainer-env-template.txt b/portainer-env-template.txt deleted file mode 100644 index 2a86a53..0000000 --- a/portainer-env-template.txt +++ /dev/null @@ -1,103 +0,0 @@ -# ============================================== -# PORTAINER ENVIRONMENT VARIABLES - AZEROTHCORE -# ============================================== -# Copy these variables to your Portainer stack environment variables section -# Update the values according to your server configuration - -# ============================================== -# STORAGE PATH (REQUIRED) -# ============================================== -# Main storage path - update this to match your NFS mount -STORAGE_PATH_CONTAINERS=/nfs/containers - -# ============================================== -# DATABASE CREDENTIALS -# ============================================== -MYSQL_ROOT_PASSWORD=azerothcore123 -MYSQL_USER=root -DB_AUTH_NAME=acore_auth -DB_WORLD_NAME=acore_world -DB_CHARACTERS_NAME=acore_characters - -# ============================================== -# NETWORK CONFIGURATION -# ============================================== -# Update this to your server's actual external IP -EXTERNAL_IP=192.168.1.100 -BIND_IP=0.0.0.0 - -# External ports (ensure these don't conflict with other services) -DOCKER_DB_EXTERNAL_PORT=64306 -DOCKER_AUTH_EXTERNAL_PORT=3784 -DOCKER_WORLD_EXTERNAL_PORT=8215 -DOCKER_SOAP_EXTERNAL_PORT=7778 - -# ============================================== -# WEB INTERFACE PORTS -# ============================================== -PMA_EXTERNAL_PORT=8081 -GF_EXTERNAL_PORT=3001 -INFLUXDB_EXTERNAL_PORT=8087 -KEIRA3_EXTERNAL_PORT=4201 -CMS_EXTERNAL_PORT=8001 - -# ============================================== -# SERVER CONFIGURATION -# ============================================== -TZ=UTC -REALM_ID=1 -REALM_NAME=AzerothCore -REALM_ZONE=1 -GAME_TYPE=0 -LOG_LEVEL=1 -CONSOLE_ENABLE=1 - -# ============================================== -# PLAYERBOT SETTINGS -# ============================================== -PLAYERBOT_ENABLED=1 -PLAYERBOT_MAX_BOTS=40 -MODULE_PLAYERBOTS=1 - -# ============================================== -# PERFORMANCE SETTINGS -# ============================================== -INNODB_BUFFER_POOL_SIZE=256M -INNODB_LOG_FILE_SIZE=64M -MAX_CONNECTIONS=1000 - -# ============================================== -# BACKUP CONFIGURATION -# ============================================== -BACKUP_CRON_SCHEDULE=0 3 * * * -BACKUP_RETENTION_DAYS=7 -BACKUP_FILE_PREFIX=acore_backup - -# ============================================== -# WEB INTERFACE CREDENTIALS -# ============================================== -# Grafana -GF_SECURITY_ADMIN_USER=admin -GF_SECURITY_ADMIN_PASSWORD=acore123 - -# InfluxDB -INFLUXDB_ADMIN_USER=acore -INFLUXDB_ADMIN_PASSWORD=acore123 -INFLUXDB_ORG=azerothcore -INFLUXDB_BUCKET=metrics -INFLUXDB_TOKEN=acore-monitoring-token-12345 - -# PHPMyAdmin -PMA_HOST=ac-mysql -PMA_PORT=3306 -PMA_USER=root -PMA_ARBITRARY=1 -PMA_UPLOAD_LIMIT=300M -PMA_MEMORY_LIMIT=512M -PMA_MAX_EXECUTION_TIME=600 - -# ============================================== -# NETWORK SETTINGS -# ============================================== -NETWORK_SUBNET=172.28.0.0/16 -NETWORK_GATEWAY=172.28.0.1 \ No newline at end of file diff --git a/readme.md b/readme.md index 4777586..e0412ec 100644 --- a/readme.md +++ b/readme.md @@ -96,16 +96,17 @@ This project provides a production-ready AzerothCore deployment using Docker/Pod ## Project Structure ``` -azerothcore-docker/ +acore-compose/ ├── docker-compose.yml # Main orchestration file -├── .env # Environment configuration (create from .env.example) +├── .env # Environment configuration ├── data/ # Game data files (maps, vmaps, etc.) │ ├── dbc/ # Client database files │ ├── maps/ # Map files │ ├── vmaps/ # Visual map files │ └── mmaps/ # Movement map files (optional) ├── backups/ # Automated backup storage -└── logs/ # Application logs +├── backup-scripts/ # Database backup automation +└── assets/ # Web interface assets ``` ## Container Architecture @@ -121,7 +122,7 @@ azerothcore-docker/ | `ac-phpmyadmin` | phpmyadmin/phpmyadmin:latest | Database management web UI | 8081:80 | ✅ Running | | `ac-grafana` | grafana/grafana:latest | Monitoring dashboard | 3001:3000 | ✅ Running | | `ac-influxdb` | influxdb:2.7-alpine | Metrics database | 8087:8086 | ✅ Running | -| `ac-keira3` | keira3:latest | Production database editor | 4201:8080 | ✅ Running (healthy) | +| `ac-keira3` | uprightbass360/keira3:latest | Production database editor with API | 4201:8080 | ✅ Running (healthy) | | `ac-backup` | mysql:8.0 | Automated backup service | - | ✅ Running | | `ac-modules` | alpine/git:latest | Module management | - | ✅ Running | @@ -145,18 +146,17 @@ graph TD ## Initial Setup -### Step 1: Prepare Environment File +### Step 1: Clone and Configure ```bash -# Create project directory -mkdir -p /opt/azerothcore-docker -cd /opt/azerothcore-docker +# Clone the repository +git clone https://github.com/uprightbass360/acore-compose.git +cd acore-compose -# Create .env file with your configuration -# Copy the provided .env template and modify: +# Environment file is already configured with defaults +# Modify .env file for your specific deployment: # - EXTERNAL_IP: Your server's public IP -# - MYSQL_ROOT_PASSWORD: Strong password -# - HOST_*_PATH: Adjust paths as needed +# - MYSQL_ROOT_PASSWORD: Strong password (default: azerothcore123) ``` ### Step 2: Prepare Game Data Files @@ -179,7 +179,6 @@ cp -r /path/to/extracted/mmaps/* data/mmaps/ # Optional ### Step 3: Deploy the Stack -#### Using Docker Compose: ```bash # Deploy all services docker-compose up -d @@ -191,21 +190,6 @@ docker-compose logs -f docker ps | grep ac- ``` -#### Using Podman Compose: -```bash -# Install podman-compose if needed -pip3 install podman-compose - -# Deploy all services -podman-compose up -d - -# Monitor deployment -podman-compose logs -f - -# Verify all containers are running -podman ps | grep ac- -``` - ### Step 4: Initial Database Import The database import happens automatically via the `ac-db-import` container. Monitor progress: @@ -635,7 +619,7 @@ docker stats --no-stream | **Auth Server** | `localhost:3784` | 3784 | Authentication server | | **SOAP API** | `localhost:7778` | 7778 | Server administration API | | **PHPMyAdmin** | `http://localhost:8081` | 8081 | Database management interface | -| **Keira3** | `http://localhost:4201` | 4201 | Database editor web UI | +| **Keira3** | `http://localhost:4201` | 4201 | Database editor web UI with API backend | | **Grafana** | `http://localhost:3001` | 3001 | Monitoring dashboard | | **InfluxDB** | `localhost:8087` | 8087 | Metrics database | | **MySQL** | `localhost:64306` | 64306 | Direct database access | @@ -649,7 +633,6 @@ docker stats --no-stream ### Related Projects - **[Original Docker Setup](https://github.com/coc0nut/AzerothCore-with-Playerbots-Docker-Setup)** - Base Docker configuration this project extends - **[AzerothCore Modules](https://github.com/azerothcore/mod-repo-list)** - Additional modules catalog -- **[AC-Web](https://github.com/azerothcore/acore-cms)** - Web CMS for AzerothCore ### Useful Commands Reference ```bash