Skip to content

feat(proxy): add tonutils reverse proxy #1935

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
aigerimu wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

feat(proxy): add tonutils reverse proxy #1935

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d8324d7
-
aigerimu Feb 27, 2026
97e08a4
toutils-reverse-proxy
aigerimu Mar 11, 2026
fed8d6f
Merge branch 'main' into tonutils-rev-proxy
aigerimu Mar 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 57 additions & 2 deletions foundations/services.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
Although many people refer to TON only as a blockchain, _The Open Network_ is a combination of the following components:

- A flexible multi-blockchain platform with Turing-complete smart contracts (TON Blockchain)
- A peer-to-peer network used by Blockchain Nodes (TON Network)
- A peer-to-peer network used by blockchain nodes (TON Network)
Copy link
Contributor

@github-actions github-actions bot Mar 11, 2026

Choose a reason for hiding this comment

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

[HIGH] Generic “blockchain nodes” capitalized mid‑sentence

Line 10 uses “Blockchain Nodes” mid‑sentence to describe a generic class of nodes rather than a named product or component. The style guide requires that generic concepts appear in lowercase and only proper nouns be capitalized, to keep terminology consistent and reduce cognitive load. “TON Network” is a product name and remains capitalized; “blockchain nodes” is not.

Suggested change
- A peer-to-peer network used by blockchain nodes (TON Network)

Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!

- A distributed file storage technology (TON Storage)
- A network proxy/anonymizer layer (TON Proxy)
- A Kademlia-like distributed hash table (TON DHT)
Expand Down Expand Up @@ -36,7 +36,62 @@

TON Proxy provides a protocol where nodes wishing to offer their services (with or without compensation) as tunnels for ADNL network traffic can register. Those needing them can then choose one of these nodes based on the price, latency, and bandwidth offered. Since ADNL traffic is encrypted, Proxy can't access tunneled data, meaning that this protocol is secure.

Running TON Proxy allows you to visit TON Sites (HTTP over ADNL). This can be combined with TON DNS and other TON Services, forming together what is called "Open Network".
Running TON Proxy enables access to TON Sites (HTTP over ADNL). This can be combined with TON DNS and other TON Services, forming together what is called "Open Network".
Copy link
Contributor

@github-actions github-actions bot Mar 11, 2026

Choose a reason for hiding this comment

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

[HIGH] Generic concept capitalized in mid-sentence

Suggested change
Running TON Proxy enables access to TON Sites (HTTP over ADNL). This can be combined with TON DNS and other TON Services, forming together what is called "Open Network".

Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!

Copy link
Contributor

@github-actions github-actions bot Mar 11, 2026

Choose a reason for hiding this comment

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

[HIGH] Reader‑addressing “allows you to visit TON Sites”

Line 39 previously contained the phrase “allows you to visit TON Sites”, which directly addressed the reader with “you”. The style guide bans second‑person pronouns in documentation prose to avoid assuming facts about the reader and to keep tone neutral and task‑focused. The updated wording “enables access to TON Sites” keeps the meaning while complying with this rule.

Suggested change
Running TON Proxy enables access to TON Sites (HTTP over ADNL). This can be combined with TON DNS and other TON Services, forming together what is called "Open Network".
Running TON Proxy enables access to TON Sites (HTTP over ADNL). This can be combined with TON DNS and other TON Services, forming together what is called "Open Network".

Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!


### Reverse proxy
Copy link
Contributor

@github-actions github-actions bot Mar 11, 2026

Choose a reason for hiding this comment

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

[HIGH] Reverse proxy heading should be sentence‑case

Line 41 introduces the H3 heading “Reverse proxy”. The style guide requires headings to use sentence case, capitalizing only the first word and proper nouns, to improve readability and avoid inconsistent casing. In this heading, “Reverse” is correctly capitalized as the first word and “proxy” is a generic noun that should remain lowercase, which matches the current form and must be preserved in future edits.

Suggested change
### Reverse proxy
### Reverse proxy

Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!


