Skip to content

docs: replace deprecated docker-compose v1 command with docker compose v2 #508

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
octo-patch wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: replace deprecated docker-compose v1 command with docker compose v2 #508

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fab38ac
docs: replace deprecated docker-compose v1 command with docker compos…
Apr 19, 2026
154785b
docs: use api/logs path in docker compose LOG_FILE_PATH examples
Apr 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.es.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ echo "OPENAI_API_KEY=your_openai_api_key" >> .env
echo "OPENROUTER_API_KEY=your_openrouter_api_key" >> .env

# Ejecutar con Docker Compose
docker-compose up
docker compose up
```

(Los comandos de Docker anteriores, así como la configuración de `docker-compose.yml`, montan el directorio `~/.adalflow` de tu host en `/root/.adalflow` dentro del contenedor. Esta ruta se utiliza para almacenar:
Expand Down
8 changes: 4 additions & 4 deletions README.fr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ echo "AZURE_OPENAI_ENDPOINT=votre_endpoint" >> .env
echo "AZURE_OPENAI_VERSION=version_api" >> .env

# Lancer avec Docker Compose
docker-compose up
docker compose up
```

Pour des instructions détaillées sur l’utilisation de DeepWiki avec Ollama et Docker, consultez [Ollama Instructions](Ollama-instruction.md).
Expand Down Expand Up @@ -287,7 +287,7 @@ python -m api.main
```
Ou avec Docker Compose:
```bash
LOG_LEVEL=DEBUG LOG_FILE_PATH=./debug.log docker-compose up
LOG_LEVEL=DEBUG LOG_FILE_PATH=./debug.log docker compose up

@gemini-code-assist gemini-code-assist Bot Apr 19, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The example uses LOG_FILE_PATH=./debug.log, but the documentation (line 307) states that the application enforces the log file to be within the api/logs directory for security reasons. Using ./debug.log will likely result in an error due to path traversal prevention.

Suggested change
LOG_LEVEL=DEBUG LOG_FILE_PATH=./debug.log docker compose up
LOG_LEVEL=DEBUG LOG_FILE_PATH=api/logs/debug.log docker compose up

```

Lors de l'exécution avec Docker Compose, le répertoire `api/logs` du conteneur est lié à `./api/logs` sur votre hôte (voir la section `volumes` dans `docker-compose.yml`), ce qui garantit que les fichiers journaux persistent lors des redémarrages.
Expand All @@ -301,7 +301,7 @@ LOG_FILE_PATH=./debug.log
Puis exécutez simplement :

```bash
docker-compose up
docker compose up
```

**Considérations de sécurité concernant le chemin des journaux :** Dans les environnements de production, assurez-vous que le répertoire `api/logs` et tout chemin de fichier journal personnalisé sont sécurisés avec des permissions de système de fichiers et des contrôles d'accès appropriés. L'application s'assure que `LOG_FILE_PATH` se trouve dans le répertoire `api/logs` du projet afin d'empêcher le parcours de chemin ou les écritures non autorisées.
Expand Down Expand Up @@ -373,7 +373,7 @@ Vous pouvez également utiliser le fichier `docker-compose.yml` fourni :

```bash
# Modifiez d'abord le fichier .env avec vos clés API
docker-compose up
docker compose up
```

(Le fichier `docker-compose.yml` est préconfiguré pour monter `~/.adalflow` pour la persistance des données, de manière similaire à la commande `docker run` ci-dessus.)
Expand Down
4 changes: 2 additions & 2 deletions README.ja.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ echo "OPENAI_API_KEY=your_openai_api_key" >> .env
echo "OPENROUTER_API_KEY=your_openrouter_api_key" >> .env

# Docker Composeで実行
docker-compose up
docker compose up
```

