diff --git a/docs/config/conf-nginx.md b/docs/config/conf-nginx.md index fb6c91e..4ce05c8 100644 --- a/docs/config/conf-nginx.md +++ b/docs/config/conf-nginx.md @@ -2,7 +2,8 @@ Kekkai is used by `Nginx` to redirect to the correct microservice. ## Change domain -Change localhost to your `domain` or `ipv4` based on your needs. If you need to use Kekkai locally, you don't need to change anything, +Change localhost to your `domain` or `ipv4` based on your needs. +If you need to use Kekkai locally, you don't need to change anything, ??? note ``` diff --git a/docs/config/config-yaml.md b/docs/config/config-yaml.md index 6af0418..a1d24bd 100644 --- a/docs/config/config-yaml.md +++ b/docs/config/config-yaml.md @@ -68,10 +68,13 @@ mkdir CertSSL Copy your certificates to the CertSSL folder. -It is recommended to rename the certificates to `privkey.pem` and `fullchain.pem`. If this is not possible, you need to change the SSL name in `nginx.conf` (if using Docker Compose) +It is recommended to rename the certificates to `privkey.pem` and `fullchain.pem`. +If this is not possible, you need to change the SSL name in `nginx.conf` (if using Docker Compose) ## Analytics -Kekkai uses [`Plausbile`](https://plausible.io/) as an analyst. Minimal data is transferred for anilithics. Such as: browser, OS, status code, url, where the user came from. Most of the data is built on User Agent. It is possible to disable analytics in Kekkai. +Kekkai uses [`Plausbile`](https://plausible.io/) as an analyst. Minimal data is transferred for anilithics. +Such as: browser, OS, status code, url, where the user came from. +Most of the data is built on User Agent. It is possible to disable analytics in Kekkai. ??? note @@ -85,8 +88,10 @@ Kekkai uses [`Plausbile`](https://plausible.io/) as an analyst. Minimal data is ... ``` -- `plausible_api`: This is where the Plausible instance is specified. The official instance is specified by default. -- `plausible_domain`: Kekkai Instance Domain. It should be added to Plausible first, and then to the config. You can add the domain [here](https://plausible.io/sites/new?flow=provisioning). +- `plausible_api`: This is where the Plausible instance is specified. + The official instance is specified by default. +- `plausible_domain`: Kekkai Instance Domain. + It should be added to Plausible first, and then to the config. You can add the domain [here](https://plausible.io/sites/new?flow=provisioning). - `plausible_token`: Api token for authorization and sending requests. You can create it [here](https://plausible.io/settings/api-keys). - `work`: Enable or disable analytics. @@ -113,5 +118,6 @@ Kekkai uses [`Plausbile`](https://plausible.io/) as an analyst. Minimal data is - `currency.chart.save`: Enable or disable saving graphs. - `currency.collecting`: Enable or disable cryptocurrency or fiat currency exchange rate collection. -- `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`). +- `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`). - `currency.fiat`: A list of fiat currencies that will be saved to the database. \ No newline at end of file diff --git a/docs/endpoints/create-chart.md b/docs/endpoints/create-chart.md index 1912746..059cd99 100644 --- a/docs/endpoints/create-chart.md +++ b/docs/endpoints/create-chart.md @@ -41,10 +41,10 @@ Creating a currency rate chart. ``` ### Query params -| Parameter | Description | -|----------------|-------------------------------------------------------------------------| -| `from_currency`* | `ISO 4217` code of the currency from which the conversion takes place | -| `conv_currency`* | `ISO 4217` code of the currency to which the conversion is performed | +| Parameter | Description | +|-------------------|-------------------------------------------------------------------------| +| `from_currency`* | `ISO 4217` code of the currency from which the conversion takes place | +| `conv_currency`* | `ISO 4217` code of the currency to which the conversion is performed | ### URL params | Parameter | Description | @@ -70,7 +70,11 @@ Creating a currency rate chart. === "Curl" ```bash curl --request GET \ - --url https://kekkai-api.redume.su/api/getChart/?from_currency=RUB&conv_currency=USD&start_date=2024-10-31&end_date=2024-11-08 + --url https://kekkai-api.redume.su/api/getChart/? + from_currency=RUB& + conv_currency=USD& + start_date=2024-10-31& + end_date=2024-11-08 ``` === "Python" === "Request" @@ -108,12 +112,12 @@ Creating a currency rate chart. ``` ### Query params -| Parameter | Description | -|----------------|-------------------------------------------------------------------------| -| `from_currency`* | `ISO 4217` code of the currency from which the conversion takes place | -| `conv_currency`* | `ISO 4217` code of the currency to which the conversion is performed | -| `start_date`* | Start date of the period in the format `YYYYY-DD-MM` | -| `end_date`* | Period end date in the format `YYYYY-DD-MM` | +| Parameter | Description | +|------------------|------------------------------------------------------------------------| +| `from_currency`* | `ISO 4217` code of the currency from which the conversion takes place | +| `conv_currency`* | `ISO 4217` code of the currency to which the conversion is performed | +| `start_date`* | Start date of the period in the format `YYYYY-DD-MM` | +| `end_date`* | Period end date in the format `YYYYY-DD-MM` | `*` - Required arguments diff --git a/docs/endpoints/list-endpoints.md b/docs/endpoints/list-endpoints.md index af23d2c..f8b61b3 100644 --- a/docs/endpoints/list-endpoints.md +++ b/docs/endpoints/list-endpoints.md @@ -7,7 +7,8 @@ https://kekkai-api.redume.su/api/ ## API Endpoints -Kekkai has 3 API endpoints: `getRate`, `getChart` and `configurations`. Below you will find a list of parameters that each endpoint requires and a description of what the API does. +Kekkai has 3 API endpoints: `getRate`, `getChart` and `configurations`. +Below you will find a list of parameters that each endpoint requires and a description of what the API does. | Service | API Endpoint | Description | |--------------|--------------------------------------------------------|--------------------------------------------------------------------| diff --git a/docs/getting-started/docker.md b/docs/getting-started/docker.md index ac4197a..d0bd247 100644 --- a/docs/getting-started/docker.md +++ b/docs/getting-started/docker.md @@ -1,4 +1,5 @@ -Docker Compose is the recommended method to run Kekkai in production. Below are the steps to deploy Kekkai with Docker Compose. +Docker Compose is the recommended method to run Kekkai in production. +Below are the steps to deploy Kekkai with Docker Compose. Kekkai requires Docker Compose version 2.x. @@ -64,7 +65,9 @@ cd Kekkai ``` - Populate custom database information if necessary. - - Consider changing `DB_PASSWORD` to a custom value. Postgres is not publically exposed, so this password is only used for - local authentication. To avoid issues with Docker parsing this value, it is best to use only the characters `A-Za-z0-9`. + - Consider changing `DB_PASSWORD` to a custom value. + Postgres is not publically exposed, so this password is only used for - local authentication. + To avoid issues with Docker parsing this value, it is best to use only the characters `A-Za-z0-9`. !!! note After editing, rename the config files by removing `.sample` in the name diff --git a/docs/index.md b/docs/index.md index 506dbd6..fcf4567 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,8 @@ ## What is Kekkai? Kekkai — The first free Open-Source Tool for Saving Historical Currency data -It is a simple tool for collecting historical currency data from open sources, with the ability to create currency exchange rate charts. +It is a simple tool for collecting historical currency data from open sources, +with the ability to create currency exchange rate charts. ## Why Kekkai?