vxcontrol/pentagi
1
0
Fork 0
mirror of https://github.com/vxcontrol/pentagi.git synced 2026-07-20 23:57:11 -04:00
Code Issues 45 Packages Projects Releases 9 Wiki Activity

[PR #262] [MERGED] docs: add Docker mirror guidance for restricted networks #277

New Issue
Closed
opened 2026-06-06 22:10:00 -04:00 by yindo · 0 comments
yindo commented 2026-06-06 22:10:00 -04:00
Owner
Copy Link
Copy Source

📋 Pull Request Information

Original PR: https://github.com/vxcontrol/pentagi/pull/262
Author: @mason5052
Created: 4/15/2026
Status: ✅ Merged
Merged: 4/22/2026
Merged by: @asdek

Base: feature/next-release ← Head: codex/issue-258-docker-mirror-docs

📝 Commits (1)

  • f984c78 docs: add Docker mirror guidance for restricted networks

📊 Changes

2 files changed (+45 additions, -1 deletions)

View changed files

📝 README.md (+30 -1)
📝 backend/docs/installer/checker.md (+15 -0)

📄 Description

Summary

  • document how restricted-network deployments should handle Docker Hub access
  • clarify what PENTAGI_IMAGE, DOCKER_DEFAULT_IMAGE, and DOCKER_DEFAULT_IMAGE_FOR_PENTEST actually control
  • add installer checker troubleshooting guidance for Docker registry mirrors and daemon proxy configuration

Problem

Issue #258 reports that users in restricted networks cannot reliably pull images from Docker Hub and asks whether PentAGI can be configured to use other image sources.

Right now the README documents worker image overrides, but it does not explain that these settings do not replace Docker's own registry connectivity. The installer checker docs also mention Docker Hub reachability without describing how to handle mirrored or proxied environments.

Solution

Add docs-only guidance in the two places users are most likely to look:

  • README now documents PENTAGI_IMAGE alongside the worker image settings and clarifies that these variables do not rewrite other Compose service images
  • README adds a restricted-network section that explains when to configure a Docker registry mirror or daemon/Desktop proxy, with an example registry-mirrors snippet and links to official Docker docs
  • backend/docs/installer/checker.md now explains that the checker validates Docker Hub reachability and gives a concrete remediation order for proxy/mirror setups

This keeps the scope small and useful for Issue #258 without implying that PentAGI already supports full per-service registry remapping.

User Impact

Users deploying PentAGI behind regional restrictions, corporate egress controls, or Docker Hub access issues now have explicit guidance on what to configure before running the installer or docker compose up. The docs also make it clearer which image-related environment variables only affect PentAGI itself or worker selection.

Closes #258.

Test Plan

  • Verified PENTAGI_IMAGE, DOCKER_DEFAULT_IMAGE, and DOCKER_DEFAULT_IMAGE_FOR_PENTEST against .env.example and the current compose files
  • Verified the installer checker documentation matches the current Docker Hub DNS / HTTPS / pull checks in backend/cmd/installer/checker/helpers.go
  • Verified the new guidance does not claim that PentAGI env vars rewrite all Compose service image sources
  • git diff --check

🔄 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/vxcontrol/pentagi/pull/262 **Author:** [@mason5052](https://github.com/mason5052) **Created:** 4/15/2026 **Status:** ✅ Merged **Merged:** 4/22/2026 **Merged by:** [@asdek](https://github.com/asdek) **Base:** `feature/next-release` ← **Head:** `codex/issue-258-docker-mirror-docs` --- ### 📝 Commits (1) - [`f984c78`](https://github.com/vxcontrol/pentagi/commit/f984c7865e0846fd4797d49c84158a1dad656036) docs: add Docker mirror guidance for restricted networks ### 📊 Changes **2 files changed** (+45 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+30 -1) 📝 `backend/docs/installer/checker.md` (+15 -0) </details> ### 📄 Description ## Summary - document how restricted-network deployments should handle Docker Hub access - clarify what `PENTAGI_IMAGE`, `DOCKER_DEFAULT_IMAGE`, and `DOCKER_DEFAULT_IMAGE_FOR_PENTEST` actually control - add installer checker troubleshooting guidance for Docker registry mirrors and daemon proxy configuration ## Problem Issue #258 reports that users in restricted networks cannot reliably pull images from Docker Hub and asks whether PentAGI can be configured to use other image sources. Right now the README documents worker image overrides, but it does not explain that these settings do not replace Docker's own registry connectivity. The installer checker docs also mention Docker Hub reachability without describing how to handle mirrored or proxied environments. ## Solution Add docs-only guidance in the two places users are most likely to look: - README now documents `PENTAGI_IMAGE` alongside the worker image settings and clarifies that these variables do not rewrite other Compose service images - README adds a restricted-network section that explains when to configure a Docker registry mirror or daemon/Desktop proxy, with an example `registry-mirrors` snippet and links to official Docker docs - `backend/docs/installer/checker.md` now explains that the checker validates Docker Hub reachability and gives a concrete remediation order for proxy/mirror setups This keeps the scope small and useful for Issue #258 without implying that PentAGI already supports full per-service registry remapping. ## User Impact Users deploying PentAGI behind regional restrictions, corporate egress controls, or Docker Hub access issues now have explicit guidance on what to configure before running the installer or `docker compose up`. The docs also make it clearer which image-related environment variables only affect PentAGI itself or worker selection. Closes #258. ## Test Plan - [x] Verified `PENTAGI_IMAGE`, `DOCKER_DEFAULT_IMAGE`, and `DOCKER_DEFAULT_IMAGE_FOR_PENTEST` against `.env.example` and the current compose files - [x] Verified the installer checker documentation matches the current Docker Hub DNS / HTTPS / pull checks in `backend/cmd/installer/checker/helpers.go` - [x] Verified the new guidance does not claim that PentAGI env vars rewrite all Compose service image sources - [x] `git diff --check` --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-06-06 22:10:00 -04:00
yindo closed this issue 2026-06-06 22:10:01 -04:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
enhancement
help wanted
pull-request
Mirrored from GitHub Pull Request
 question
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: vxcontrol/pentagi#277
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?