ONLYOFFICE Docs エンタープライズ版の設定

はじめに

ONLYOFFICE Docs サーバーの設定を変更するには、ONLYOFFICE Docs の設定ファイル内で対応するパラメータを構成します。このファイルは次のパスにあります：

• Linuxの場合 - /etc/onlyoffice/documentserver/default.json
• Windowsの場合 - %ProgramFiles%\ONLYOFFICE\DocumentServer\config\default.json

変更したい場合は、編集したすべてのパラメータを保存する local.json ファイルを使用できます。このファイルは default.json ファイルと同じディレクトリにあり、必要なパラメータのオブジェクト構造全体を保持する必要があります。

デフォルトのサーバー設定は以下に説明されています。

管理パネル

これらのパラメータは管理パネルのプロパティを定義します。管理パネルの使用方法についての詳細はこちらの記事を参照してください。

例

"adminPanel": {
    "port": 9000
  }

StatsD

これらのパラメータは、メトリクスの集約を指定する StatsD サーバーのプロパティを定義します。

例

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

AIプラグイン設定

これらのパラメータはAIプラグインのプロパティを定義します。

例

"aiSettings": {
    "actions": {},
    "models": [],
    "providers": {},
    "version": 3,
    "timeout": "5m",
    "allowedCorsOrigins": ["https://onlyoffice.github.io", "https://onlyoffice-plugins.github.io"],
    "proxy": ""
  }

ロガー

これらのパラメータはロガーのプロパティを定義します。

例

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

ランタイム設定

これらのパラメーターは、runtime.json動的設定ファイルのプロパティを定義します。このファイルにより、再起動せずにパラメーターを変更できます。ファイルはウォッチイベントまたは5分ごとに再読み込みされます。

例

"runtimeConfig": {
    "filePath": "",
    "cache": {
      "stdTTL": 300,
      "checkperiod": 60,
      "useClones": false
    }
  }

キュー

これらのパラメーターは、メッセージブローカーから受信したメッセージのキューを定義します。

例

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

メール

これらのパラメーターは、通知を送信するために使用される外部メールサーバーの設定を定義します。メールサーバーに接続するには、 nodemailerライブラリを使用します。多くの設定はこのライブラリに直接渡されます。

例

"email": {
    "smtpServerConfiguration": {
        "host": "localhost",
        "port": 587,
        "auth": {
            "user": "",
            "pass": ""
        }
    },
    "connectionConfiguration": {
        "disableFileAccess": false,
        "disableUrlAccess": false
    },
    "contactDefaults": {
        "from": "from@example.com",
        "to": "to@example.com"
    }
}

通知

これらのパラメータは通知設定を定義します。

以下のイベントタイプと内容の通知が送信されます：

• 接続クォータ（ユニークユーザーのクォータ）の70％を超えた場合。

  ライセンス接続制限警告："注意！ライセンスで設定された接続制限の70％に達しました。"

• 接続クォータ（ユニークユーザーのクォータ）に達した場合。

  ライセンス接続制限警告："注意！ライセンスで設定された接続制限の100％に達しました。"

• ライセンスの有効期限の30日前。

  ライセンス有効期限警告： "注意！あなたのライセンスは2024年9月8日に期限切れになります。 この日付に達すると、個別の技術サポートを受けたり、この日付以降にリリースされた新しいDocsバージョンをインストールする権利がなくなります。"

• ライセンスが期限切れになった場合。

  ライセンス接続制限警告： "注意！あなたのライセンスは2024年9月8日に期限切れになりました。 個別の技術サポートを受けたり、この日付以降にリリースされた新しいDocsバージョンをインストールする権利がなくなります。 ライセンスの更新についてはsales@onlyoffice.comにお問い合わせください。"

これらの通知はサーバーログにWARNまたはERRORレベルで記録されます。

例

"notification": {
    "rules": {
        "licenseExpirationWarning": {
            "enable": false,
            "transportType": [
                "email"
            ],
            "template": {
                "title": "%s Docs ライセンス有効期限警告",
                "body": "注意！あなたのライセンスは%sに期限切れになります。\nこの日付に達すると、個別の技術サポートを受けたり、この日付以降にリリースされた新しいDocsバージョンをインストールする権利がなくなります。"
            },
            "policies": {
                "repeatInterval": "1d"
            }
        },
        "licenseExpirationError": {
            "enable": false,
            "transportType": [
                "email"
            ],
            "template": {
                "title": "%s Docs ライセンス有効期限警告",
                "body": "注意！あなたのライセンスは%sに期限切れになりました。\n個別の技術サポートを受けたり、この日付以降にリリースされた新しいDocsバージョンをインストールする権利がなくなります。\nライセンスの更新についてはsales@onlyoffice.comにお問い合わせください。"
            },
            "policies": {
                "repeatInterval": "1d"
            }
        },
        "licenseLimitEdit": {
            "enable": false,
            "transportType": [
                "email"
            ],
            "template": {
                "title": "%s Docs ライセンス接続制限警告",
                "body": "注意！ライセンスで設定された%sの制限の%s%%に達しました。"
            },
            "policies": {
                "repeatInterval": "1h"
            }
        },
        "licenseLimitLiveViewer": {
            "enable": false,
            "transportType": [
                "email"
            ],
            "template": {
                "title": "%s Docs ライセンス接続制限警告",
                "body": "注意！ライセンスで設定されたライブビューアー%sの制限の%s%%に達しました。"
            },
            "policies": {
                "repeatInterval": "1h"
            }
        }
    }
}