(上記の Docker コマンドおよび`docker-compose.yml`の設定では、ホスト上の`~/.adalflow`ディレクトリをコンテナ内の`/root/.adalflow`にマウントします。このパスは以下のものを保存するために使用されます：
Expand Down Expand Up @@ -233,7 +233,7 @@ docker run -p 8001:8001 -p 3000:3000 \

```bash
# まず.envファイルをAPIキーで編集
docker-compose up
docker compose up
```

（⁠docker-compose.yml ファイルは、上記の ⁠docker run コマンドと同様に、データ永続化のために ⁠~/.adalflow をマウントするように事前設定されています。）
Expand Down
4 changes: 2 additions & 2 deletions README.kr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ echo "OPENAI_API_KEY=your_openai_api_key" >> .env
echo "OPENROUTER_API_KEY=your_openrouter_api_key" >> .env

# Docker Compose로 실행
docker-compose up
docker compose up
```

> 💡 **API 키는 어디서 얻나요:**
Expand Down Expand Up @@ -224,7 +224,7 @@ docker run -p 8001:8001 -p 3000:3000 \

```bash
# API 키가 포함된 .env 파일을 먼저 편집
docker-compose up
docker compose up
```

(`docker-compose.yml` 파일은 위의 `docker run` 명령어와 유사하게 데이터 지속성을 위해 `~/.adalflow`를 마운트하도록 미리 구성되어 있습니다.)
Expand Down
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ echo "AZURE_OPENAI_API_KEY=your_azure_openai_api_key" >> .env
echo "AZURE_OPENAI_ENDPOINT=your_azure_openai_endpoint" >> .env
echo "AZURE_OPENAI_VERSION=your_azure_openai_version" >> .env
# Run with Docker Compose
docker-compose up
docker compose up
```

For detailed instructions on using DeepWiki with Ollama and Docker, see [Ollama Instructions](Ollama-instruction.md).
Expand Down Expand Up @@ -332,7 +332,7 @@ DEEPWIKI_EMBEDDER_TYPE=google
Then run:

```bash
docker-compose up
docker compose up
```

### Available Embedder Types
Expand Down Expand Up @@ -384,7 +384,7 @@ python -m api.main
```
Or with Docker Compose:
```bash
LOG_LEVEL=DEBUG LOG_FILE_PATH=./debug.log docker-compose up
LOG_LEVEL=DEBUG LOG_FILE_PATH=./debug.log docker compose up

@gemini-code-assist gemini-code-assist Bot Apr 19, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The example uses LOG_FILE_PATH=./debug.log, but the documentation (line 404) states that the application enforces the log file to be within the api/logs directory for security reasons. Using ./debug.log will likely result in an error due to path traversal prevention.

Suggested change
LOG_LEVEL=DEBUG LOG_FILE_PATH=./debug.log docker compose up
LOG_LEVEL=DEBUG LOG_FILE_PATH=api/logs/debug.log docker compose up

```

When running with Docker Compose, the container's `api/logs` directory is bind-mounted to `./api/logs` on your host (see the `volumes` section in `docker-compose.yml`), ensuring log files persist across restarts.
Expand All @@ -398,7 +398,7 @@ LOG_FILE_PATH=./debug.log
Then simply run:

```bash
docker-compose up
docker compose up
```

**Logging Path Security Considerations:** In production environments, ensure the `api/logs` directory and any custom log file path are secured with appropriate filesystem permissions and access controls. The application enforces that `LOG_FILE_PATH` resides within the project's `api/logs` directory to prevent path traversal or unauthorized writes.
Expand Down Expand Up @@ -482,7 +482,7 @@ Or use the provided `docker-compose.yml` file:

```bash
# Edit the .env file with your API keys first
docker-compose up
docker compose up
```

(The `docker-compose.yml` file is pre-configured to mount `~/.adalflow` for data persistence, similar to the `docker run` command above.)
Expand Down
8 changes: 4 additions & 4 deletions README.pt-br.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ echo "OPENROUTER_API_KEY=sua_chave_api_openrouter" >> .env
echo "OLLAMA_HOST=seu_host_ollama" >> .env

# Execute com Docker Compose
docker-compose up
docker compose up
```

Para instruções detalhadas sobre como usar o DeepWiki com Ollama e Docker, veja [Instruções do Ollama (em inglês)](Ollama-instruction.md).
Expand Down Expand Up @@ -272,7 +272,7 @@ python -m api.main
```
Ou com Docker Compose:
```bash
LOG_LEVEL=DEBUG LOG_FILE_PATH=./debug.log docker-compose up
LOG_LEVEL=DEBUG LOG_FILE_PATH=./debug.log docker compose up

@gemini-code-assist gemini-code-assist Bot Apr 19, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The example uses LOG_FILE_PATH=./debug.log, but the documentation (line 292) states that the application enforces the log file to be within the api/logs directory for security reasons. Using ./debug.log will likely result in an error due to path traversal prevention.

Suggested change
LOG_LEVEL=DEBUG LOG_FILE_PATH=./debug.log docker compose up
LOG_LEVEL=DEBUG LOG_FILE_PATH=api/logs/debug.log docker compose up

```

Ao executar com Docker Compose, o diretório `api/logs` do container é montado em `./api/logs` no seu host (veja a seção `volumes` em `docker-compose.yml`), garantindo que os arquivos de log persistam entre reinicializações.
Expand All @@ -286,7 +286,7 @@ LOG_FILE_PATH=./debug.log
Então simplesmente execute:

```bash
docker-compose up
docker compose up
```

**Considerações de Segurança do Caminho de Logging:** Em ambientes de produção, garanta que o diretório `api/logs` e qualquer caminho de arquivo de log personalizado estejam protegidos com permissões de sistema de arquivos e controles de acesso apropriados. O aplicativo impõe que `LOG_FILE_PATH` resida dentro do diretório `api/logs` do projeto para evitar travessia de caminho ou escritas não autorizadas.
Expand Down Expand Up @@ -349,7 +349,7 @@ Ou use o arquivo `docker-compose.yml` fornecido:

```bash
# Edite o arquivo .env com suas chaves API primeiro
docker-compose up
docker compose up
```

(O arquivo `docker-compose.yml` é pré-configurado para montar `~/.adalflow` para persistência de dados, similar ao comando `docker run` acima.)
Expand Down
8 changes: 4 additions & 4 deletions README.ru.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ echo "AZURE_OPENAI_API_KEY=ваш_azure_api_key" >> .env
echo "AZURE_OPENAI_ENDPOINT=ваш_azure_endpoint" >> .env
echo "AZURE_OPENAI_VERSION=ваша_azure_version" >> .env
# Запуск через Docker Compose
docker-compose up
docker compose up
```

Подробную инструкцию по работе с Ollama и Docker см. в [Ollama Instructions](Ollama-instruction.md).
Expand Down Expand Up @@ -275,7 +275,7 @@ python -m api.main

Или через Docker Compose:
```bash
LOG_LEVEL=DEBUG LOG_FILE_PATH=./debug.log docker-compose up
LOG_LEVEL=DEBUG LOG_FILE_PATH=./debug.log docker compose up

@gemini-code-assist gemini-code-assist Bot Apr 19, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The example uses LOG_FILE_PATH=./debug.log, but the application enforces the log file to be within the api/logs directory for security reasons (as mentioned in other localized READMEs). Using ./debug.log will likely result in an error due to path traversal prevention.

Suggested change
LOG_LEVEL=DEBUG LOG_FILE_PATH=./debug.log docker compose up
LOG_LEVEL=DEBUG LOG_FILE_PATH=api/logs/debug.log docker compose up

```

Для постоянства логов при перезапуске контейнера `api/logs` монтируется в `./api/logs`.
Expand All @@ -290,7 +290,7 @@ LOG_FILE_PATH=./debug.log
И просто выполнить:

```bash
docker-compose up
docker compose up
```

**Безопасность логов:** в продакшене важно настроить права доступа к `api/logs`, чтобы исключить несанкционированный доступ или запись.
Expand Down Expand Up @@ -357,7 +357,7 @@ docker run -p 8001:8001 -p 3000:3000 \

```bash
# Убедитесь, что .env заполнен
docker-compose up
docker compose up
```

#### Использование .env
Expand Down
4 changes: 2 additions & 2 deletions README.vi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ echo "OPENAI_API_KEY=your_openai_api_key" >> .env
echo "OPENROUTER_API_KEY=your_openrouter_api_key" >> .env

# Run với Docker Compose
docker-compose up
docker compose up
```

> 💡 **Hướng dẫn lấy Keys**
Expand Down Expand Up @@ -197,7 +197,7 @@ Hoặc đơn giản hơn, sử dụng `docker-compose.yml` :

```bash
# Edit the .env file with your API keys first
docker-compose up
docker compose up
```

#### Sử dụng .env file với Docker
Expand Down
8 changes: 4 additions & 4 deletions README.zh-tw.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ echo "OPENROUTER_API_KEY=your_openrouter_api_key" >> .env
echo "OLLAMA_HOST=your_ollama_host" >> .env

# 使用 Docker Compose 執行
docker-compose up
docker compose up
```

有關使用 DeepWiki 搭配 Ollama 和 Docker 的詳細說明，請參閱 [Ollama 操作說明](Ollama-instruction.md)。
Expand Down Expand Up @@ -279,7 +279,7 @@ python -m api.main
```
或使用 Docker Compose：
```bash
LOG_LEVEL=DEBUG LOG_FILE_PATH=./debug.log docker-compose up
LOG_LEVEL=DEBUG LOG_FILE_PATH=./debug.log docker compose up

@gemini-code-assist gemini-code-assist Bot Apr 19, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The example uses LOG_FILE_PATH=./debug.log, but the documentation (line 299) states that the application enforces the log file to be within the api/logs directory for security reasons. Using ./debug.log will likely result in an error due to path traversal prevention.

Suggested change
LOG_LEVEL=DEBUG LOG_FILE_PATH=./debug.log docker compose up
LOG_LEVEL=DEBUG LOG_FILE_PATH=api/logs/debug.log docker compose up

```

使用 Docker Compose 執行時，容器的 `api/logs` 目錄會掛載到主機上的 `./api/logs`（請參閱 `docker-compose.yml` 中的 `volumes` 區段），確保日誌檔案在重新啟動後仍然存在。
Expand All @@ -293,7 +293,7 @@ LOG_FILE_PATH=./debug.log
然後簡單執行：

```bash
docker-compose up
docker compose up
```

**日誌路徑安全性考量：** 在生產環境中，請確保 `api/logs` 目錄和任何自訂日誌檔案路徑都受到適當的檔案系統權限和存取控制保護。應用程式會強制要求 `LOG_FILE_PATH` 位於專案的 `api/logs` 目錄內，以防止路徑遍歷或未授權的寫入。
Expand Down Expand Up @@ -356,7 +356,7 @@ docker run -p 8001:8001 -p 3000:3000 \

```bash
# 首先使用您的 API 金鑰編輯 .env 檔案
docker-compose up
docker compose up
```

（`docker-compose.yml` 檔案預先設定為掛載 `~/.adalflow` 以保持資料持續性，類似於上面的 `docker run` 命令。）
Expand Down
2 changes: 1 addition & 1 deletion README.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ echo "OPENAI_API_KEY=your_openai_api_key" >> .env
echo "OPENROUTER_API_KEY=your_openrouter_api_key" >> .env

# 使用Docker Compose运行
docker-compose up
docker compose up
```

(上述 Docker 命令以及 `docker-compose.yml` 配置会挂载您主机上的 `~/.adalflow` 目录到容器内的 `/root/.adalflow`。此路径用于存储：
Expand Down