Skip to content

Improve DEV-LOCAL.md with prerequisites, verification steps, and troubleshooting#2273

Merged
jakubno merged 2 commits intoe2b-dev:mainfrom
renezander030:improve-dev-local-docs
Apr 8, 2026
Merged

Improve DEV-LOCAL.md with prerequisites, verification steps, and troubleshooting#2273
jakubno merged 2 commits intoe2b-dev:mainfrom
renezander030:improve-dev-local-docs

Conversation

@renezander030
Copy link
Copy Markdown
Contributor

Summary

Improves the local development guide (DEV-LOCAL.md) to make it easier for new contributors and self-hosters to get a working local environment.

  • Prerequisites section: OS, CPU, RAM, Go version, Docker, gsutil, KVM check
  • Verification steps after each major step (expected output, how to confirm it worked)
  • Required vs optional services: documents that the observability stack (Grafana, Loki, Tempo, Mimir, etc.) is optional for basic operation
  • Hello world section: curl and Python SDK examples to verify end-to-end sandbox creation
  • Environment files: documents all .env.local files and their purpose
  • Troubleshooting section: KVM not found, port conflicts, sudo requirements, gsutil install, ClickHouse timing, huge pages

Closes #2211 (partial — covers the local dev documentation portion).

Copy link
Copy Markdown

@claude claude bot left a comment

Choose a reason for hiding this comment

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

Claude Code Review

This pull request is from a fork — automated review is disabled. A repository maintainer can comment @claude review to run a one-time review.

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 9c4d5a4d25

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

DEV-LOCAL.md Outdated
```bash
make -C packages/client-proxy run-local
```
Verify: `curl -s http://localhost:3002/health` returns a response.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Point client-proxy health check to the health listener

The verification step uses http://localhost:3002/health, but run-local starts client-proxy with default ports where ProxyPort is 3002 and HealthPort is 3003 (packages/client-proxy/internal/cfg/model.go), and main.go binds the health server to HealthPort. In a normal local setup this check can fail even when the service is healthy, which makes the guide report a false negative for a working client-proxy instance.

Useful? React with 👍 / 👎.

Co-authored-by: Jakub Novák <kubus.novak@gmail.com>
@jakubno jakubno enabled auto-merge (squash) April 7, 2026 09:45
@jakubno jakubno merged commit 7317924 into e2b-dev:main Apr 8, 2026
38 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation for self-hosted deployment on single-node setups

2 participants