Skip to content

docs: add Iran transit connection/build guide and validation workflow#21

Merged
ehsanking merged 1 commit into
mainfrom
ehsan/add-ip-transit-test-and-readme-guidance
Apr 2, 2026
Merged

docs: add Iran transit connection/build guide and validation workflow#21
ehsanking merged 1 commit into
mainfrom
ehsan/add-ip-transit-test-and-readme-guidance

Conversation

@ehsanking
Copy link
Copy Markdown
Owner

Motivation

  • Provide a clear, bilingual build/install section so operators can install, test and optionally package the tool locally.
  • Explain how to connect an Iran-hosted server to the public internet via a transit provider and an encrypted tunnel so the project can be used for IP-transit based resilience testing.
  • Add end-to-end validation steps (including IP-transit checks) and a simple diagram so non-expert users can follow the workflow.

Description

  • Added a bilingual Build | ساخت section with dependency install and packaging commands (npm install, npm test, npm pack, npm install -g ...) in README.md.
  • Added a new bilingual section Connecting Iran Server to Internet Transit (Step-by-step) that documents server preparation, listener probes, transit-path analysis, recommended tunnel attachment (WireGuard → OpenVPN/SSH fallback), and final IP transit validation commands (traceroute, mtr, node cli.js analyze).
  • Included a simple ASCII network diagram showing User → Transit VPS/CDN Edge → Encrypted Tunnel → Iran Server to aid general audience comprehension.
  • Change is documentation-only (single-file README.md addition) and does not modify runtime code or tests.

Testing

  • Ran the automated test suite with npm test, and all tests passed (6 tests, 0 failures).

Codex Task

@ehsanking ehsanking merged commit d66505c into main Apr 2, 2026
2 checks passed
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: c2709f99b7

ℹ️ About Codex in GitHub

Your team has set up Codex to 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 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
Comment on lines +113 to +114
sudo ufw allow 443/tcp
sudo ufw allow 51820/udp
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 Open probe port before listener validation

The workflow opens 443/tcp and 51820/udp, but the very next step starts listener on port 9000 and asks users to probe that port. On systems where UFW has a default deny policy, those probe commands will fail even if the tool is working, which breaks the documented validation path. Add firewall rules for 9000 (TCP/UDP) or change the listener/probe examples to an already-open port.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant