Skip to content

Конфигурация сервиса Onlyoffice

Логгер

КлючОписание
onlyoffice.log.lvlуровень логгирования приложения
5 - debug
4 - info
3 - warning
2 - error
Пример env: POTENTIAL_ONLYOFFICE_LOG_LVL=5
onlyoffice.log.pathпуть до лога сервиса
Пример env: POTENTIAL_ONLYOFFICE_LOG_PATH=/tmp/next_box/onlyoffice.log
пример части конфигурации в yml конфиге
yaml
onlyoffice:
  log:
    lvl: 5
    path: /tmp/next_box/onlyoffice.log

Http сервер

КлючОписание
onlyoffice.http.hostАдрес http сервера
Пример env: POTENTIAL_ONLYOFFICE_HTTP_HOST=0.0.0.0
onlyoffice.http.portПорт http сервера
Пример env: POTENTIAL_ONLYOFFICE_HTTP_PORT=6004
onlyoffice.http.max_multipart_body_sizeмаксимальный размер тела, при мультипарт запросах POTENTIAL_ONLYOFFICE_HTTP_MAX_MULTIPART_BODY_SIZE=4.3980465e+12
onlyoffice.http.read_timeoutмаксимальная продолжительность чтения всего запроса, включая текст. Нулевое или отрицательное значение означает, что тайм-аута не будет. POTENTIAL_ONLYOFFICE_HTTP_READ_TIMEOUT=10
onlyoffice.http.write_timeoutмаксимальное время до истечения времени ожидания записи ответа. Оно сбрасывается всякий раз, когда считывается заголовок нового запроса. Как и ReadTimeout, оно не позволяет обработчикам принимать решения для каждого отдельного запроса. Нулевое или отрицательное значение означает, что тайм-аута не будет.
Пример env: POTENTIAL_ONLYOFFICE_HTTP_WRITE_TIMEOUT=10
onlyoffice.internal_http.mtls_enableВключение шифрование трафика mTLS между сервисами NB.
Пример env: POTENTIAL_ONLYOFFICE_INTERNAL_HTTP_MTLS_ENABLE=false
onlyoffice.internal_http.server_cert_key_pathПриватный ключ сервера для mTLS.
Пример env: POTENTIAL_ONLYOFFICE_INTERNAL_HTTP_SERVER_CERT_KEY_PATH=./host.docker.internal.key
onlyoffice.internal_http.server_cert_pathСертификат сервера для mTLS.
Пример env: POTENTIAL_ONLYOFFICE_INTERNAL_HTTP_SERVER_CERT_PATH=./host.docker.internal.crt
onlyoffice.internal_http.client_cert_key_pathПриватный ключ клиента для mTLS.
Пример env: POTENTIAL_ONLYOFFICE_INTERNAL_HTTP_CLIENT_CERT_KEY_PATH=./client.key
onlyoffice.internal_http.client_cert_pathСертификат сервера для mTLS.
Пример env: POTENTIAL_ONLYOFFICE_INTERNAL_HTTP_CLIENT_CERT_PATH=./client.crt
onlyoffice.internal_http.ca_cert_pathКорневой сертификат для mTLS.
Пример env: POTENTIAL_ONLYOFFICE_INTERNAL_HTTP_CA_CERT_PATH=./cert.crt
пример части конфигурации в yml конфиге
yaml
onlyoffice:
  http:
    host: 0.0.0.0
    max_multipart_body_size: 0
    port: 6004
    read_timeout: 0
    write_timeout: 0
  internal_http:
    ca_cert_path: ./cert.crt
    client_cert_key_path: ./client.key
    client_cert_path: ./client.crt
    mtls_enable: false
    server_cert_key_path: ./host.docker.internal.key
    server_cert_path: ./host.docker.internal.crt

База данных