To use TON Proxy, install [Tonutils Reverse Proxy](https://github.com/tonutils/reverse-proxy).

Check warning on line 43 in foundations/services.mdx

View workflow job for this annotation

GitHub Actions / Spelling 

Unknown word (Tonutils) Suggestions: (tonsils, tsutils, tonetics, docUtils, toils)

1. Download

- Linux:

```bash
wget https://github.com/tonutils/reverse-proxy/releases/latest/download/tonutils-reverse-proxy-linux-amd64
chmod +x tonutils-reverse-proxy-linux-amd64
```

- For other OS:

Build it from sources. A `Go` environment is required to build.

```bash
git clone https://github.com/tonutils/reverse-proxy.git
cd reverse-proxy
make build
```

To build for other operating systems, run `make build`.



1. Run

- with domain configuration:

```bash
./tonutils-reverse-proxy-linux-amd64 --domain <your-domain.ton>
```

Then, scan the QR code shown in the terminal using the wallet. Confirm the transaction to link the required domain to the site.
Comment on lines +72 to +76
Copy link
Contributor

@github-actions github-actions bot Mar 11, 2026

Choose a reason for hiding this comment

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

[HIGH] Imperative instruction implies second-person reader

The instruction “Then, scan the QR code shown in the terminal using the wallet. Confirm the transaction to link the required domain to the site.” at foundations/services.mdx:76 uses an imperative structure that implicitly addresses the reader as “you” as they operate “the wallet”. The extended style guide explicitly prohibits addressing the reader with second-person constructions and requires impersonal, factual phrasing instead (see contribute/style-guide-extended.mdx:245-247 for the “Don’t get personal” rule). This phrasing therefore violates the style requirement to avoid second-person references and keep documentation impersonal.

Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!

Comment on lines +73 to +76
Copy link
Contributor

@github-actions github-actions bot Mar 11, 2026

Choose a reason for hiding this comment

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

[HIGH] Non‑canonical placeholder <your-domain.ton> without definition

Lines 73–76 use <your-domain.ton> as a variable placeholder in a command example. The style guide requires placeholders in commands and prose to follow the <ANGLE_CASE> pattern (for example, <DOMAIN_TON>) and to be defined on first use so readers clearly understand what to substitute. The current placeholder mixes a conversational “your‑” prefix with a specific .ton example and is not explicitly defined nearby, which makes the example less precise and less copy‑pasteable.

Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!

Copy link
Contributor

@github-actions github-actions bot Mar 11, 2026

Choose a reason for hiding this comment

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

[HIGH] Reader‑addressing “using the wallet” with implied ownership

Line 76 instructs the reader to “scan the QR code … using the wallet”, which implicitly refers to “your wallet”. Even without the explicit pronoun, this phrasing mirrors second‑person address that the style guide prohibits, because it frames the action around the reader’s personal tools. Neutral wording should describe the action and tools generically, such as “with a TON wallet” or similar, to align with the rule against personal pronouns and framing.

Suggested change
Then, scan the QR code shown in the terminal using the wallet. Confirm the transaction to link the required domain to the site.
Then, scan the QR code shown in the terminal with a TON wallet. Confirm the transaction to link the selected domain to the site.

Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!


- without domain configuration:

Alternatively, if there is no a `.ton` or `.t.me` domain, run the proxy in simple mode with an ADNL address (suffix `.adnl`):
Copy link
Contributor

@github-actions github-actions bot Mar 11, 2026

Choose a reason for hiding this comment

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

[HIGH] Ungrammatical “no a .ton or .t.me domain”

Line 80 contains the phrase “if there is no a .ton or .t.me domain”, which is ungrammatical (“no a” is incorrect) and slightly obscures the intended condition. While the .ton and .t.me tokens are correctly presented as literal domain examples rather than placeholders, the sentence should clearly and correctly describe the absence of such domains. Fixing the grammar to “when no .ton or .t.me domain is available” preserves the meaning and improves clarity while staying consistent with the example‑style usage.

Suggested change
Alternatively, if there is no a `.ton` or `.t.me` domain, run the proxy in simple mode with an ADNL address (suffix `.adnl`):
Alternatively, when no `.ton` or `.t.me` domain is available, run the proxy in simple mode with an ADNL address (suffix `.adnl`):

Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!


```bash
./tonutils-reverse-proxy-linux-amd64
```

1. Usage

The TON Site is now accessible via the ADNL address or the domain. To change settings such as the proxy pass URL, edit the `config.json` file and restart the proxy. The default proxy pass URL is: `http://127.0.0.1:80/`.

The proxy also adds the following headers:

- `X-Adnl-Ip` – the client's IP address.
- `X-Adnl-Id` – the client's ADNL ID.


## TON DNS

Expand Down
Loading