Настройка переменных окружения

Настройка RuBackup API осуществляется пользователем при помощи изменения переменных окружения.

Для RuBackup API данные из конфигурационного файла RuBackup (/opt/rubackup/etc/config.file) не используются.

Ниже представлен перечень переменных окружения доступных для изменения из файла /opt/rubackup/etc/rubackup_api.env:

Таблица 1. Переменные окружения
Имя переменной	Описание	Возможные значения
`APP_HOST`	Желаемый IP-адрес или FQDN, который будет использоваться как часть адреса сервера API. Если IP-адрес или FQDN указан некорректно, то при запуске RuBackup API не будут записываться access_token и refresh_token в cookies.	IP/FQDN (`localhost`)
`APP_PORT`	Желаемый порт, который будет использоваться как часть адреса сервера API	Порт (`5656`)
`DB_HOST`	IP или FQDN сервера PostgreSQL с базой данных RuBackup	IP/FQDN (`localhost`)
`DB_PORT`	Порт сервера PostgreSQL с базой данных RuBackup	Порт (`5432`)
`RB_SERVER_HOST`	IP или FQDN основного сервера RuBackup	IP/FQDN (`localhost`)
`DEBUG`	Режим расширенного логирования	`true`,`false`

Указанные переменные могут быть применены локально с помощью export:

export APP_HOST=api.rubackup.local

Пользователь может зафиксировать значения переменных глобально, описав их в файле /opt/rubackup/etc/rubackup_api.env.

Пример 1. Задание переменных окружения в rubackup_api.env

APP_HOST=localhost
APP_PORT=5656
DB_HOST=localhost
DB_PORT=5432
RB_SERVER_HOST=localhost
DEBUG=False

Запуск Swagger и Tucana будет произведён по адресу, указанному в параметре APP_HOST.

Чтобы запуск был произведен по доменному имени, достаточно указать его:

APP_HOST=api.rubackup.local

Тот же FQDN должен быть указан /etc/hosts.

Для запуска через localhost можно оставить параметры по умолчанию:

APP_HOST=localhost

Для запуска через IP-адрес нужно указать IP-адрес хоста:

APP_HOST=10.177.33.100

1. Настройка на выделенном хосте

Для RuBackup API из конфигурационного файла RuBackup (/opt/rubackup/etc/config.file) данные не используются.

Ниже представлен перечень переменных окружения доступных для изменения из файла /opt/rubackup/etc/rubackup_api.env:

Таблица 2. Переменные окружения
Имя переменной	Описание	Возможные значения
`APP_HOST`	Желаемый IP-адрес или FQDN, который будет использоваться как часть адреса сервера API. Если IP-адрес или FQDN указан некорректно, то при запуске RuBackup API не будут записываться access_token и refresh_token в cookies.	IP/FQDN (`localhost`)
`APP_PORT`	Желаемый порт, который будет использоваться как часть адреса сервера API	Порт (`5656`)
`DB_HOST`	IP или FQDN сервера PostgreSQL с базой данных RuBackup	IP/FQDN (`localhost`)
`DB_PORT`	Порт сервера PostgreSQL с базой данных RuBackup	Порт (`5432`)
`RB_SERVER_HOST`	IP или FQDN основного сервера RuBackup	IP/FQDN (`localhost`)
`DEBUG`	Режим расширенного логирования	`true`,`false`

Указанные переменные могут быть применены локально с помощью export:

export APP_HOST=api.rubackup.local

У пользователя есть возможность зафиксировать значения описанных переменных, описав их в файле .bashrc.

Пример 2. Файл .bashrc

# RuBackup API Settings
export APP_HOST=192.168.10.11
export APP_PORT=5655
export DB_HOST=localhost
export DB_PORT=5432

После этого необходимо перезагрузить переменные окружения:

. ~/.bashrc

Для запуска Swagger и Tucana на выделенном хосте в файл переменных окружения /opt/rubackup/etc/rubackup_api.env нужно установить следующие параметры:

APP_HOST= # IP или FQDN хоста, на котором установлен и будет запущен rest-api
APP_PORT=5656
DB_HOST= # IP или FQDN хоста с базой данных
DB_PORT=5432
RB_SERVER_HOST= # IP или FQDN хоста основного сервера rubackup