feat(docs): Update documentation

This commit is contained in:
2025-08-20 01:10:37 +03:00
parent 28226639b9
commit b72066f19e
4 changed files with 43 additions and 11 deletions

View File

@@ -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 | - |
* [Russian Documentation](docs/RU.md)

View File

@@ -0,0 +1,3 @@
-----BEGIN PRIVATE KEY-----
MC4CAQAwBQYDK2VwBCIEIErwGenQ53CBtItiMuRBUgrn5/l1uYW6RiAoE+9IFqtj
-----END PRIVATE KEY-----

View File

@@ -0,0 +1,3 @@
-----BEGIN PUBLIC KEY-----
MCowBQYDK2VwAyEANttz9RhiE7FXL4A/PX3GfgxhWxSwKy5zhxrNHXifszs=
-----END PUBLIC KEY-----

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