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

fix(docs): Fixed text length in markdown

Browse source
This commit is contained in:
Данил 2025-01-17 15:49:28 +03:00
parent 9bc6c0a203
commit b6490ca65a
6 changed files with 37 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/config/conf-nginx.md
View file

@ -2,7 +2,8 @@ Kekkai is used by `Nginx` to redirect to the correct microservice.
## Change domain ## 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 ??? note
``` ```

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

@ -68,10 +68,13 @@ mkdir CertSSL
Copy your certificates to the CertSSL folder. 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 ## 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 ??? 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_api`: This is where the Plausible instance is specified.
- `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). 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). - `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. - `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.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. 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. - `currency.fiat`: A list of fiat currencies that will be saved to the database.

26
docs/endpoints/create-chart.md
View file

@ -41,10 +41,10 @@ Creating a currency rate chart.
``` ```
### Query params ### Query params
| Parameter | Description | | Parameter | Description |
|----------------|-------------------------------------------------------------------------| |-------------------|-------------------------------------------------------------------------|
| `from_currency`* | `ISO 4217` code of the currency from which the conversion takes place | | `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 | | `conv_currency`* | `ISO 4217` code of the currency to which the conversion is performed |
### URL params ### URL params
| Parameter | Description | | Parameter | Description |
@ -70,7 +70,11 @@ Creating a currency rate chart.
=== "Curl" === "Curl"
```bash ```bash
curl --request GET \ 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" === "Python"
=== "Request" === "Request"
@ -108,12 +112,12 @@ Creating a currency rate chart.
``` ```
### Query params ### Query params
| Parameter | Description | | Parameter | Description |
|----------------|-------------------------------------------------------------------------| |------------------|------------------------------------------------------------------------|
| `from_currency`* | `ISO 4217` code of the currency from which the conversion takes place | | `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 | | `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` | | `start_date`* | Start date of the period in the format `YYYYY-DD-MM` |
| `end_date`* | Period end date in the format `YYYYY-DD-MM` | | `end_date`* | Period end date in the format `YYYYY-DD-MM` |
`*` - Required arguments `*` - Required arguments

3
docs/endpoints/list-endpoints.md
View file

@ -7,7 +7,8 @@ https://kekkai-api.redume.su/api/
## API Endpoints ## 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 | | Service | API Endpoint | Description |
|--------------|--------------------------------------------------------|--------------------------------------------------------------------| |--------------|--------------------------------------------------------|--------------------------------------------------------------------|

7
docs/getting-started/docker.md
View file

@ -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. Kekkai requires Docker Compose version 2.x.
@ -64,7 +65,9 @@ cd Kekkai
``` ```
- Populate custom database information if necessary. - 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 !!! note
After editing, rename the config files by removing `.sample` in the name After editing, rename the config files by removing `.sample` in the name

3
docs/index.md
View file

@ -1,7 +1,8 @@
## What is Kekkai? ## What is Kekkai?
Kekkai — The first free Open-Source Tool for Saving Historical Currency data 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? ## Why Kekkai?