Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dungeon-master-666 committed Jul 4, 2022
1 parent ed934e9 commit 1217924
Showing 1 changed file with 18 additions and 19 deletions.
37 changes: 18 additions & 19 deletions ton-http-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,20 @@ You can use the ready-made [toncenter.com](https://toncenter.com) service or sta
## Building and running

Recommended hardware:
- CPU architecture: x86_64 or arm64.
- HTTP API only: 1 vCPU, 2 GB RAM.
- HTTP API with cache enabled: 2 vCPUs, 4 GB RAM.

There are two ways to run TON HTTP API:
- __Docker Compose__: works on any x86_64 and arm64 OS with Docker available.
There are two main ways to run TON HTTP API:
- __Local__ *(experimental)*: works on following platforms: Ubuntu Linux (x86_64, arm64), MacOSX (Intel x86_64, Apple M1 arm64) and Windows (x86_64).
- __Docker Compose__: flexible configuration, recommended for production environments, works on any x86_64 and arm64 OS with Docker available.

### Local run *(experimental)*
**Note:** It is simple but not stable way to run the service. We do not recommend to use it in production.
- (Windows only, first time) Install OpenSSL v1.1.1 for win64 from [here](https://slproweb.com/products/Win32OpenSSL.html).
- Install package: `pip install ton-http-api`.
- Run service with `ton-http-api`. This command will run service with [mainnet](https://ton.org/global-config.json) configuration.
- Run `ton-http-api --help` to show parameters list.

### Docker Compose
- (First time) Install required tools: `docker`, `docker-compose`, `curl`.
Expand All @@ -31,31 +39,19 @@ There are two ways to run TON HTTP API:
```
- Run `./configure.py` to create `.env` file with necessary environment variables (see [Configuration](#Configuration) for details).
- Build services: `docker-compose build`.
- Or pull latest images: `docker-compose pull`.
- Run services: `docker-compose up -d`.
- Stop services: `docker-compose down`.

### Local run *(experimental)*
- (Windows only, first time) Install OpenSSL v1.1.1 for win64 from [here](https://slproweb.com/products/Win32OpenSSL.html).
- Install package: `pip install ton-http-api`.
- Run service with `ton-http-api`. This command will run service with [mainnet](https://ton.org/global-config.json) configuration.
- Run `ton-http-api --help` to show parameters list.
- To change settings you can use environment variables (see [Configuration](#Configuration) section).


## Configuration
### Configuration

Configuration process is different in case of local and Docker run:

- In case of local run you can pass parameters using environment variables:
- Windows: run command `set variable=value` in CMD or `$env:variable = 'value'` in PowerShell.
- Linux and MacOS: run command `export variable=value` or path variable inplace: `variable=value uvicorn pyTON.main:app`.
- In case of Docker you should specify environment parameters and run `./configure.py` to create `.env` file.
You should specify environment parameters and run `./configure.py` to create `.env` file.
```bash
export TON_API_LITESERVER_CONFIG=private/testnet.json
./configure.py
```

The service supports the following environment variables for configuration:
The service supports the following environment variables:
#### Webserver settings
- `TON_API_HTTP_PORT` *(default: 80)*

Expand Down Expand Up @@ -85,6 +81,10 @@ The service supports the following environment variables for configuration:

Defines log verbosity level. Values allowed: `DEBUG`,`INFO`,`WARNING`,`ERROR`,`CRITICAL`.

- `TON_API_GUNICORN_FLAGS` *(default: empty)*

Additional Gunicorn [command line arguments](https://docs.gunicorn.org/en/stable/settings.html).

#### Tonlib settings
- `TON_API_TONLIB_LITESERVER_CONFIG` *(default docker: private/mainnet.json local: https://ton.org/global-config.json)*

Expand All @@ -106,7 +106,6 @@ The service supports the following environment variables for configuration:

Timeout for liteserver requests.


#### Cache configuration
- `TON_API_CACHE_ENABLED` *(default: 0)*

Expand Down

0 comments on commit 1217924

Please sign in to comment.