Настройка Сервера документов для разработчиков

Распечатать/сохранить в PDF

Введение

Чтобы изменить какие-либо настройки Сервера документов, настройте соответствующий параметр в файле конфигурации, который находится по следующему пути:

Для Linux — /etc/r7-office/documentserver/default.json.
Для Windows — %ProgramFiles%\R7-OFFICE\DocumentServer\config\default.json.

Если вы хотите его изменить, вы можете использовать файл local.json, в котором должны храниться все редактируемые параметры. Этот файл находится в том же каталоге, что и файл default.json, и вся структура объекта для необходимого параметра должна быть сохранена.

Настройки сервера по умолчанию описаны ниже.

StatsD

Эти параметры определяют свойства сервера StatsD, определяющие агрегатор метрик.

Пример

"statsd": {
    "useMetrics": false,
    "host": "localhost",
    "port": "8125",
    "prefix": "ds."
}

Logger

Эти параметры определяют свойства регистратора.

Пример

"log": {
    "filePath": "",
    "options": {
        "replaceConsole": true
    }
}

Queues

Эти параметры определяют очередь сообщений, полученных от брокера сообщений.

Пример

"queue": {
    "type": "rabbitmq",
    "visibilityTimeout": 300,
    "retentionPeriod": 900
}

Служба хранения документов

Эти параметры определяют конфигурацию службы хранения документов.

Пример

"storage": {
    "name": "storage-fs",
    "fs": {
        "folderPath": "",
        "urlExpires": 900,
        "secretString": "verysecretstring"
    },
    "region": "",
    "endpoint": "http://localhost/s3",
    "bucketName": "cache",
    "storageFolderName": "files",
    "cacheFolderName": "data",
    "urlExpires": 604800,
    "accessKeyId": "AKID",
    "secretAccessKey": "SECRET",
    "sslEnabled": false,
    "s3ForcePathStyle": true,
    "externalHost": ""
}

RabbitMQ

Эти параметры определяют конфигурацию брокера сообщений RabbitMQ.

Пример

"rabbitmq": {
    "url": "amqp://guest:guest@localhost:5672",
    "socketOptions": {},
    "exchangepubsub": "ds.pubsub",
    "queueconverttask": "ds.converttask",
    "queueconvertresponse": "ds.convertresponse",
    "exchangeconvertdead": "ds.exchangeconvertdead",
    "queueconvertdead": "ds.convertdead",
    "queuedelayed": "ds.delayed"
}

ActiveMQ

Эти параметры определяют конфигурацию брокера сообщений ActiveMQ.

Пример

"activemq": {
    "connectOptions": {
        "port": 5672,
       "host": "localhost",
       "reconnect": false
},
     "queueconverttask": "ds.converttask",
     "queueconvertresponse": "ds.convertresponse",
     "queueconvertdead": "ActiveMQ.DLQ",
     "queuedelayed": "ds.delayed",
     "topicpubsub": "ds.pubsub"
}

DNS кэш

Эти параметры определяют конфигурацию DNS-кэша, который используется для IP-фильтра.

Пример

"dnscache": {
    "enable" : true,
    "ttl" : 300,
    "cachesize" : 1000
}

Протокол OpenPGP

Эти параметры определяют настройки протокола OpenPGP, который используется для шифрования пароля при открытии зашифрованного документа для редактирования.

Пример

"openpgpjs": {
     "config": {
     },
    "encrypt": {
         "passwords": ["verysecretstring"]
    },
    "decrypt": {
        "passwords": ["verysecretstring"]
     }
}

Bottleneck

Этот параметр определяет конфигурацию узкого места.

Пример

"bottleneck": {
     "getChanges": {
     }
}

Tenants

Эти параметры определяют свойства арендаторов для работы в мультитенантном режиме.

Пример

"tenants": {
    "baseDir" : "",
    "baseDomain" : "",
    "filenameConfig" : "config.json",
    "filenameSecret" : "secret.key",
    "filenameLicense" : "license.lic",
    "defaultTenant" : "localhost",
    "cache": {
        "stdTTL": 300,
        "checkperiod": 60,
        "useClones": false
},
}

Сервис Сервера документов

Эти параметры определяют настройки служб Сервера документов.

Сервер

Эти параметры определяют конфигурацию сервера.

Пример

