[PR #1369] [MERGED] docs: refresh and fill in Open Terminal screenshots #1338

New issue

Closed

opened 2026-10-18 14:18:57 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-18 14:18:57 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/docs/pull/1369
Author: @silentoplayz
Created: 9/1/2026
Status: ✅ Merged
Merged: 9/2/2026
Merged by: @Classic298

Base: main ← Head: docs/open-terminal-screenshots-v2

📝 Commits (1)

78a7449 docs: refresh and fill in Open Terminal screenshots

📊 Changes

65 files changed (+169 additions, -33 deletions)

View changed files

📝 docs/features/open-terminal/advanced/security.md (+91 -7)
📝 docs/features/open-terminal/file-browser.md (+14 -2)
📝 docs/features/open-terminal/index.md (+3 -3)
📝 docs/features/open-terminal/setup/connecting.md (+26 -4)
📝 docs/features/open-terminal/setup/installation.mdx (+18 -2)
📝 docs/features/open-terminal/use-cases/advanced-workflows/app-builder.md (+2 -2)
📝 docs/features/open-terminal/use-cases/advanced-workflows/code-review.md (+2 -2)
📝 docs/features/open-terminal/use-cases/advanced-workflows/competitive-analysis.md (+2 -2)
📝 docs/features/open-terminal/use-cases/advanced-workflows/data-reports.md (+3 -1)
📝 docs/features/open-terminal/use-cases/advanced-workflows/document-comparison.md (+2 -2)
📝 docs/features/open-terminal/use-cases/advanced-workflows/email-processing.md (+2 -2)
📝 docs/features/open-terminal/use-cases/advanced-workflows/finance-dashboard.md (+2 -2)
📝 docs/features/open-terminal/use-cases/advanced-workflows/image-processing.md (+1 -1)
📝 docs/features/open-terminal/use-cases/system-automation.md (+1 -1)
➕ static/images/open-terminal-access-grants.png (+0 -0)
➕ static/images/open-terminal-ai-batch-convert.png (+0 -0)
📝 static/images/open-terminal-ai-code-execution.png (+0 -0)
📝 static/images/open-terminal-ai-csv-analysis.png (+0 -0)
📝 static/images/open-terminal-ai-debug-fix.png (+0 -0)
📝 static/images/open-terminal-ai-disk-usage.png (+0 -0)

...and 45 more files

📄 Description

Summary

Picks up @Classic298's ask: the Open Terminal screenshots were outdated, some pages had none, and display_file was underrepresented.

This resolves 28 of the 39 screenshot TODO markers, refreshes the 24 existing images, and adds new ones. Every screenshot is a full-window 3200x1766 frame, matching the framing of the images it replaces. An earlier revision of this branch cropped the chat replies down to just the assistant message, which stripped out the sidebar, the terminal selector and the file browser panel. That was the wrong call for a product screenshot and all 19 affected frames were re-shot full-window.

Not every brief wanted a picture. Five asked for screenshots of shell output, and those are code blocks now using real output: the Open Terminal startup banner, docker stats from a container actually started with the documented --memory 2g --cpus 2 (67.57MiB / 2GiB 3.30%), and docker compose up -d. Four asked for diagrams and are now mermaid, matching the blocks already used elsewhere in the docs: container isolation, internal: true networking, Docker socket exposure, and the connection-URL diagram on connecting.md.

Three corrections came out of the pass:

connecting.md promised a green "Connected" indicator. There isn't one; the saved connection shows an enable toggle. Prose and alt text now match the UI.
file-browser.md used one generic screenshot for three different claims. Two of those now have images showing what the text actually describes, including the page-jump behaviour and the sidebar viewer.
The image variants table checks out: open-terminal:latest measures 3.97 GB against the documented "~4 GB".

No linked issue. This is a documentation pass on the Open Terminal section, raised with me directly by @Classic298.

Checklist

I have reviewed the relevant documentation and matched the existing style.
This PR meets Open WebUI's contribution standards: it is accurate, relevant to users, narrowly scoped, maintainable, and not promotional content, advertising, lead generation, SEO placement, or a request to list a product, service, provider, integration, gateway, tool, or company primarily for visibility.
I understand that PRs that do not meet these standards may be closed without review and will not be merged. Repeated, low-quality, off-topic, promotional, or intentionally misleading submissions may result in the contributor being blocked from future participation in Open WebUI repositories.

Notes for reviewers

How the screenshots were made. Captured against a throwaway Open WebUI instance driven by Playwright, at the same 1600x883 / 2x scale as the existing set. Every artifact shown was verified on the terminal's filesystem with docker exec rather than trusting the screenshot, because the model will produce a convincing frame describing files it never created. Three frames were discarded rather than shipped, for that reason or for poor framing. The access control frame is populated with placeholder users (alice@example.com and friends) so the groups show real membership counts rather than three zeroes.

One thing worth a second opinion. OPEN_TERMINAL_ALLOWED_DOMAINS is a real dnsmasq/iptables allowlist and the domains load correctly, but the container then exits at startup:

Egress: DNS whitelist — pypi.org,github.com
  ✓ pypi.org (+ subdomains)
dnsmasq started (upstream: 1.1.1.1)
Egress firewall active — dropping CAP_NET_ADMIN permanently
unable to raise CAP_SETPCAP for BSET changes: Operation not permitted

Reproduced with --cap-add NET_ADMIN and with NET_ADMIN + SETPCAP, on rootful Docker with cgroups v2. I documented the allowlist with its real startup output and added a note about the capability requirement and this failure mode, but I did not write curl output I could not actually produce. This may be a genuine bug rather than my host, so it is worth someone confirming. The dashes in that block are verbatim program output, left unaltered.

Eleven TODOs remain, all left in place. Four need infrastructure this pass did not have:

Page	Needs
database-analysis	a PostgreSQL instance
research-assistant	web search
multi-user	two users on a `MULTI_USER` terminal
data-reports	a generated PDF page

The rest are in configuration.md, multi-user.md and installation.mdx, which this PR leaves untouched. Their briefs ask for pictures of config files and commands those pages already print as text, so they may be better closed by a decision than by a screenshot.

npm run build passes clean.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/open-webui/docs/pull/1369 **Author:** [@silentoplayz](https://github.com/silentoplayz) **Created:** 9/1/2026 **Status:** ✅ Merged **Merged:** 9/2/2026 **Merged by:** [@Classic298](https://github.com/Classic298) **Base:** `main` ← **Head:** `docs/open-terminal-screenshots-v2` --- ### 📝 Commits (1) - [`78a7449`](https://github.com/open-webui/docs/commit/78a74498f2bd87afb15b651e41c596689b759fef) docs: refresh and fill in Open Terminal screenshots ### 📊 Changes **65 files changed** (+169 additions, -33 deletions) <details> <summary>View changed files</summary> 📝 `docs/features/open-terminal/advanced/security.md` (+91 -7) 📝 `docs/features/open-terminal/file-browser.md` (+14 -2) 📝 `docs/features/open-terminal/index.md` (+3 -3) 📝 `docs/features/open-terminal/setup/connecting.md` (+26 -4) 📝 `docs/features/open-terminal/setup/installation.mdx` (+18 -2) 📝 `docs/features/open-terminal/use-cases/advanced-workflows/app-builder.md` (+2 -2) 📝 `docs/features/open-terminal/use-cases/advanced-workflows/code-review.md` (+2 -2) 📝 `docs/features/open-terminal/use-cases/advanced-workflows/competitive-analysis.md` (+2 -2) 📝 `docs/features/open-terminal/use-cases/advanced-workflows/data-reports.md` (+3 -1) 📝 `docs/features/open-terminal/use-cases/advanced-workflows/document-comparison.md` (+2 -2) 📝 `docs/features/open-terminal/use-cases/advanced-workflows/email-processing.md` (+2 -2) 📝 `docs/features/open-terminal/use-cases/advanced-workflows/finance-dashboard.md` (+2 -2) 📝 `docs/features/open-terminal/use-cases/advanced-workflows/image-processing.md` (+1 -1) 📝 `docs/features/open-terminal/use-cases/system-automation.md` (+1 -1) ➕ `static/images/open-terminal-access-grants.png` (+0 -0) ➕ `static/images/open-terminal-ai-batch-convert.png` (+0 -0) 📝 `static/images/open-terminal-ai-code-execution.png` (+0 -0) 📝 `static/images/open-terminal-ai-csv-analysis.png` (+0 -0) 📝 `static/images/open-terminal-ai-debug-fix.png` (+0 -0) 📝 `static/images/open-terminal-ai-disk-usage.png` (+0 -0) _...and 45 more files_ </details> ### 📄 Description ## Summary Picks up @Classic298's ask: the Open Terminal screenshots were outdated, some pages had none, and `display_file` was underrepresented. This resolves **28 of the 39** screenshot TODO markers, refreshes the 24 existing images, and adds new ones. Every screenshot is a full-window 3200x1766 frame, matching the framing of the images it replaces. An earlier revision of this branch cropped the chat replies down to just the assistant message, which stripped out the sidebar, the terminal selector and the file browser panel. That was the wrong call for a product screenshot and all 19 affected frames were re-shot full-window. Not every brief wanted a picture. Five asked for screenshots of shell output, and those are code blocks now using real output: the Open Terminal startup banner, `docker stats` from a container actually started with the documented `--memory 2g --cpus 2` (`67.57MiB / 2GiB 3.30%`), and `docker compose up -d`. Four asked for diagrams and are now mermaid, matching the blocks already used elsewhere in the docs: container isolation, `internal: true` networking, Docker socket exposure, and the connection-URL diagram on connecting.md. Three corrections came out of the pass: - **connecting.md** promised a green "Connected" indicator. There isn't one; the saved connection shows an enable toggle. Prose and alt text now match the UI. - **file-browser.md** used one generic screenshot for three different claims. Two of those now have images showing what the text actually describes, including the page-jump behaviour and the sidebar viewer. - The **image variants** table checks out: `open-terminal:latest` measures 3.97 GB against the documented "~4 GB". ## Related issue or discussion No linked issue. This is a documentation pass on the Open Terminal section, raised with me directly by @Classic298. ## Checklist - [x] I have reviewed the relevant documentation and matched the existing style. - [x] This PR meets Open WebUI's contribution standards: it is accurate, relevant to users, narrowly scoped, maintainable, and not promotional content, advertising, lead generation, SEO placement, or a request to list a product, service, provider, integration, gateway, tool, or company primarily for visibility. - [x] I understand that PRs that do not meet these standards may be closed without review and will not be merged. Repeated, low-quality, off-topic, promotional, or intentionally misleading submissions may result in the contributor being blocked from future participation in Open WebUI repositories. ## Notes for reviewers **How the screenshots were made.** Captured against a throwaway Open WebUI instance driven by Playwright, at the same 1600x883 / 2x scale as the existing set. Every artifact shown was verified on the terminal's filesystem with `docker exec` rather than trusting the screenshot, because the model will produce a convincing frame describing files it never created. Three frames were discarded rather than shipped, for that reason or for poor framing. The access control frame is populated with placeholder users (`alice@example.com` and friends) so the groups show real membership counts rather than three zeroes. **One thing worth a second opinion.** `OPEN_TERMINAL_ALLOWED_DOMAINS` is a real dnsmasq/iptables allowlist and the domains load correctly, but the container then exits at startup: ``` Egress: DNS whitelist — pypi.org,github.com ✓ pypi.org (+ subdomains) dnsmasq started (upstream: 1.1.1.1) Egress firewall active — dropping CAP_NET_ADMIN permanently unable to raise CAP_SETPCAP for BSET changes: Operation not permitted ``` Reproduced with `--cap-add NET_ADMIN` and with `NET_ADMIN + SETPCAP`, on rootful Docker with cgroups v2. I documented the allowlist with its real startup output and added a note about the capability requirement and this failure mode, but I did not write `curl` output I could not actually produce. This may be a genuine bug rather than my host, so it is worth someone confirming. The dashes in that block are verbatim program output, left unaltered. **Eleven TODOs remain, all left in place.** Four need infrastructure this pass did not have: | Page | Needs | | :--- | :--- | | database-analysis | a PostgreSQL instance | | research-assistant | web search | | multi-user | two users on a `MULTI_USER` terminal | | data-reports | a generated PDF page | The rest are in `configuration.md`, `multi-user.md` and `installation.mdx`, which this PR leaves untouched. Their briefs ask for pictures of config files and commands those pages already print as text, so they may be better closed by a decision than by a screenshot. `npm run build` passes clean. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-18 14:18:57 +00:00