Skip to content

Commit

Permalink
🐛 Fix Documentation and Default Config File
Browse files Browse the repository at this point in the history
  • Loading branch information
0x46616c6b committed Oct 28, 2023
1 parent 41af081 commit e26a49b
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 7 deletions.
5 changes: 2 additions & 3 deletions config.yml.dist
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@ log_level: "error"
# log_format sets log format for logrus (default: json)
log_format: "json"
# configuration for the database
database:
type: "sqlite" # postgres, mysql, sqlite
dsn: "ticker.db" # postgres: "host=localhost port=5432 user=ticker dbname=ticker password=ticker sslmode=disable"
database_type: "sqlite" # postgres, mysql, sqlite
database_dsn: "ticker.db" # postgres: "host=localhost port=5432 user=ticker dbname=ticker password=ticker sslmode=disable"
# secret used for JSON Web Tokens
secret: "slorp-panfil-becall-dorp-hashab-incus-biter-lyra-pelage-sarraf-drunk"
# telegram configuration
Expand Down
7 changes: 3 additions & 4 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,8 @@ log_level: "error"
# log_format sets log format for logrus (default: json)
log_format: "json"
# configuration for the database
database:
type: "sqlite" # postgres, mysql, sqlite
dsn: "ticker.db" # postgres: "host=localhost port=5432 user=ticker dbname=ticker password=ticker sslmode=disable"
database_type: "sqlite" # postgres, mysql, sqlite
database_dsn: "ticker.db" # postgres: "host=localhost port=5432 user=ticker dbname=ticker password=ticker sslmode=disable"
# secret used for JSON Web Tokens
secret: "slorp-panfil-becall-dorp-hashab-incus-biter-lyra-pelage-sarraf-drunk"
# telegram configuration
Expand All @@ -26,7 +25,7 @@ upload_url: "http://localhost:8080"
!!! note
We use [viper](https://github.com/spf13/viper). That means you can use any of the supported file formats. Env variables
will overwrite existing config file values. Note that every env variable MUST be prefixed by: `TICKER_`.
E.g. `TICKER_DATABASE`.
E.g. `TICKER_LISTEN`.

The following env vars can be used:

Expand Down

0 comments on commit e26a49b

Please sign in to comment.