Skip to content

Commit

Permalink
Refactor swagger V3 docs (#65)
Browse files Browse the repository at this point in the history
* Update README
* Refactor blocks section
* Refactor docs (swagger)
* update index worker submodule
* update ton-index-cpp submodule
* Move changes from pr 60 and fix errors
* Update header level in readme
* Fix url
* Update README
* Refactor blocks section
* Refactor docs (swagger)
* Move changes from pr 60 and fix errors
* Update header level in readme
* Fix url
---------

Co-authored-by: PixelPlex <dev@pixelplex.io>
Co-authored-by: ms <dungeon666master@protonmail.com>
  • Loading branch information
3 people authored Aug 2, 2024
1 parent 691c89a commit b5fe659
Show file tree
Hide file tree
Showing 5 changed files with 88 additions and 64 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Requirements:
Do the following steps to setup TON Indexer:
* Clone repository: `git clone --recursive --branch master https://github.com/toncenter/ton-indexer.git && cd ./ton-indexer`.
* Create *.env* file with command `./configure.sh`.
* Run `./configure.sh --worker` to configure TON Index worker.
* ./configure.sh will create .env file only with indexer and PostgreSQL configuration data. Use --worker flag to add TON Index worker configuration data too.
* Adjust parameters in *.env* file (see [list of available parameters](#available-parameters)).
* Set PostgreSQL password `echo -n "MY_PASSWORD" > private/postgres_password`
* Build docker images: `docker compose build postgres alembic index-api`.
Expand Down Expand Up @@ -57,6 +57,10 @@ Do the following steps to setup TON Indexer:
* `TON_WORKER_INSERT_BATCH_SIZE`: max masterchain seqnos per INSERT query. Small value will decrease indexing performance. Great value will increase RAM usage. Default: `512`.
* `TON_WORKER_INSERT_PARALLEL_ACTORS`: number of parallel INSERT transactions. Increasing this number will increase PostgreSQL server RAM usage. Default: `3`.

## Swagger

To test API, built-in swagger can be used. It is available after running `docker compose` at `localhost:8081`

# FAQ

## How to point TON Index worker to existing PostgreSQL instance
Expand Down
2 changes: 1 addition & 1 deletion configure.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ mkdir -p private

# help
function usage() {
echo 'Supported argumets:'
echo 'Supported arguments:'
echo ' -h --help Show this message'
echo ' --worker Do configure TON Index worker'
exit
Expand Down
Loading

0 comments on commit b5fe659

Please sign in to comment.