winzik/docs/ide/dotenv.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

32 lines
1.7 KiB
Markdown

# .env files
`.env`, `.env.local`, `.env.<env>`, `.env.<env>.local`, `.env.dist`, Laravel's `.env.example` and Compose `*.env` files open in the
**.env editor**: **Code**, **Table**, **Split**, **Variables** and, for Symfony, **Vault** (the buttons at the bottom right).
## Code
Colours for names, values, comments, `${REFS}` and quotes; completion of the variables Symfony and Laravel know, of `${REFS}` and of
DSN examples (`DATABASE_URL=`, `MAILER_DSN=`…); markers for invalid names, unclosed quotes, a name defined twice, a secret in a file
git tracks.
## Table
The file's variables with their effective value for dev / test / prod. Rename, change, comment, add, delete, **Move to** another file,
**Copy to** an environment's file. Values are edited by kind: booleans, numbers, multi-line text, and DSNs with a **DSN builder**
(driver, user, password, host, port, database, options). A value another file overrides is struck through with the file that wins.
Each edit rewrites only that variable's lines.
## Variables
The folder's files merged in the order the application loads them (Symfony: `.env`, `.env.local`, `.env.<env>`, `.env.<env>.local`;
Laravel: `.env.<env>` or `.env`), with where each value comes from. References are resolved.
## Secrets
Names with PASSWORD, SECRET, TOKEN, KEY… are masked (the eye shows them). A real secret in a tracked file is a warning with **Move
them to .env.local** in one click (and `.gitignore` completed).
## Vault (Symfony)
The secrets of `config/secrets/<env>/`: reveal on demand, add / change (the value goes to the command's standard input, never on a
command line), delete, generate or rotate the keys. A decrypt key tracked by git is a danger banner.