ドキュメントストレージサービス

これらのパラメータは、ドキュメントストレージサービスの設定を定義します。

例

"storage": {
    "name": "storage-fs",
    "fs": {
      "folderPath": "",
      "urlExpires": 900,
      "secretString": "verysecretstring"
    },
    "region": "",
    "endpoint": "http://localhost/s3",
    "bucketName": "cache",
    "storageFolderName": "files",
    "cacheFolderName": "data",
    "commandOptions": {
      "s3": {
        "putObject": {},
        "getObject": {},
        "copyObject": {
          "MetadataDirective": "COPY"
        },
        "listObjects": {
          "MaxKeys": 1000
        },
        "deleteObject": {}
      },
      "az": {
        "uploadData": {},
        "uploadStream": {},
        "download": {},
        "syncCopyFromURL": {},
        "listBlobsFlat": {
          "maxPageSize": 1000
        },
        "deleteBlob": {}
      }
    },
    "urlExpires": 604800,
    "accessKeyId": "",
    "secretAccessKey": "",
    "sslEnabled": false,
    "s3ForcePathStyle": true,
    "externalHost": "",
    "useDirectStorageUrls": false
  }

永続ストレージ

これらのパラメーターは、ドキュメントキャッシュファイルストレージと忘れられたファイルやエラーファイルのストレージの設定を分離するために使用される永続ストレージの設定を定義します。 このオブジェクトで指定されていない設定は、ストレージオブジェクトから継承されます。サーバーのアップグレードに便利です。

例

"persistentStorage": {
}

RabbitMQ

これらのパラメータは、RabbitMQメッセージブローカーの設定を定義します。

例

"rabbitmq": {
"url": "amqp://localhost:5672",
"socketOptions": {},
"exchangepubsub": {
    "name": "ds.pubsub",
    "options": {
        "durable": true
    }
},
"queuepubsub": {
    "name": "",
    "options": {
        "autoDelete": true,
        "exclusive": true,
        "arguments": {
            "x-queue-type": "classic"
        }
    }
},
"queueconverttask": {
    "name": "ds.converttask6",
    "options": {
        "durable": true,
        "maxPriority": 6,
        "arguments": {
            "x-queue-type": "classic"
        }
    }
},
"queueconvertresponse": {
    "name": "ds.convertresponse",
    "options": {
        "durable": true,
        "arguments": {
            "x-queue-type": "classic"
        }
    }
},
"exchangeconvertdead": {
    "name": "ds.exchangeconvertdead",
    "options": {
        "durable": true
    }
},
"queueconvertdead": {
    "name": "ds.convertdead",
    "options": {
        "durable": true,
        "arguments": {
            "x-queue-type": "classic"
        }
    }
},
"queuedelayed": {
    "name": "ds.delayed",
    "options": {
        "durable": true,
        "arguments": {
            "x-queue-type": "classic"
        }
    }
}
}

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キャッシュ

これらのパラメーターは、IPフィルターに使用されるDNSキャッシュの設定を定義します。

例

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

OpenPGPプロトコル

これらのパラメーターは、暗号化されたドキュメントを編集する際に使用されるOpenPGPプロトコルの設定を定義します。

例

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

AES-256-GCMアルゴリズム

これらのパラメーターは、ドキュメントのパスワード保護に使用されるAES-256-GCM暗号化アルゴリズムの設定を定義します。

例

"aesEncrypt": {
    "config": {
        "keyByteLength": 32,
        "saltByteLength": 64,
        "initializationVectorByteLength": 16,
        "iterationsByteLength": 5
    },
    "secret": "verysecretstring"
}

ボトルネック

このパラメーターは、ボトルネックの設定を定義します。

例

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

Windowsシステムルート証明書

このパラメーターはWindowsシステムルート証明書の設定を定義します。

例

"win-ca": {
    "inject": "+"
}

WOPI

これらのパラメータはWOPIプロトコルの設定を定義します。

例

"wopi": {
    "enable": false,
    "host": "",
    "htmlTemplate": "../../web-apps/apps/api/wopi",
    "wopiZone": "external-http",
    "favIconUrlWord": "/web-apps/apps/documenteditor/main/resources/img/favicon.ico",
    "favIconUrlCell": "/web-apps/apps/spreadsheeteditor/main/resources/img/favicon.ico",
    "favIconUrlSlide": "/web-apps/apps/presentationeditor/main/resources/img/favicon.ico",
    "favIconUrlPdf": "/web-apps/apps/pdfeditor/main/resources/img/favicon.ico",
    "favIconUrlDiagram": "/web-apps/apps/visioeditor/main/resources/img/favicon.ico",
    "fileInfoBlockList": ["FileUrl"],
    "pdfView": [],
    "pdfEdit": [],
    "forms": [],
    "wordView": [],
    "wordEdit": [],
    "cellView": [],
    "cellEdit": [],
    "slideView": [],
    "slideEdit": [],
    "diagramView": [],
    "diagramEdit": [],
    "publicKey": "",
    "modulus": "",
    "exponent": 65537,
    "privateKey": "",
    "publicKeyOld": "",
    "modulusOld": "",
    "exponentOld": 65537,
    "privateKeyOld": "",
    "refreshLockInterval": "10m",
    "dummy": {
      "enable": false,
      "sampleFilePath": ""
    }
  }