"services": {
    "CoAuthoring": {
        "server": {
            "port": 8000,
             "workerpercpu": 1,
             "mode": "development",
             "limits_tempfile_upload": 104857600,
             "limits_image_size": 26214400,
             "limits_image_download_timeout": {
             "connectionAndInactivity": "2m",
             "wholeCycle": "2m"
             },
             "callbackRequestTimeout": {
             "connectionAndInactivity": "10m",
             "wholeCycle": "10m"
             },
             "healthcheckfilepath": "../public/healthcheck.docx",
             "savetimeoutdelay": 5000,
             "edit_singleton": false,
             "forgottenfiles": "forgotten",
             "forgottenfilesname": "output",
             "maxRequestChanges": 20000,
             "openProtectedFile": true,
             "isAnonymousSupport": true,
             "editorDataStorage": "editorDataRedis",
             "assemblyFormatAsOrigin": true,
             "newFileTemplate" : "../../document-templates/new",
             "downloadFileAllowExt": ["pdf", "xlsx"],
             "tokenRequiredParams" : true,
             "allowPrivateIPAddressForSignedRequests" : true
          }
     }
}

Стандартные запросы

Эти параметры определяют конфигурацию запроса по умолчанию.

Пример

"services": {
    "CoAuthoring": {
        "requestDefaults": {
            "headers": {
                 "User-Agent": "Node.js/6.13",
                 "Connection": "Keep-Alive"
            },
            "gzip": true,
            "rejectUnauthorized": true
        }
    }
}

Автосборка

Эти параметры определяют конфигурацию автоматического принудительного сохранения.

Пример

"services": {
    "CoAuthoring": {
        "autoAssembly": {
            "enable": false,
            "interval": "5m",
            "step": "1m"
        }
    }
}

Утилиты

Эти параметры определяют конфигурацию утилит.

Пример

"services": {
    "CoAuthoring": {
        "utils": {
            "utils_common_fontdir": "null",
            "utils_fonts_search_patterns": "*.ttf;*.ttc;*.otf",
            "limits_image_types_upload": "jpg;jpeg;jpe;png;gif;bmp;svg"
        }
    }
}

SQL

Эти параметры определяют конфигурацию базы данных.

Пример

"services": {
    "CoAuthoring": {
         "sql": {
              "type": "postgres",
              "tableChanges": "doc_changes",
              "tableResult": "task_result",
              "dbHost": "localhost",
              "dbPort": 5432,
              "dbName": "ds",
              "dbUser": "ds",
              "dbPass": "ds",
              "charset": "utf8",
              "connectionlimit": 10,
              "max_allowed_packet": 1048575,
              "pgPoolExtraOptions": {}
         }
     }
}

Сервис PubSub

Этот параметр определяет конфигурацию службы PubSub.

Пример

"services": {
     "CoAuthoring": {
         "pubsub": {
             "maxChanges": 1000
         }
     }
}

Срок действия

Эти параметры определяют настройки срока действия.

Пример

"services": {
    "CoAuthoring": {
        "expire": {
            "saveLock": 60,
            "presence": 300,
            "locks": 604800,
            "changeindex": 86400,
            "lockDoc": 30,
            "message": 86400,
            "lastsave": 604800,
            "forcesave": 604800,
            "forcesaveLock": 5000,
            "saved": 3600,
            "documentsCron": "0 */2 * * * *",
            "files": 86400,
            "filesCron": "00 00 */1 * * *",
            "filesremovedatonce": 100,
            "sessionidle": "1h",
            "sessionabsolute": "30d",
            "sessionclosecommand": "2m",
            "pemStdTTL": "1h",
            "pemCheckPeriod": "10m",
            "updateVersionStatus": "5m",
            "monthUniqueUsers": "1y"
        }
    }
}

IP фильтр

Эти параметры определяют конфигурацию IP-фильтра.

Пример

"services": {
    "CoAuthoring": {
        "ipfilter": {
            "rules": [{"address": "*", "allowed": true}],
            "useforrequest": false,
            "errorcode": 403
        }
    }
}

Агент фильтрации запросов

Эти параметры определяют конфигурацию агента фильтрации запросов.

Пример

"services": {
    "CoAuthoring": {
        "request-filtering-agent" : {
            "allowPrivateIPAddress": false,
            "allowMetaIPAddress": false
        }
    }
}

Секретный ключ

Эти параметры определяют конфигурацию секретного ключа.

