Skip to content

Commit bf30205

Browse files
committed
Small adjustment of the setup and release.yml
1 parent d8f0d07 commit bf30205

2 files changed

Lines changed: 29 additions & 2 deletions

File tree

.github/workflows/release.yml

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,34 @@ jobs:
7474
generate_release_notes: true
7575
body: |
7676
## Release ${{ steps.version.outputs.version }}
77-
...
77+
78+
### Installation for the indexer
79+
Download the binary for your platform and make it executable:
80+
```bash
81+
chmod +x indexer-*
82+
```
83+
84+
You will need to set up the database for the indexer, check the docs for more information.
85+
86+
To generate a default config use:
87+
```bash
88+
indexer setup create-config
89+
```
90+
This will create a config.yml in the current directory.
91+
92+
When you have the database running run the cmd to create the database and the user.
93+
```bash
94+
indexer setup create-db --db-host localhost --db-port 5432 --db-user postgres --db-name postgres --ssl-mode disable --new-db-name gnoland --chain-name gnoland
95+
indexer setup create-user --db-host localhost --db-port 5432 --db-user postgres --db-name postgres --ssl-mode disable --user writer --privilege writer
96+
```
97+
98+
From here you can run the indexer using live or historic mode
99+
```bash
100+
./indexer run live --config config.yml
101+
./indexer run historic --config config.yml --from-height 1 --to-height 2000
102+
```
103+
104+
For more information check the docs.
78105
env:
79106
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
80107

indexer/cmd/setup.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ func init() {
5353
createDbCmd.Flags().String("chain-name", "", "The chain name for the database type enum, default is gnoland")
5454

5555
// create-config specific flags
56-
createConfigCmd.Flags().StringP("config", "c", "config.yaml", "The config file name, default is config.yaml")
56+
createConfigCmd.Flags().StringP("config", "c", "config.yml", "The config file name, default is config.yml")
5757
createConfigCmd.Flags().BoolP("overwrite", "o", false, "Overwrite the existing config file, default is false")
5858
}
5959

0 commit comments

Comments
 (0)