Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
websharik committed Aug 4, 2024
1 parent fe7fd36 commit 298a4f4
Showing 1 changed file with 24 additions and 8 deletions.
32 changes: 24 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ chmod +x tonutils-reverse-proxy-linux-amd64
```

Or download a binary for your OS:
* [Linux AMD64](https://github.com/ton-utils/reverse-proxy/releases/latest/download/tonutils-reverse-proxy-linux-amd64)
* [Linux ARM64](https://github.com/ton-utils/reverse-proxy/releases/latest/download/tonutils-reverse-proxy-linux-arm64)
* [Windows x64](https://github.com/ton-utils/reverse-proxy/releases/latest/download/tonutils-reverse-proxy-windows-x64.exe)
* [Mac Intel](https://github.com/ton-utils/reverse-proxy/releases/latest/download/tonutils-reverse-proxy-mac-amd64)
* [Mac Apple Silicon](https://github.com/ton-utils/reverse-proxy/releases/latest/download/tonutils-reverse-proxy-mac-arm64)
* [Linux AMD64](https://github.com/ton-utils/reverse-proxy/releases/latest/download/tonutils-reverse-proxy-linux-amd64)
* [Linux ARM64](https://github.com/ton-utils/reverse-proxy/releases/latest/download/tonutils-reverse-proxy-linux-arm64)
* [Windows x64](https://github.com/ton-utils/reverse-proxy/releases/latest/download/tonutils-reverse-proxy-windows-x64.exe)
* [Mac Intel](https://github.com/ton-utils/reverse-proxy/releases/latest/download/tonutils-reverse-proxy-mac-amd64)
* [Mac Apple Silicon](https://github.com/ton-utils/reverse-proxy/releases/latest/download/tonutils-reverse-proxy-mac-arm64)

### Run

Expand All @@ -31,7 +31,7 @@ Run with domain configuration, and follow the steps:

<img width="500" alt="yes1" src="https://user-images.githubusercontent.com/9332353/210967656-182b0d0f-6954-49c9-bf8a-40f5b4a61aa7.png">

Scan QR code from your terminal using Tonkeeper, Tonhub or any other wallet, execute transaction. Your domain will be linked to your site.
Scan QR code from your terminal using Tonkeeper, Tonhub or any other wallet, execute transaction. Your domain will be linked to your site.

If for some reason you cannot scan QR code, add `-tx-url` flag, so it will be displayed as `ton://` url for transaction.

Expand All @@ -45,18 +45,34 @@ Alternatively, you can run in simple mode, with .adnl domain, if you don't have

##### Use

Now anyone can access your TON Site! Using ADNL address or domain.
Now anyone can access your TON Site! Using ADNL address or domain.

If you want to change some settings, like proxy pass url - open `config.json` file, edit and restart proxy. Default proxy pass url is `http://127.0.0.1:80/`

Proxy adds additional headers:
`X-Adnl-Ip` - ip of client, and `X-Adnl-Id` - adnl id of client

<<<<<<< HEAD
If you want to change some settings, like proxy pass url - open `config.json` file, edit and restart proxy.
Or use ENV variables:
- `GLOBAL_CONFIG_URL` (default: https://ton.org/global.config.json)
- `EXTERNAL_IP` (default: detect via http://ip-api.com/json/)
- `LISTEN_IP` (default: 0.0.0.0)
- `LISTEN_PORT` (default: 9000 + rand)
- `PROXY_PASS` (default: http://127.0.0.1:80)
- `PRIVATE_KEY` (default: generate and write to `config.json`, is env not passed. It can be used on first start to generate Private Key )

ENV's, has priority over `config.json` and can be useful to run reverse-proxy in Docker container.

*Using `PRIVATE_KEY` is more safety then store key in file and recommended for production.

=======
>>>>>>> parent of f741f37 (Update README.md)
### FAQ

#### Can I have multiple domains on single reverse-proxy?

Yes! You can run any number of sites within single reverse-proxy, just link all your domains to same ADNL address.
Yes! You can run any number of sites within single reverse-proxy, just link all your domains to same ADNL address.
You can run reverse-proxy with `-domain` flag one by one for all your domains and execute transaction. `-domain` flag is needed only for linking step, for further launches you are not required to specify it, your domains will remain linked.

#### I'm getting error code 651: too big masterchain block seqno
Expand Down

0 comments on commit 298a4f4

Please sign in to comment.