winzik/docs/ide/ssh.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.4 KiB
Markdown

# SSH
The **SSH** window (right, desktop) works with your servers through this computer's own `ssh` and `scp`: your `~/.ssh/config`, keys,
agent and `known_hosts` apply. The IDE never keeps a password.
![Servers](images/ssh-servers.png)
## Servers
**+**: name, host (or an alias of `~/.ssh/config`), port, user, key file (a button opens the system's chooser in `~/.ssh`), jump host,
start folder. **Import from ~/.ssh/config**. **Test the connection**. Kept in `~/.jumphp/ide-ssh.json` on this computer, never in a
project.
## Sessions
A new Terminal tab runs `ssh -t`: passwords, host keys, colours, vim work as in your terminal (Windows: a console window). On
Linux / macOS a session is the master of a shared connection: while it is open, files and transfers reuse it (servers with a
password or a one-time code work too).
## Files
![Remote files](images/ssh-files.png)
The folder button: browse, go in, **open a file in the editor** (saved back over SSH, 5 MB at most), new folder, rename, copy / move,
delete, **upload** and **download** with scp and its progress (stoppable).
**Drag and drop**: files of the file manager or of the Project view dropped on the list are uploaded; remote rows dragged to a folder
of the Project view or to the file manager are downloaded. A name already there: Overwrite, Skip or Rename.
## Used elsewhere
SSH servers serve as [database](database.md) tunnels and [remote Docker engines](docker.md).