テナント

これらのパラメータは、マルチテナントモードでの作業のためのテナントプロパティを定義します。

例

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

外部リクエスト

これらのパラメータは、外部リクエストの設定を定義します。

例

"externalRequest": {
    "directIfIn" : {
        "allowList": [],
        "jwtToken": true
    },
    "action": {
        "allow": true,
        "blockPrivateIP": true,
        "proxyUrl": "",
        "proxyUser": {
            "username": "",
            "password": ""
        },
        "proxyHeaders": {
        }
    }
}

Document Server サービス

これらのパラメータは、Document Server サービスの設定を定義します。

サーバー

これらのパラメーターはサーバーの構成を定義します。

例

"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",
        "editorStatStorage": "",
        "assemblyFormatAsOrigin": true,
        "newFileTemplate" : "../../document-templates/new",
        "documentFormatsFile": "../../document-formats/onlyoffice-docs-formats.json",
        "downloadFileAllowExt": ["pdf", "xlsx"],
        "tokenRequiredParams": true,
        "forceSaveUsingButtonWithoutChanges": false
    }
}
}

デフォルトリクエスト

これらのパラメーターはデフォルトのリクエスト構成を定義します。

例

"services": {
"CoAuthoring": {
    "requestDefaults": {
        "headers": {
            "User-Agent": "Node.js/6.13",
            "Connection": "Keep-Alive"
        },
        "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;tiff;tif"
        }
    }
}

SQL

これらのパラメータはデータベースの設定を定義します。

例

"services": {
    "CoAuthoring": {
        "sql": {
            "type": "postgres",
            "tableChanges": "doc_changes",
            "tableResult": "task_result",
            "dbHost": "localhost",
            "dbPort": 5432,
            "dbName": "onlyoffice",
            "dbUser": "onlyoffice",
            "dbPass": "onlyoffice",
            "charset": "utf8",
            "connectionlimit": 10,
            "max_allowed_packet": 1048575,
                "pgPoolExtraOptions": {
                "idleTimeoutMillis": 30000,
                "maxLifetimeSeconds": 60000,
                "statement_timeout": 60000,
                "query_timeout": 60000,
                "connectionTimeoutMillis": 60000
            },
            "damengExtraOptions": {
                "columnNameUpperCase": false,
                "columnNameCase": "lower",
                "connectTimeout": 60000,
                "loginEncrypt": false,
                "localTimezone": 0,
                "poolTimeout": 60,
                "socketTimeout": 60000,
                "queueTimeout": 60000
            },
            "oracleExtraOptions": {
                "thin": true,
                "connectTimeout": 60
            },
            "msSqlExtraOptions": {
                "options": {
                    "encrypt": false,
                    "trustServerCertificate": true
                },
                "pool": {
                    "idleTimeoutMillis": 30000
                }
            },
            "mysqlExtraOptions": {
                "connectTimeout": 60000,
                "queryTimeout": 60000
            }
        }
    }
}

Redis

これらのパラメータはRedisの設定を定義します。

例

"services": {
"CoAuthoring": {
    "redis": {
        "name": "redis",
        "prefix": "ds:",
        "host": "127.0.0.1",
        "port": 6379,
        "options": {},
        "optionsCluster": {},
        "iooptions": {
            "lazyConnect": true
        },
        "iooptionsClusterNodes": [],
        "iooptionsClusterOptions": {
            "lazyConnect": true
        }
    }
}
}

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": "150MB"
    }
}
}

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": 3,
            "timeout":{
                "factor": 2,
                "minTimeout": 1000,
                "maxTimeout": 2147483647,
                "randomize": false
            },
            "httpStatus": "429,500-599"
        }
    }
}

ライセンス

これらのパラメーターは、ライセンスの設定を定義します。

例

"license" : {
    "license_file": "",
    "warning_limit_percents": 70,
    "packageType": 1,
    "warning_license_expiration": "30d"
}

コンバーター

これらのパラメータはファイルコンバーターの設定を定義します。

例

"FileConverter": {
    "converter": {
        "maxDownloadBytes": 104857600,
        "downloadTimeout": {
            "connectionAndInactivity": "2m",
            "wholeCycle": "2m"
        },
        "downloadAttemptMaxCount": 3,
        "downloadAttemptDelay": 1000,
        "maxprocesscount": 1,
        "fontDir": "null",
        "presentationThemesDir": "null",
        "x2tPath": "null",
        "docbuilderPath": "null",
        "signingKeyStorePath": "",
        "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"
            }
            }
        ]
    }
}