mirror of
https://github.com/Xe138/AI-Trader.git
synced 2026-04-01 17:17:24 -04:00
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
This commit is contained in:
@@ -11,8 +11,8 @@
|
||||
|
||||
1. **Clone repository:**
|
||||
```bash
|
||||
git clone https://github.com/Xe138/AI-Trader.git
|
||||
cd AI-Trader
|
||||
git clone https://github.com/Xe138/AI-Trader-Server.git
|
||||
cd AI-Trader-Server
|
||||
```
|
||||
|
||||
2. **Configure environment:**
|
||||
@@ -70,13 +70,13 @@ docker-compose up
|
||||
|
||||
**Priority order:**
|
||||
1. `configs/custom_config.json` (if exists) - **Highest priority**
|
||||
2. Command-line argument: `docker-compose run ai-trader configs/other.json`
|
||||
2. Command-line argument: `docker-compose run ai-trader-server configs/other.json`
|
||||
3. `configs/default_config.json` (fallback)
|
||||
|
||||
**Advanced: Use a different config file name:**
|
||||
|
||||
```bash
|
||||
docker-compose run ai-trader configs/my_special_config.json
|
||||
docker-compose run ai-trader-server configs/my_special_config.json
|
||||
```
|
||||
|
||||
## Usage Examples
|
||||
@@ -94,7 +94,7 @@ docker-compose logs -f # Follow logs
|
||||
|
||||
### Run with custom config
|
||||
```bash
|
||||
docker-compose run ai-trader configs/custom_config.json
|
||||
docker-compose run ai-trader-server configs/custom_config.json
|
||||
```
|
||||
|
||||
### Stop containers
|
||||
@@ -156,10 +156,10 @@ docker-compose up
|
||||
|
||||
```bash
|
||||
# Backup
|
||||
tar -czf ai-trader-backup-$(date +%Y%m%d).tar.gz data/agent_data/
|
||||
tar -czf ai-trader-server-backup-$(date +%Y%m%d).tar.gz data/agent_data/
|
||||
|
||||
# Restore
|
||||
tar -xzf ai-trader-backup-YYYYMMDD.tar.gz
|
||||
tar -xzf ai-trader-server-backup-YYYYMMDD.tar.gz
|
||||
```
|
||||
|
||||
## Using Pre-built Images
|
||||
@@ -167,7 +167,7 @@ tar -xzf ai-trader-backup-YYYYMMDD.tar.gz
|
||||
### Pull from GitHub Container Registry
|
||||
|
||||
```bash
|
||||
docker pull ghcr.io/hkuds/ai-trader:latest
|
||||
docker pull ghcr.io/xe138/ai-trader-server:latest
|
||||
```
|
||||
|
||||
### Run without Docker Compose
|
||||
@@ -177,12 +177,12 @@ docker run --env-file .env \
|
||||
-v $(pwd)/data:/app/data \
|
||||
-v $(pwd)/logs:/app/logs \
|
||||
-p 8000-8003:8000-8003 \
|
||||
ghcr.io/hkuds/ai-trader:latest
|
||||
ghcr.io/xe138/ai-trader-server:latest
|
||||
```
|
||||
|
||||
### Specific version
|
||||
```bash
|
||||
docker pull ghcr.io/hkuds/ai-trader:v1.0.0
|
||||
docker pull ghcr.io/xe138/ai-trader-server:v1.0.0
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
@@ -239,7 +239,7 @@ docker pull ghcr.io/hkuds/ai-trader:v1.0.0
|
||||
Run bash inside container for debugging:
|
||||
|
||||
```bash
|
||||
docker-compose run --entrypoint /bin/bash ai-trader
|
||||
docker-compose run --entrypoint /bin/bash ai-trader-server
|
||||
```
|
||||
|
||||
### Build Multi-platform Images
|
||||
@@ -247,13 +247,13 @@ docker-compose run --entrypoint /bin/bash ai-trader
|
||||
For ARM64 (Apple Silicon) and AMD64:
|
||||
|
||||
```bash
|
||||
docker buildx build --platform linux/amd64,linux/arm64 -t ai-trader .
|
||||
docker buildx build --platform linux/amd64,linux/arm64 -t ai-trader-server .
|
||||
```
|
||||
|
||||
### View Container Resource Usage
|
||||
|
||||
```bash
|
||||
docker stats ai-trader-app
|
||||
docker stats ai-trader-server
|
||||
```
|
||||
|
||||
### Access MCP Services Directly
|
||||
@@ -295,10 +295,10 @@ cp configs/default_config.json configs/aggressive.json
|
||||
# Edit each config...
|
||||
|
||||
# Test conservative strategy
|
||||
docker-compose run ai-trader configs/conservative.json
|
||||
docker-compose run ai-trader-server configs/conservative.json
|
||||
|
||||
# Test aggressive strategy
|
||||
docker-compose run ai-trader configs/aggressive.json
|
||||
docker-compose run ai-trader-server configs/aggressive.json
|
||||
```
|
||||
|
||||
**Method 3: Temporarily switch configs**
|
||||
|
||||
@@ -31,30 +31,30 @@ Tag push automatically triggers `.github/workflows/docker-release.yml`:
|
||||
3. ✅ Logs into GitHub Container Registry
|
||||
4. ✅ Extracts version from tag
|
||||
5. ✅ Builds Docker image with caching
|
||||
6. ✅ Pushes to `ghcr.io/hkuds/ai-trader:VERSION`
|
||||
7. ✅ Pushes to `ghcr.io/hkuds/ai-trader:latest`
|
||||
6. ✅ Pushes to `ghcr.io/xe138/ai-trader-server:VERSION`
|
||||
7. ✅ Pushes to `ghcr.io/xe138/ai-trader-server:latest`
|
||||
|
||||
### 4. Verify Build
|
||||
|
||||
1. Check GitHub Actions: https://github.com/Xe138/AI-Trader/actions
|
||||
1. Check GitHub Actions: https://github.com/Xe138/AI-Trader-Server/actions
|
||||
2. Verify workflow completed successfully (green checkmark)
|
||||
3. Check packages: https://github.com/Xe138/AI-Trader/pkgs/container/ai-trader
|
||||
3. Check packages: https://github.com/Xe138/AI-Trader-Server/pkgs/container/ai-trader-server
|
||||
|
||||
### 5. Test Release
|
||||
|
||||
```bash
|
||||
# Pull released image
|
||||
docker pull ghcr.io/hkuds/ai-trader:v1.0.0
|
||||
docker pull ghcr.io/xe138/ai-trader-server:v1.0.0
|
||||
|
||||
# Test run
|
||||
docker run --env-file .env \
|
||||
-v $(pwd)/data:/app/data \
|
||||
ghcr.io/hkuds/ai-trader:v1.0.0
|
||||
ghcr.io/xe138/ai-trader-server:v1.0.0
|
||||
```
|
||||
|
||||
### 6. Create GitHub Release (Optional)
|
||||
|
||||
1. Go to https://github.com/Xe138/AI-Trader/releases/new
|
||||
1. Go to https://github.com/Xe138/AI-Trader-Server/releases/new
|
||||
2. Select tag: `v1.0.0`
|
||||
3. Release title: `v1.0.0 - Docker Deployment Support`
|
||||
4. Add release notes:
|
||||
@@ -67,8 +67,8 @@ This release adds full Docker support for easy deployment.
|
||||
### Pull and Run
|
||||
|
||||
```bash
|
||||
docker pull ghcr.io/hkuds/ai-trader:v1.0.0
|
||||
docker run --env-file .env -v $(pwd)/data:/app/data ghcr.io/hkuds/ai-trader:v1.0.0
|
||||
docker pull ghcr.io/xe138/ai-trader-server:v1.0.0
|
||||
docker run --env-file .env -v $(pwd)/data:/app/data ghcr.io/xe138/ai-trader-server:v1.0.0
|
||||
```
|
||||
|
||||
Or use Docker Compose:
|
||||
@@ -137,13 +137,13 @@ If automated build fails, manual push:
|
||||
|
||||
```bash
|
||||
# Build locally
|
||||
docker build -t ghcr.io/hkuds/ai-trader:v1.0.0 .
|
||||
docker build -t ghcr.io/xe138/ai-trader-server:v1.0.0 .
|
||||
|
||||
# Login to GHCR
|
||||
echo $GITHUB_TOKEN | docker login ghcr.io -u USERNAME --password-stdin
|
||||
|
||||
# Push
|
||||
docker push ghcr.io/hkuds/ai-trader:v1.0.0
|
||||
docker tag ghcr.io/hkuds/ai-trader:v1.0.0 ghcr.io/hkuds/ai-trader:latest
|
||||
docker push ghcr.io/hkuds/ai-trader:latest
|
||||
docker push ghcr.io/xe138/ai-trader-server:v1.0.0
|
||||
docker tag ghcr.io/xe138/ai-trader-server:v1.0.0 ghcr.io/xe138/ai-trader-server:latest
|
||||
docker push ghcr.io/xe138/ai-trader-server:latest
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user