winzik/docs/ide/docker.md
David Nurdin 7de153fc14 IDE documentation: one page per feature (docs/ide/, French in docs/ide/fr/) and a Doc browser inside the IDE
- docs/ide/: 49 user pages grouped in toc.json (editing, languages, run / test / debug, Git, web sites and Symfony, databases,
  Docker and SSH, games, AI, team, settings); pages of features still being built are "coming soon" stubs with a TODO list;
  15 pages translated into French; docs/ide.md and docs/ide.fr.md link to them.
- The Doc button at the top right of the IDE, Help > Documentation, Search Everywhere "Documentation" and a "?" in each tool
  window's header open the Doc browser (ide/ui/js/docs-browser.js): table of contents, rendered pages (pictures, code, tables,
  links between pages and to headings), full-text search, back / forward, the IDE's language with English as the fallback.
- ide/src/Docs/DocsLibrary.php (docs.index, docs.image): reads only the documentation folder (strict names, real path checked);
  the packaged copy ui/docs first, else the repository's docs/ide.
- Packaging: tools/stage-game.sh copies docs/ide into the exported IDE (its *.md exclusion would drop them), overlay-build.php
  puts them in code updates, bin/jumphp ide syncs them.
- Tests: docs-model.test.mjs (TOC, links, anchors, pictures, search; every page and picture of docs/ide exists), DocsLibraryTest
  (path traversal refused), the i18n test covers the new texts in 14 languages.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01JkYTqsvYu6AYr9yQ3Q4Nt6
2026-11-16 00:08:42 +01:00

39 lines
1.6 KiB
Markdown

# Docker
The **Docker** window (right, the whale) shows the Docker engine: containers, images, volumes, networks, Compose and Docker Hub.
## Containers
Grouped by Compose project, with CPU and memory. Start, stop, restart, remove; **Logs** (followed live), **Shell** (a Terminal tab in
the container), **Inspect**; a published port opens in the browser.
## Images, volumes, networks
Lists, remove, **prune**; **Pull** with its progress; **Run…** (a form: image, name, ports, volumes, environment).
## Docker Hub
Search, an image's tags, pull; **Insert into the editor** writes `image: name:tag`.
## Compose
![The Compose tab](images/docker-compose.png)
The project's compose files per folder (what starts them, the order they are merged), create the override, **Add a service** from a
template (MariaDB, MySQL, PostgreSQL, Redis, Memcached, Mailpit, Adminer, phpMyAdmin, RabbitMQ, Elasticsearch, Meilisearch, MongoDB),
**Check** (`docker compose config`: errors in Problems at their line), **Apply**. For web sites: the PHP version and the Docker setup
([Web sites](web-sites.md)).
## A remote engine
The **Engine** menu (kept per project):
- **This computer**.
- **A server of the SSH window**: the IDE opens its own SSH tunnel to the server's Docker socket (your key, port and jump host are
used) and runs `docker -H` through it. Only the docker client is needed here; the server needs Docker.
- **A docker context**.
![A remote engine](images/docker-engine.png)
Everything then works on that engine; a Compose **Up** runs on the server, in its folder. Errors are explained (unknown host key, no
Docker, a user outside the `docker` group with the line to type).