Системные параметры
Приложение настраивается через конфигурационный файл в yaml-формате.
| Параметр | Описание |
|---|---|
| version | Версия конфигурационного файла. Не меняется. |
| database_path | Путь до файла базы данных приложения. Приложение должно иметь права на запись в папку с файлом. |
| enable_api | Только для редакции Бизнес Включить создание заметок и управление пользователями по API |
Параметры веб-сервера приложения
Параметры веб-сервера указываются в разделе web.
Приложение работет только по https, поэтому параметры certificate и private_key обязательны.
Если у вас нет SSL-сертификатов, можно воспользоваться самоподписанными или автоматически полученными через центр сертификации 'Let's encrypt'
| Параметр | Тип | Описание |
|---|---|---|
| listen_address | строка | ip адрес интерфейса, на котором будет работать приложение |
| listen_port | число | порт, на котором будет работать приложение. |
| certificate | строка | полный путь до файла сертификата. |
| private_key | строка | полный путь до файла с приватным ключом. |
| user_session_lifetime | строка | Время в минутах сессии пользователя. В случае неактивности пользователя через указанный интервал времени сессия завершится. |
Параметры журналирования
Параметр журналирования находятся в разделе log.
| Параметр | Описание |
|---|---|
| level | Уровень детализации журналирования. Допустимые значения: error,warn,info, debug |
| path | Полный путь до файла журнала. Приложение должно иметь права на запись в каталог, где находится файл журнала. |
Параметры хранения заметок
Параметры хранения заметок находятся в разделе store.
Заметки хранятся на файловой системе. Каждая заметка в виде отдельного файла.
| Параметр | Описание |
|---|---|
| provider | Способ хранения заметок. Не меняется. |
| root_path | Полный путь к корневому каталогу, где будут храниться заметки. Приложение должно иметь права на запись в указанный каталог. |
Пример настроек
version: 1
database_path: /opt/almetibin/almetibin.db
enable_api: true
web:
listen_address: 0.0.0.0
listen_port: 443
certificate: "/opt/almetibin/server.crt"
private_key: "/opt/almetibin/server.key"
user_session_lifetime: 30m
log:
level: debug
path: /var/log/almetibin/almetibin.log
store:
provider: fs
fs:
root_path: /var/almetibin