Redume/Kekkai
1
0
Fork 0
mirror of https://github.com/Redume/Kekkai.git synced 2025-02-23 12:43:12 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore(docs): Updated the config information in the documentation
Some checks failed
Create and publish a Docker image / build-and-push-server (push) Has been cancelled
Details
Create and publish a Docker image / build-and-push-chart (push) Has been cancelled
Details
Create and publish a Docker image / build-and-push-CR (push) Has been cancelled
Details
Deploy docs / deploy (push) Has been cancelled
Details

Browse source
This commit is contained in:
Данил 2025-01-17 16:11:58 +03:00
parent c944e552ec
commit 424ecff857
1 changed files with 17 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/config/config-yaml.md
View file

@ -96,28 +96,37 @@ Most of the data is built on User Agent. It is possible to disable analytics in
- `work`: Enable or disable analytics. - `work`: Enable or disable analytics.
## Currency ## Currency
`DuckDuckGo` (fiat currency collection) is used to collect currency rates. `DuckDuckGo` (fiat currency collection) and `CoinMarketCap` (cryptocurrency collection)
are used to collect currency rates.
??? note ??? note
```yaml ```yaml
... ...
currency: currency:
chart: chart:
save: false save: false # Enable or disable saving graphs to an image (Boolean)
collecting: collecting:
fiat: true fiat: true # Turn off or turn on the collection of the fiat currency rate [Boolean]
schedule: '30 8 * * *' crypto: false
fiat: schedule: '30 8 * * *' # Currency collection schedule in crontab format [String]
crypto_apikey: 'APIKEY'
fiat: # List of fiat currency to save the exchange rate [Array]
- USD - USD
- RUB - RUB
- EUR - EUR
- UAH - UAH
- TRY - TRY
- KZT - KZT
crypto:
- ETH
- TON
- USDT
``` ```
- `currency.chart.save`: Enable or disable saving graphs. - `currency.chart.save`: Enable or disable saving graphs.
- `currency.collecting`: Enable or disable cryptocurrency or fiat currency exchange rate collection. - `currency.collecting`: Enable or disable cryptocurrency or fiat currency exchange rate collection.
- `currency.schedule`: Currency collection interval (Configurable via cron. - `currency.schedule`: Currency collection interval (Configurable via cron.
It is recommended to use [crontab.guru](https://crontab.guru), not supported in `Non-standard format`, like `@daily`). It is recommended to use [crontab.guru](https://crontab.guru), not supported in `Non-standard format`, like `@daily`).
- `crypto.crypto_apiKey`: API-key from CoinMarketCap service
- `currency.fiat`: A list of fiat currencies that will be saved to the database. - `currency.fiat`: A list of fiat currencies that will be saved to the database.
- `currency.crypto`: A list of crypto currencies that will be saved to the database.