Commit Graph

5 Commits

Author SHA1 Message Date
3f136ab014 docs: update maintainer docs for AI-Trader-Server rebrand
Update maintainer documentation files:
- docs/DOCKER.md: Update git clone URL, Docker image references
  (ghcr.io/hkuds/ai-trader to ghcr.io/xe138/ai-trader-server),
  container/service names, and backup filenames
- docs/RELEASING.md: Update GitHub Actions URLs, Docker registry
  paths, container package URLs, and all release examples

All maintainer docs now reference the correct repository and Docker
image paths.

Part of Phase 3: Developer & Deployment Documentation
2025-11-01 12:00:22 -04:00
55206549c7 feat: add configurable volume path for persistent data
Add VOLUME_PATH environment variable to customize storage location for
all persistent data (data/, logs/, configs/ subdirectories).

Changes:
- .env.example: Add VOLUME_PATH variable with documentation
- docker-compose.yml: Use ${VOLUME_PATH:-.} for all volume mounts
- docs/DOCKER.md: Document custom volume location feature

Benefits:
- Store data outside project directory (e.g., on separate disk)
- Easier backup/restore (single directory)
- Clean separation of code and data
- Support for absolute or relative paths

Usage:
  # In .env file
  VOLUME_PATH=/home/user/trading-data

  # Results in mounts:
  /home/user/trading-data/data:/app/data
  /home/user/trading-data/logs:/app/logs
  /home/user/trading-data/configs:/app/configs

Defaults to current directory (.) if not set for backward compatibility.
2025-10-30 23:40:21 -04:00
2f2c1d6ea2 feat: simplify Docker config file selection with convention over configuration
Implement automatic detection of custom_config.json for simpler Docker usage.
No environment variables or command-line arguments needed for most users.

Changes:
- entrypoint.sh: Add smart config detection (custom_config.json > CLI arg > default_config.json)
- docker-compose.yml: Add configs volume mount for editing without rebuilds
- docs/DOCKER.md: Update documentation with simplified workflow
- .gitignore: Add custom_config.json to prevent accidental commits

Usage:
  cp configs/default_config.json configs/custom_config.json
  nano configs/custom_config.json
  docker-compose up  # Automatically uses custom_config.json

Simplifies user experience by following convention over configuration principle.
2025-10-30 22:34:22 -04:00
e4b7e197d3 Update repository URLs for fork
Change HKUDS/AI-Trader to Xe138/AI-Trader
Update all documentation links and references
2025-10-30 20:26:18 -04:00
733b6a4b1c Add Docker deployment documentation
Comprehensive guide including:
- Quick start instructions
- Configuration options
- Usage examples and volume persistence
- Troubleshooting common issues
- Pre-built image usage
2025-10-30 18:41:27 -04:00