Skip to content

docs(egress): add supervisor docs, fix API/config documentation gaps#984

Merged
hittyt merged 1 commit into
opensandbox-group:mainfrom
Pangjiping:docs/egress-supervisor-and-api
Jun 5, 2026
Merged

docs(egress): add supervisor docs, fix API/config documentation gaps#984
hittyt merged 1 commit into
opensandbox-group:mainfrom
Pangjiping:docs/egress-supervisor-and-api

Conversation

@Pangjiping

Copy link
Copy Markdown
Collaborator

Summary

  • Add opensandbox-supervisor README (components/internal/supervisor/) covering all flags, backoff, crashloop breaker, hooks, event log schema
  • Add mitmproxy process supervisor (crash recovery) section with generation tagging, health gate, and observability docs
  • Fix egress README: Go 1.24 → 1.25, add PUT/DELETE/healthz endpoints, add always-rules files, add DNS upstream env vars, add SSL_INSECURE
  • Egress README supervisor section now links to internal supervisor docs

Testing

  • Not run (just docs)
  • Unit tests
  • Integration tests
  • e2e / manual verification

Breaking Changes

  • None
  • Yes (describe impact and migration path)

Checklist

  • Linked Issue or clearly described motivation
  • Added/updated docs (if needed)
  • Added/updated tests (if needed)
  • Security impact considered
  • Backward compatibility considered

- Add opensandbox-supervisor README (components/internal/supervisor/)
  covering all flags, backoff, crashloop breaker, hooks, event log schema
- Add mitmproxy process supervisor (crash recovery) section with
  generation tagging, health gate, and observability docs
- Fix egress README: Go 1.24 → 1.25, add PUT/DELETE/healthz endpoints,
  add always-rules files, add DNS upstream env vars, add SSL_INSECURE
- Egress README supervisor section now links to internal supervisor docs

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@Pangjiping Pangjiping added documentation Improvements or additions to documentation component/egress labels Jun 5, 2026

@hittyt hittyt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@hittyt hittyt merged commit d980b3b into opensandbox-group:main Jun 5, 2026
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component/egress documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants