docs: document SSH access for Jobs

[Wauplin]

Document hf jobs ssh ...

Depends on:

• huggingface-internal/moon-landing#18500
• [Jobs] Add SSH support to run a Job and connect to it huggingface_hub#4352

⚠️ Wait for huggingface_hub 1.20 to be released first.

Details

Adds an SSH section to docs/hub/jobs-configuration.md with:

• --ssh flag (CLI) / ssh=True (Python API) to make a Job's container reachable over SSH
• hf jobs ssh <job_id> command
• ssh://<job_id>@ssh.hf.jobs endpoint
• job.status.ssh_url attribute
• access requirements: write access to the Job's namespace + an SSH public key registered at https://huggingface.co/settings/keys
• port forwarding with ssh -L / -R (e.g. access a TensorBoard running in a training Job, or let the Job reach a local resource)

SSH is not billed.
SSH not supported for scheduled jobs.

🤖 Generated with Claude Code

---

Note

Low Risk
Documentation-only change with no runtime or security logic modifications in this repo.

Overview
Adds a new SSH section to docs/hub/jobs-configuration.md (after Expose Ports, before Timeout) describing how to enable and use interactive SSH into running Jobs.

The docs cover enabling SSH at create time (--ssh / ssh=True), connecting with hf jobs ssh <job_id> or ssh <job_id>@ssh.hf.jobs, and job.status.ssh_url. They state Write access to the job namespace and SSH keys from huggingface.co/settings/keys, and that SSH applies to hf jobs run and hf jobs uv run but not scheduled jobs.

CLI extras documented include --dry-run and -i/--identity-file. A Port forwarding subsection explains -L (e.g. TensorBoard on 6006) and -R (expose a local service to the container).

^{Reviewed by Cursor Bugbot for commit cedb5fc. Bugbot is set up for automated code reviews on this repo. Configure here.}

[HuggingFaceDocBuilderDev]

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

[julien-c]

does this use Expose Ports under the hood? (which would make sense i guess)

[Wauplin]

hf 1.20.0 is shipped, time to merge :) https://github.com/huggingface/huggingface_hub/releases/tag/v1.20.0