From b72066f19e1d528a7206532fddbe6fed34ee5d92 Mon Sep 17 00:00:00 2001
From: ostiwe <ostiwe@icloud.com>
Date: Wed, 20 Aug 2025 01:10:37 +0300
Subject: [PATCH] feat(docs): Update documentation

---
 README.md                         | 15 ++++----------
 _example/keys/jwt_private_key.pem |  3 +++
 _example/keys/jwt_public_key.pem  |  3 +++
 docs/RU.md                        | 33 +++++++++++++++++++++++++++++++
 4 files changed, 43 insertions(+), 11 deletions(-)
 create mode 100644 _example/keys/jwt_private_key.pem
 create mode 100644 _example/keys/jwt_public_key.pem
 create mode 100644 docs/RU.md

diff --git a/README.md b/README.md
index 89e847c..6f6b9ec 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# Status page
+# Status page server
 
 #### How to run server:
 
@@ -27,15 +27,8 @@ Commands:
   server-docs            Generate documentation for api server
 ```
 
-## Configuration
+### Configuration
 
-To configure application follow these table of Env:
+Go to one of these link for get documentation for app configuration
 
-| Name          | Example        | Definition |
-|---------------|----------------|------------|
-| DATABASE_HOST | localhost      | -          |
-| DATABASE_PORT | 5432           | -          |
-| DATABASE_USER | someUserName   | -          |
-| DATABASE_PASS | strongPassword | -          |
-| DATABASE_DB   | statuspage     | -          |
-| DATABASE_TZ   | Europe/Moscow  | -          |
\ No newline at end of file
+* [Russian Documentation](docs/RU.md)
\ No newline at end of file
diff --git a/_example/keys/jwt_private_key.pem b/_example/keys/jwt_private_key.pem
new file mode 100644
index 0000000..385ed01
--- /dev/null
+++ b/_example/keys/jwt_private_key.pem
@@ -0,0 +1,3 @@
+-----BEGIN PRIVATE KEY-----
+MC4CAQAwBQYDK2VwBCIEIErwGenQ53CBtItiMuRBUgrn5/l1uYW6RiAoE+9IFqtj
+-----END PRIVATE KEY-----
diff --git a/_example/keys/jwt_public_key.pem b/_example/keys/jwt_public_key.pem
new file mode 100644
index 0000000..8974694
--- /dev/null
+++ b/_example/keys/jwt_public_key.pem
@@ -0,0 +1,3 @@
+-----BEGIN PUBLIC KEY-----
+MCowBQYDK2VwAyEANttz9RhiE7FXL4A/PX3GfgxhWxSwKy5zhxrNHXifszs=
+-----END PUBLIC KEY-----
diff --git a/docs/RU.md b/docs/RU.md
new file mode 100644
index 0000000..f18e22a
--- /dev/null
+++ b/docs/RU.md
@@ -0,0 +1,33 @@
+## Настройка приложения
+
+### Переменные окружения
+
+| Название                                | Пример                           |
+|-----------------------------------------|----------------------------------|
+| DATABASE_HOST                           | localhost                        |
+| DATABASE_PORT                           | 5432                             |
+| DATABASE_USER                           | someUserName                     |
+| DATABASE_PASS                           | strongPassword                   |
+| DATABASE_DB                             | statuspage                       |
+| DATABASE_TZ                             | Europe/Moscow                    |
+| RABBIT_USER                             | user                             |
+| RABBIT_PASSWORD                         | user                             |
+| RABBIT_HOST                             | localhost                        |
+| RABBIT_PORT                             | 5672                             |
+| [JWT_SIGN_KEY_PATH](#JWT_SIGN_KEY_PATH) | example/keys/jwt_private_key.pem |
+
+#### JWT_SIGN_KEY_PATH
+
+Для подписи JWT токенов, нужно сгенерировать пару ключей, для примера, они уже есть в проекте,
+и для проверки работы можно оставить текущую конфигурацию. Для production - необходимо сгенерировать свои ключи.
+
+Если ключ расположен рядом с исполняемым файлом, укажите путь до него без `/` в начале.
+
+Для генерации ключей можно использовать следующие команды:
+
+```shell
+openssl genpkey -algorithm Ed25519 -out jwt_private_key.pem
+openssl pkey -in jwt_private_key.pem -pubout -out jwt_public_key.pem
+```
+
+Для генерации ключей и используйте `Ed25519` алгоритм.
\ No newline at end of file