Пример

"services": {
    "CoAuthoring": {
        "secret": {
            "browser": {"string": "secret", "file": ""},
            "inbox": {"string": "secret", "file": ""},
            "outbox": {"string": "secret", "file": ""},
            "session": {"string": "secret", "file": ""}
        }
    }
}

Токен

Эти параметры определяют конфигурацию токена.

Пример

"services": {
     "CoAuthoring": {
         "token": {
             "enable": {
                 "browser": false,
                 "request": {
                     "inbox": false,
                     "outbox": false
                 }
         },
         "browser": {
              "secretFromInbox": true
         },
         "inbox": {
             "header": "Authorization",
             "prefix": "Bearer ",
             "inBody": false
         },
         "outbox": {
             "header": "Authorization",
             "prefix": "Bearer ",
             "algorithm": "HS256",
             "expires": "5m",
             "inBody": false,
             "urlExclusionRegex": ""
         },
         "session": {
             "algorithm": "HS256",
             "expires": "30d"
         },
         "verifyOptions": {
             "clockTolerance": 60
         }
       }
    }
}

Плагины

Эти параметры определяют конфигурацию плагинов.

Пример

"services": {
    "CoAuthoring": {
        "plugins": {
            "uri": "/sdkjs-plugins",
            "autostart": []
        }
    }
}

Темы

Этот параметр определяет свойства пользовательских цветовых тем.

Пример

"services": {
    "CoAuthoring": {
        "themes": {
            "uri": "/web-apps/apps/common/main/resources/themes"
        }
    }
}

Редактор

Эти параметры определяют конфигурацию редактора.

Пример

"services": {
     "CoAuthoring": {
          "editor":{
             "spellcheckerUrl": "",
             "reconnection":{
                 "attempts": 50,
                 "delay": "2s"
             },
             "binaryChanges": false,
             "websocketMaxPayloadSize": "1.5MB",
             "maxChangesSize": "0mb"
          }
     }
}

SockJs

Эти параметры определяют конфигурацию SockJs.

Пример

"services": {
    "CoAuthoring": {
        "sockjs": {
            "sockjs_url": "",
            "disable_cors": true,
            "websocket": true
         }
     }
}

Socket.IO

Эти параметры определяют конфигурацию модуля Socket.IO.

Пример

"socketio": {
    "connection": {
        "path": "/doc/",
        "serveClient": false,
        "pingTimeout": 20000,
        "pingInterval": 25000,
        "maxHttpBufferSize": 1e8
    }
}

Параметры обратного вызова

Эти параметры определяют параметры отсрочки обратного вызова.

Пример

"services": {
    "CoAuthoring": {
        "callbackBackoffOptions": {
            "retries": 0,
            "timeout":{
                "factor": 2,
                "minTimeout": 1000,
                "maxTimeout": 2147483647,
                "randomize": false
        },
        "httpStatus": "429,500-599"
       }
    }
}

Лицензия

Эти параметры определяют конфигурацию лицензии.

Пример

"license" : {
    "license_file": "",
    "warning_limit_percents": 70,
    "packageType": 2
}

Конвертер

Эти параметры определяют конфигурацию конвертера файлов.

Пример

"FileConverter": {
    "converter": {
        "maxDownloadBytes": 104857600,
        "downloadTimeout": {
            "connectionAndInactivity": "2m",
            "wholeCycle": "2m"
        },
        "downloadAttemptMaxCount": 3,
        "downloadAttemptDelay": 1000,
        "maxprocesscount": 1,
        "fontDir": "null",
        "presentationThemesDir": "null",
        "x2tPath": "null",
        "docbuilderPath": "null",
        "args": "",
        "spawnOptions": {},
        "errorfiles": "",
        "streamWriterBufferSize": 8388608,
        "maxRedeliveredCount": 2,
        "inputLimits": [
            {
            "type": "docx;dotx;docm;dotm",
            "zip": {
                "uncompressed": "50MB",
                "template": "*.xml"
            }
            },
            {
            "type": "xlsx;xltx;xlsm;xltm",
            "zip": {
                "uncompressed": "300MB",
                "template": "*.xml"
            }
            },
            {
            "type": "pptx;ppsx;potx;pptm;ppsm;potm",
            "zip": {
                "uncompressed": "50MB",
                "template": "*.xml"
            }
            }
        ]
    }
}