КлючОписание
onlyoffice.database.dsnDsn для доступа к базе данных в формате:
postgres://<login>:<password>@<address>:<port>/onlyoffice"
login - логин базы
password - пароль от базы
address - адрес до базы
port - порт до базы
Пример env: POTENTIAL_ONLYOFFICE_DATABASE_DSN=postgres://admin:admin@127.0.0.1:5432/onlyoffice
пример части конфигурации в yml конфиге
yaml
onlyoffice:
  database:
    dsn: postgres://admin:admin@127.0.0.1:5432/onlyoffice

Общие настройки сервиса

КлючОписание
onlyoffice.service.tokenТокен для межсервисного общения. Такой же токен должен быть у каждого сервиса nextbox.
Пример env: POTENTIAL_ONLYOFFICE_SERVICE_TOKEN=qwe123
onlyoffice.service.nameНазвание сервиса
Пример env: POTENTIAL_ONLYOFFICE_SERVICE_NAME=Onlyoffice
onlyoffice.service.route_nameНазвание роута сервиса, лучше не менять, иначе возможны проблемы в общении между сервисами!
Пример env: POTENTIAL_ONLYOFFICE_SERVICE_ROUTE_NAME=onlyoffice
onlyoffice.service.back_urlАдрес по которому обращаются к сервису другие сервисы NB.
Пример env: POTENTIAL_ONLYOFFICE_SERVICE_BACK_URL=http://127.0.0.1:6004
onlyoffice.service.instance_numberНомер сервиса. Используется для горизонтального масштабирования сервисов. В текущем сервисе не должен отличаться от 1
Пример env: POTENTIAL_ONLYOFFICE_SERVICE_INSTANCE_NUMBER=1
onlyoffice.discovery.urlАдрес discovery сервиса в NB. В котором регистрируются все сервисы в NB
Пример env: POTENTIAL_ONLYOFFICE_DISCOVERY_URL=http://127.0.0.1:6001
onlyoffice.discovery.onlyoffice_server_urlАдрес сервера onlyoffice.
Пример env: POTENTIAL_ONLYOFFICE_DISCOVERY_ONLYOFFICE_SERVER_URL=http://0.0.0.0:6019
onlyoffice.discovery.gateway_urlВнешний адрес гейтвея. Нужен для callback из onlyoffice server. Если в системе несколько гейтвеев, то нужно указать один из них.
Пример env: POTENTIAL_ONLYOFFICE_DISCOVERY_GATEWAY_URL=http://0.0.0.0:6019
пример части конфигурации в yml конфиге
yaml
onlyoffice:
  service:
    back_url: http://127.0.0.1:6004
    instance_number: 1
    name: Onlyoffice
    route_name: onlyoffice
    token: qwe123
  discovery:
    url: http://127.0.0.1:6001

Безопасность

КлючОписание
onlyoffice.tokens.sign_keyСекретный ключ для подписи авторизационных JWT токенов.
Пример env: POTENTIAL_ONLYOFFICE_TOKENS_LIMIT_SIGN_KEY=qwe123
пример части конфигурации в yml конфиге
yaml
onlyoffice:
  tokens:
    sign_key: qwe123

Настройки rabbitmq

КлючОписание
onlyoffice.rabbit_mq.userЛогин пользователя в rabbitmq.
Пример env: POTENTIAL_ONLYOFFICE_RABBIT_MQ_USER=guest
onlyoffice.rabbit_mq.passwordПароль пользователя в rabbitmq.
Пример env: POTENTIAL_ONLYOFFICE_RABBIT_MQ_PASSWORD=guest
onlyoffice.rabbit_mq.hostАдрес сервера rabbitmq.
Пример env: POTENTIAL_ONLYOFFICE_RABBIT_MQ_HOST=127.0.0.1
onlyoffice.rabbit_mq.portПорт сервера rabbitmq.
Пример env: POTENTIAL_ONLYOFFICE_RABBIT_MQ_PORT=5672
onlyoffice.rabbit_mq.vhostvhost rabbitmq.
Пример env: POTENTIAL_ONLYOFFICE_RABBIT_MQ_VHOST=
пример части конфигурации в yml конфиге
yaml
onlyoffice:
  rabbit_mq:
    host: 127.0.0.1
    password: guest
    port: "5672"
    user: guest
    vhost: ""