Обзор конфигурационных файлов#

Обзор конфигурационных файлов — какие файлы настроек использует сервер RuDesktop, где они находятся, какие создаёт установщик и какие можно править вручную

Состав#

Все файлы создаёт установщик при установке сервера

Файл

Назначение

Ручная правка

/etc/default/rudesktop

Переменные окружения всех компонентов: адреса, база данных, режим установки — переменные и сценарии

Да

/etc/rudesktop-relay.toml

Конфигурация relay: мосты, слушатели, статусы и кеш — ключи TOML

Да, создаётся вручную

/etc/rudesktop/settings

Настройки веб-интерфейса: ALLOWED_HOSTS, DEBUG_TOOLS

Да

/etc/nginx/sites-available/rudesktop

Виртуальный хост nginx: проксирование, SSL, сжатие

Да

/etc/nginx/nginx.conf

Основной конфиг nginx; создаётся при установке, лимиты воркеров обновляются установщиком

Да, с осторожностью

/etc/nginx/rudesktop_params и /etc/nginx/rudesktop_pxe_params

Вспомогательные файлы nginx, подключаемые к виртуальному хосту: правила загрузки пакетов, PXE, защищённые медиафайлы

Нет, перезаписываются

/etc/rudesktop/ansible.cfg

Конфигурация Ansible для политик и задач

Нет, перезаписывается

/etc/rudesktop/redis.conf

Конфигурация встроенного Redis; копируется при установке, если отсутствует — настройка Redis

Редко

/var/lib/rudesktop/ca/

Ключ и сертификат корневого CA, конфигурация выпуска сертификатов

Нет

Что перезаписывается при каждой установке#

Повторный запуск rude install не трогает уже существующие файлы, кроме:

  • /etc/rudesktop/ansible.cfg

  • /etc/nginx/rudesktop_params и /etc/nginx/rudesktop_pxe_params

  • /var/lib/rudesktop/ca/config.cfg

Деструктивная команда rude reinstall удаляет /etc/default/rudesktop, каталог /etc/rudesktop целиком, виртуальный хост nginx и корневой CA, после чего генерирует их заново — ручные правки этих файлов пропадут

Настройки веб-интерфейса /etc/rudesktop/settings#

Файл дополнительных настроек веб-интерфейса. Генерируется при установке и содержит адреса сервера из установки:

PUBLIC_HOST='example.com'
PUBLIC_PORT='443'
LOCAL_HOST='example.com'
LOCAL_PORT='443'
DEBUG_TOOLS=False
ALLOWED_HOSTS = ['example.com',]

Типичные случаи ручной правки:

  • Добавить адреса в ALLOWED_HOSTS — если сервер отвечает по доменам или IP, не указанным при установке (например, при публикации через балансировщик). Без этого веб-интерфейс по такому адресу вернёт 400 Bad Request. Например, сервер дополнительно отвечает по server2.example.com:

    ALLOWED_HOSTS = ['example.com', 'server2.example.com',]
    
  • DEBUG_TOOLS=True — включает отладочную панель. Только на время диагностики

Предупреждение

PUBLIC_HOST и PUBLIC_PORT в этом файле дублируют значения /etc/default/rudesktop — синхронизируйте их вручную, если меняете адрес сервера

Конфигурация nginx#

Виртуальный хост /etc/nginx/sites-available/rudesktop — основной файл для ручных правок сервера: ограничение доступа, собственные сертификаты, проксирование через WAF. Типовые изменения описаны в разделе Сетевые настройки:

Файлы rudesktop_params и rudesktop_pxe_params подключаются к виртуальному хосту автоматически и перезаписываются при каждой установке — свои location-блоки добавляйте в виртуальный хост, а не в эти файлы

Ansible и Redis#

/etc/rudesktop/ansible.cfg перегенерируется установщиком; рабочие параметры Ansible — число параллельных потоков и таймауты — задаются в веб-интерфейсе на странице Настройки и применяются при запуске задач

Подключение сервера к Redis задаётся переменной REDIS_URL в /etc/default/rudesktop, сам redis.conf правится только для специфических сценариев — Настройка Redis

Дополнительные переменные для нестандартных сценариев собраны на странице Расширенные параметры