ostiwe-com/status
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases 1 Wiki Activity

feat(docs): Update documentation

Browse Source
This commit is contained in:
Nikolay Anoshin
2025-08-20 01:10:37 +03:00
parent 28226639b9
commit b72066f19e
4 changed files with 43 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
docs/RU.md Normal file
View File

@@ -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` алгоритм.