Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Groxan authored Dec 11, 2022
1 parent e41d587 commit a44e65a
Showing 1 changed file with 21 additions and 22 deletions.
43 changes: 21 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ make stop

## Installation (from source)

This is the preferred way, because you have more control over each TzKT component (database, indexer, API). This guide is for Ubuntu 20.04, but if you are using a different OS, the installation process will probably differ only in the "Install packages" step.
This is the preferred way, because you have more control over each TzKT component (database, indexer, API). This guide is for Ubuntu 22.04, but if you are using a different OS, the installation process will probably differ only in the "Install packages" step.

### Install packages

Expand All @@ -50,25 +50,22 @@ sudo apt update
sudo apt install git
````

#### Install .NET 5.0 SDK
#### Install .NET

````
wget -q https://packages.microsoft.com/config/ubuntu/20.04/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
wget https://packages.microsoft.com/config/ubuntu/22.04/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
sudo dpkg -i packages-microsoft-prod.deb
rm packages-microsoft-prod.deb
sudo apt update
sudo apt install -y apt-transport-https
sudo apt update
sudo apt install -y dotnet-sdk-5.0
sudo apt install -y dotnet-sdk-7.0
````

#### Install Postgresql 13
#### Install Postgresql

````
wget -q -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add -
echo "deb http://apt.postgresql.org/pub/repos/apt/ `lsb_release -cs`-pgdg main" | sudo tee /etc/apt/sources.list.d/pgdg.list
sudo apt update
sudo apt -y install postgresql-13 postgresql-client-13
sudo apt -y install postgresql postgresql-contrib
````

## Install Tzkt Indexer and API for mainnet
Expand Down Expand Up @@ -131,30 +128,30 @@ Like this:
"Diagnostics": false,
"Validation": true
},

"TezosNode": {
"Endpoint": "https://rpc.tzkt.io/mainnet/",
"Timeout": 60
},

"Quotes": {
"Async": true,
"Provider": {
"Name": "TzktQuotes"
}
},

"ConnectionStrings": {
"DefaultConnection": "host=localhost;port=5432;database=tzkt_db;username=tzkt;password=qwerty;command timeout=600;"
},

"HealthChecks": {
"Enabled": true,
"Delay": 10,
"Period": 10,
"FilePath": "sync.health"
},

"Domains": {
"Enabled": false,
"NameRegistry": "KT1GBZmSxmnKJXGMdMLbugPfLyUPmuLSMwKS",
"PeriodSec": 30
},
"TokenMetadata": {
"Enabled": false,
"BatchSize": 100,
Expand All @@ -177,7 +174,6 @@ Like this:
}
]
},

"Logging": {
"LogLevel": {
"Default": "Information",
Expand Down Expand Up @@ -221,7 +217,7 @@ dotnet Tzkt.Sync.dll
// ....
````

That's it. If you want to run the indexer as a daemon, take a look at this guide: https://docs.microsoft.com/aspnet/core/host-and-deploy/linux-nginx?view=aspnetcore-3.1#create-the-service-file.
That's it. If you want to run the indexer as a daemon, take a look at this guide: https://learn.microsoft.com/en-us/aspnet/core/host-and-deploy/linux-nginx?view=aspnetcore-7.0#create-the-service-file.

### Build, configure and run Tzkt API for the mainnet indexer

Expand All @@ -245,17 +241,20 @@ Like this:
"Cache": {
"LoadRate": 0.75,
"MaxAccounts": 32000
},
"ResponseCache": {
"CacheSize": 256
},

"Websocket": {
"Enabled": true,
"MaxConnections": 1000,
"MaxOperationSubscriptions": 50,
"MaxBigMapSubscriptions": 50,
"MaxEventSubscriptions": 50,
"MaxAccountsSubscriptions": 50,
"MaxTokenBalancesSubscriptions": 50,
"MaxTokenTransfersSubscriptions": 50
},

"ConnectionStrings": {
"DefaultConnection": "host=localhost;port=5432;database=tzkt_db;username=tzkt;password=qwerty;command timeout=600;"
},
Expand Down Expand Up @@ -323,12 +322,12 @@ In general the steps are the same as for the mainnet, you just need to use diffe
- Ghostnet:
- Snapshot: https://snapshots.tzkt.io/tzkt_v1.10_ghostnet.backup
- RPC node: https://rpc.tzkt.io/ghostnet/
- Jakartanet:
- Snapshot: https://snapshots.tzkt.io/tzkt_v1.10_jakartanet.backup
- RPC node: https://rpc.tzkt.io/jakartanet/
- Kathmandunet:
- Snapshot: https://snapshots.tzkt.io/tzkt_v1.10_kathmandunet.backup
- RPC node: https://rpc.tzkt.io/kathmandunet/
- Limanet:
- Snapshot: https://snapshots.tzkt.io/tzkt_v1.10_limanet.backup
- RPC node: https://rpc.tzkt.io/limanet/

### Testnet installation using docker containers

Expand Down

0 comments on commit a44e65a

Please sign in to comment.