Skip to content

Commit fc36a5e

Browse files
committed
docs: remove outdated Docker Compose references
The repository does not include docker-compose files, but multiple docs claimed "Docker Compose deployment out of the box." This was left over from a previous release. Changes: - README.md: Update FAQ to describe Python package deployment - README.ko.md: Same update for Korean translation - docs/configuration.md: Remove "Docker Compose Integration" section and docker compose commands - docs/quizzes: Update tasks that referenced docker-compose.yml - .github/CODEOWNERS: Remove docker-compose*.yml entry - scripts/setup.sh: Remove docker-compose.override.yml copy step Fixes aden-hive#923
1 parent 3279686 commit fc36a5e

7 files changed

Lines changed: 10 additions & 38 deletions

File tree

.github/CODEOWNERS

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88
/hive/ @adenhq/maintainers
99

1010
# Infrastructure
11-
/docker-compose*.yml @adenhq/maintainers
1211
/.github/ @adenhq/maintainers
1312

1413
# Documentation

README.ko.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,7 @@ Aden은 모니터링과 관측성을 위해 토큰 사용량, 지연 시간 메
352352

353353
**Q: Aden은 어떤 배포 방식을 지원하나요?**
354354

355-
Aden은 기본적으로 Docker Compose 배포를 지원하며, 프로덕션 및 개발 환경 설정을 모두 제공합니다. Docker를 지원하는 모든 인프라에서 셀프 호스팅이 가능합니다. 클라우드 배포 옵션과 Kubernetes 대응 설정은 로드맵에 포함되어 있습니다.
355+
Aden은 Python 패키지를 통한 셀프 호스팅 배포를 지원합니다. 설치 방법은 [환경 설정 가이드](ENVIRONMENT_SETUP.md)를 참조하세요. 클라우드 배포 옵션과 Kubernetes 대응 설정은 로드맵에 포함되어 있습니다.
356356

357357
**Q: Aden은 복잡한 프로덕션 규모의 사용 사례도 처리할 수 있나요?**
358358

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@ Aden collects telemetry data for monitoring and observability purposes, includin
351351

352352
**Q: What deployment options does Aden support?**
353353

354-
Aden supports Docker Compose deployment out of the box, with both production and development configurations. Self-hosted deployments work on any infrastructure supporting Docker. Cloud deployment options and Kubernetes-ready configurations are on the roadmap.
354+
Aden supports self-hosted deployments via Python packages. See the [Environment Setup Guide](ENVIRONMENT_SETUP.md) for installation instructions. Cloud deployment options and Kubernetes-ready configurations are on the roadmap.
355355

356356
**Q: Can Aden handle complex, production-scale use cases?**
357357

docs/configuration.md

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Hive uses a centralized configuration system based on a single `config.yaml` fil
66

77
```
88
config.yaml --> generate-env.ts --> .env files
9-
├── .env (root, for Docker)
9+
├── .env (root)
1010
├── honeycomb/.env (frontend)
1111
└── hive/.env (backend)
1212
```
@@ -132,18 +132,6 @@ cp config.yaml.example config.production.yaml
132132
# Edit for production settings
133133
```
134134

135-
## Docker Compose Integration
136-
137-
The root `.env` file is used by Docker Compose. Key variables:
138-
139-
| Variable | Description | Default |
140-
|----------|-------------|---------|
141-
| `FRONTEND_PORT` | Frontend container port | 3000 |
142-
| `BACKEND_PORT` | Backend container port | 4000 |
143-
| `NODE_ENV` | Node environment | production |
144-
| `DATABASE_URL` | Database connection | - |
145-
| `JWT_SECRET` | Auth secret key | - |
146-
147135
## Security Best Practices
148136

149137
1. **Never commit `config.yaml`** - It may contain secrets
@@ -158,11 +146,6 @@ After changing `config.yaml`:
158146
```bash
159147
# Regenerate .env files
160148
npm run generate:env
161-
162-
# Restart services
163-
docker compose restart
164-
# or
165-
docker compose up --build
166149
```
167150

168151
## Troubleshooting
@@ -175,11 +158,7 @@ docker compose up --build
175158

176159
### Configuration Validation Errors
177160

178-
The backend validates configuration on startup. Check logs for specific errors:
179-
180-
```bash
181-
docker compose logs hive
182-
```
161+
The backend validates configuration on startup. Check logs for specific errors.
183162

184163
### Missing Environment Variables
185164

docs/quizzes/01-getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,13 +83,13 @@ Answer these questions:
8383
1. What is the main frontend folder called?
8484
2. What is the main backend folder called?
8585
3. What file would you edit to configure the application?
86-
4. What's the Docker command to start all services (hint: check README)?
86+
4. What's the command to set up the Python environment (hint: check README)?
8787

8888
### Task 3.2: Find the Features 🎯
8989
Look through the codebase to find:
9090

9191
1. Where are the MCP tools defined? (provide the file path)
92-
2. What port does the API run on? (hint: check README or docker-compose)
92+
2. What port does the MCP server run on? (hint: check the tools/Dockerfile)
9393
3. Find one TypeScript interface related to agents (provide file path and interface name)
9494

9595
---

docs/quizzes/05-devops-challenge.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ Master the deployment and operations of AI agent infrastructure! This challenge
1313
### Task 1.1: Docker Deep Dive 🐳
1414
Analyze the Aden Docker setup:
1515

16-
1. List all services defined in `docker-compose.yml`
17-
2. What's the purpose of `docker-compose.override.yml`?
16+
1. What Dockerfile exists in the repository and what does it build?
17+
2. How would you containerize the MCP tools server?
1818
3. How is hot reload enabled for development?
19-
4. What volumes are mounted and why?
20-
5. What networking mode is used between services?
19+
4. What would need to be mounted as volumes for persistence?
20+
5. What networking considerations exist for the MCP server?
2121

2222
### Task 1.2: Service Dependencies 🔗
2323
Map the service dependencies:

scripts/setup.sh

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,6 @@ echo "Generating environment files from config.yaml..."
6565
npx tsx scripts/generate-env.ts
6666
echo "✓ Environment files generated"
6767

68-
# Create docker-compose.override.yml for development
69-
if [ ! -f "$PROJECT_ROOT/docker-compose.override.yml" ]; then
70-
cp "$PROJECT_ROOT/docker-compose.override.yml.example" "$PROJECT_ROOT/docker-compose.override.yml"
71-
echo "✓ Created docker-compose.override.yml for development"
72-
fi
73-
7468
echo ""
7569
echo "==================================="
7670
echo " Setup Complete (Legacy)"

0 commit comments

Comments
 (0)