- Startseite
- Docs
- Installation und Konfiguration
- Installation und Konfiguration
- Docker-Version
- Konfigurieren der ONLYOFFICE Docs Developer Edition
Konfigurieren der ONLYOFFICE Docs Developer Edition
Einleitung
Um die Servereinstellungen von ONLYOFFICE Docs zu ändern, konfigurieren Sie den entsprechenden Parameter in der Konfigurationsdatei von ONLYOFFICE Docs, die Sie unter folgendem Pfad finden:
- Für Linux -
/etc/onlyoffice/documentserver/default.json
- Für Windows -
%ProgramFiles%\ONLYOFFICE\DocumentServer\config\default.json
Wenn Sie es ändern möchten, können Sie die Datei local.json
verwenden, in der alle bearbeiteten Parameter gespeichert werden sollten. Diese Datei befindet sich im selben Verzeichnis wie die Datei default.json
und die gesamte Objektstruktur für die erforderlichen Parameter muss beibehalten werden.
default.json
nicht direkt. Die Standardwerte werden jedes Mal wiederhergestellt, wenn Sie den Docker-Container neu starten oder ONLYOFFICE Docs auf eine neue Version aktualisieren, und alle Ihre Änderungen gehen verloren.Die Standardservereinstellungen werden unten beschrieben.
StatsD
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
statsd.useMetrics | Definiert, ob die StatsD-Metriken für ONLYOFFICE Docs aktiviert sind oder nicht. | boolean | false |
statsd.host | Definiert den Host des StatsD-Servers (Hostname oder IP-Adresse). | string | "localhost" |
statsd.port | Definiert den Port des StatsD-Servers. | string | "8125" |
statsd.prefix | Definiert eine Zeichenfolge, die automatisch am Anfang aller Statistiken hinzugefügt wird. Sie hilft, verschiedene Anwendungen zu unterscheiden, die denselben StatsD-Server verwenden. | string | "ds." |
Diese Parameter definieren die StatsD-Servereigenschaften, die einen Aggregator von Metriken angeben.
Beispiel
"statsd": {
"useMetrics": false,
"host": "localhost",
"port": "8125",
"prefix": "ds."
}
Logger
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
log.filePath | Definiert einen Pfad zur Protokolldatei. | string | "" |
log.options | Definiert die Protokolloptionen. | object | |
log.options.replaceConsole | Definiert, ob die Protokollinformationen auf der Konsole gedruckt werden oder nicht. | boolean | true |
Diese Parameter definieren die Logger-Eigenschaften.
Beispiel
"log": {
"filePath": "",
"options": {
"replaceConsole": true
}
}
Warteschlangen
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
queue.type | Definiert den Message-Broker-Typ. | string | "rabbitmq" |
queue.visibilityTimeout | Definiert das Konvertierungs-Timeout (gemessen in Sekunden). | integer | 300 |
queue.retentionPeriod | Definiert die TTL (Lebensdauer, "time to live") aller Nachrichten in einer Warteschlange (gemessen in Sekunden). | integer | 900 |
Diese Parameter definieren eine Warteschlange von Nachrichten, die vom Nachrichtenbroker empfangen werden.
Beispiel
"queue": {
"type": "rabbitmq",
"visibilityTimeout": 300,
"retentionPeriod": 900
}
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
email.smtpServerConfiguration | Definiert die Grundeinstellungen für die Verbindung zum SMTP-Server. | object | |
email.smtpServerConfiguration.host | Definiert den Hostnamen oder die IP-Adresse des SMTP-Servers. | string | "localhost" |
email.smtpServerConfiguration.port | Definiert den SMTP-Server-Port. | integer | 587 |
email.smtpServerConfiguration.auth | Definiert die Authentifizierungsdaten. | object | |
email.smtpServerConfiguration.auth.user | Definiert den Authentifizierungsbenutzernamen. Bitte beachten Sie, dass ab Version 8.3 die Werte dieses Parameters in den Dateien default.json und local.json unterschiedlich sind. | string | "" |
email.smtpServerConfiguration.auth.pass | Definiert das Authentifizierungskennwort. Bitte beachten Sie, dass ab Version 8.3 die Werte dieses Parameters in den Dateien default.json und local.json unterschiedlich sind. | string | "" |
email.connectionConfiguration | Definiert die technischen Optionen für die Verbindung mit dem SMTP-Server. | object | |
email.connectionConfiguration.disableFileAccess | Definiert, ob die Verwendung von Dateien als Inhalt zulässig ist. Wenn dieser Parameter auf true gesetzt ist, können JSON-Daten aus einer nicht vertrauenswürdigen Quelle nicht als E-Mail verwendet werden. Wenn ein Anhang oder ein Nachrichtenknoten versucht, etwas aus einer Datei abzurufen, gibt das Senden einen Fehler zurück. | boolean | false |
email.connectionConfiguration.disableUrlAccess | Definiert, ob die Verwendung von URLs als Inhalt zulässig ist. | boolean | false |
email.contactDefaults | Definiert die E-Mail-Nachrichteneinstellungen. | object | |
email.contactDefaults.from | Definiert die E-Mail-Adresse des Absenders. Alle E-Mail-Adressen können einfach „sender@server.com“ oder mit dem formatierten Namen „Absendername“ sender@server.com sein. | string | "from@example.com" |
email.contactDefaults.to | Definiert die durch Kommas getrennte Liste oder ein Array von E-Mail-Adressen der Empfänger, die im Feld An: angezeigt werden. | string | "to@example.com" |
Diese Parameter definieren die Einstellungen eines externen Mailservers, der zum Senden von Benachrichtigungen verwendet wird. Zur Verbindung mit dem Mailserver verwenden Sie die nodemailer-Bibliothek. Viele Konfigurationseinstellungen werden direkt an diese Bibliothek übergeben.
Beispiel
"email": {
"smtpServerConfiguration": {
"host": "localhost",
"port": 587,
"auth": {
"user": "",
"pass": ""
}
},
"connectionConfiguration": {
"disableFileAccess": false,
"disableUrlAccess": false
},
"contactDefaults": {
"from": "from@example.com",
"to": "to@example.com"
}
}
Benachrichtigung
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
notification.rules | Definiert die Regeln der Benachrichtigungseinstellungen für vier Benachrichtigungstypen: licenseExpirationWarning, licenseExpirationError, licenseLimitEdit, licenseLimitLiveViewer. | object | |
notification.rules.licenseExpirationWarning | Definiert die Regeln für die Benachrichtigungseinstellungen licenseExpirationWarning. | object | |
notification.rules.licenseExpirationWarning.enable | Definiert, ob die Benachrichtigung licenseExpirationWarning aktiviert ist. Jeder Benachrichtigungstyp muss separat aktiviert werden. | boolean | false |
notification.rules.licenseExpirationWarning.transportType | Definiert die Art des Sendens der Benachrichtigung licenseExpirationWarning. Derzeit ist nur der Typ E-Mail verfügbar. | array of strings | ["email"] |
notification.rules.licenseExpirationWarning.template | Definiert eine Vorlage für den Titel und Text der Benachrichtigung licenseExpirationWarning. | object | |
notification.rules.licenseExpirationWarning.template.title | Definiert eine Vorlage für den Benachrichtigungstitel licenseExpirationWarning. | string | "%s Docs license expiration warning" |
notification.rules.licenseExpirationWarning.template.body | Definiert eine Vorlage für den Benachrichtigungstext licenseExpirationWarning. | string | "Attention! Your license is about to expire on %s.\nUpon reaching this date, you will no longer be entitled to receive personal technical support and install new Docs versions released after this date." |
notification.rules.licenseExpirationWarning.policies | Definiert die Richtlinie zum Senden von licenseExpirationWarning-Benachrichtigungen. | object | |
notification.rules.licenseExpirationWarning.policies.repeatInterval | Definiert den Zeitpunkt, zu dem die Benachrichtigung licenseExpirationWarning gesendet wird (nicht häufiger als der angegebene Zeitraum). | string | "1d" |
notification.rules.licenseExpirationError | Definiert die Regeln für die Benachrichtigungseinstellungen licenseExpirationError. | object | |
notification.rules.licenseExpirationError.enable | Definiert, ob die Benachrichtigung licenseExpirationError aktiviert ist. Jeder Benachrichtigungstyp muss separat aktiviert werden. | boolean | false |
notification.rules.licenseExpirationError.transportType | Definiert die Art des Sendens der Benachrichtigung licenseExpirationError. Derzeit ist nur der Typ E-Mail verfügbar. | array of strings | ["email"] |
notification.rules.licenseExpirationError.template | Definiert eine Vorlage für den Titel und Text der Benachrichtigung licenseExpirationError. | object | |
notification.rules.licenseExpirationError.template.title | Definiert eine Vorlage für den Benachrichtigungstitel licenseExpirationError. | string | "%s Docs license expiration warning" |
notification.rules.licenseExpirationError.template.body | Definiert eine Vorlage für den Benachrichtigungstext licenseExpirationError. | string | "Attention! Your license expired on %s.\nYou are no longer entitled to receive personal technical support and install new Docs versions released after this date.\nPlease contact sales@onlyoffice.com to discuss license renewal." |
notification.rules.licenseExpirationError.policies | Definiert die Richtlinie zum Senden von licenseExpirationError-Benachrichtigungen. | object | |
notification.rules.licenseExpirationError.policies.repeatInterval | Definiert den Zeitpunkt, zu dem die licenseExpirationError-Benachrichtigung gesendet wird (nicht häufiger als der angegebene Zeitraum). | string | "1d" |
notification.rules.licenseLimitEdit | Definiert die Regeln für die Benachrichtigungseinstellungen von licenseLimitEdit. | object | |
notification.rules.licenseLimitEdit.enable | Definiert, ob die licenseLimitEdit-Benachrichtigung aktiviert ist. Jeder Benachrichtigungstyp muss separat aktiviert werden. | boolean | false |
notification.rules.licenseLimitEdit.transportType | Definiert die Art des Versands der licenseLimitEdit-Benachrichtigung. Derzeit ist nur der Typ E-Mail verfügbar. | array of strings | ["email"] |
notification.rules.licenseLimitEdit.template | Definiert eine Vorlage für den Titel und Text der Benachrichtigung licenseLimitEdit. | object | |
notification.rules.licenseLimitEdit.template.title | Definiert eine Vorlage für den Benachrichtigungstitel licenseLimitEdit. | string | "%s Docs license connection limit warning" |
notification.rules.licenseLimitEdit.template.body | Definiert eine Vorlage für den Benachrichtigungstext licenseLimitEdit. | string | "Attention! You have reached %s%% of the %s limit set by your license." |
notification.rules.licenseLimitEdit.policies | Definiert die Richtlinie zum Senden von Benachrichtigungen licenseLimitEdit. | object | |
notification.rules.licenseLimitEdit.policies.repeatInterval | Definiert den Zeitpunkt, zu dem die licenseLimitEdit-Benachrichtigung gesendet wird (nicht öfter als der angegebene Zeitraum). | string | "1d" |
notification.rules.licenseLimitLiveViewer | Definiert die Regeln für die Benachrichtigungseinstellungen von licenseLimitLiveViewer. | object | |
notification.rules.licenseLimitLiveViewer.enable | Definiert, ob die Benachrichtigung licenseLimitLiveViewer aktiviert ist. Jeder Benachrichtigungstyp muss separat aktiviert werden. | boolean | false |
notification.rules.licenseLimitLiveViewer.transportType | Definiert die Art des Sendens der licenseLimitLiveViewer-Benachrichtigung. Derzeit ist nur der Typ E-Mail verfügbar. | array of strings | ["email"] |
notification.rules.licenseLimitLiveViewer.template | Definiert eine Vorlage für den Titel und Text der Benachrichtigung licenseLimitLiveViewer. | object | |
notification.rules.licenseLimitLiveViewer.template.title | Definiert eine Vorlage für den Benachrichtigungstitel licenseLimitLiveViewer. | string | "%s Docs license connection limit warning" |
notification.rules.licenseLimitLiveViewer.template.body | Definiert eine Vorlage für den Benachrichtigungstext licenseLimitLiveViewer. | string | "Attention! You have reached %s%% of the %s limit set by your license." |
notification.rules.licenseLimitLiveViewer.policies | Definiert die Richtlinie zum Senden von licenseLimitLiveViewer-Benachrichtigungen. | object | |
notification.rules.licenseLimitLiveViewer.policies.repeatInterval | Definiert den Zeitpunkt, zu dem die licenseLimitLiveViewer-Benachrichtigung gesendet wird (nicht öfter als der angegebene Zeitraum). | string | "1d" |
Diese Parameter definieren die Benachrichtigungseinstellungen.
Es werden Benachrichtigungen mit folgenden Ereignistypen und Inhalten versendet:
70% of the connection quota (quota of unique users) is exceeded.
License connection limit warning: "Attention! You have reached 70% of the connections limit set by your license."
70 % des Verbindungskontingents (Kontingent eindeutiger Benutzer) sind überschritten.
Warnung zum Lizenzverbindungslimit: „Achtung! Sie haben 70 % des durch Ihre Lizenz festgelegten Verbindungslimits erreicht.“
The connection quota (quota of unique users) is reached.
License connection limit warning: "Attention! You have reached 100% of the connection limit set by your license."
Das Verbindungskontingent (Kontingent an eindeutigen Benutzern) ist erreicht.
Warnung zum Lizenzverbindungslimit: „Achtung! Sie haben 100 % des durch Ihre Lizenz festgelegten Verbindungslimits erreicht.“
30 days before the license expires.
License expiration warning: "Attention! Your license is about to expire on September 8, 2024. Upon reaching this date, you will no longer be entitled to receive personal technical support and install new Docs versions released after this date."
30 Tage vor Ablauf der Lizenz.
Warnung vor Ablauf der Lizenz: „Achtung! Ihre Lizenz läuft am 8. September 2024 ab.“ Nach Erreichen dieses Datums haben Sie keinen Anspruch mehr auf persönlichen technischen Support und die Installation neuer Docs-Versionen, die nach diesem Datum veröffentlicht wurden.
The license has expired.
License connection limit warning: "Attention! Your license expired on September 8, 2024. You are no longer entitled to receive personal technical support and install new Docs versions released after this date. Please contact sales@onlyoffice.com to discuss license renewal."
Die Lizenz ist abgelaufen.
Warnung zum Lizenzverbindungslimit: „Achtung! Ihre Lizenz ist am 8. September 2024 abgelaufen. Sie haben keinen Anspruch mehr auf persönlichen technischen Support und die Installation neuer Docs-Versionen, die nach diesem Datum veröffentlicht wurden. Bitte kontaktieren Sie sales@onlyoffice.com, um die Lizenzverlängerung zu besprechen.“
Diese Benachrichtigungen werden mit der Stufe WARN oder ERROR in das Serverprotokoll geschrieben.
Beispiel
"notification": {
"rules": {
"licenseExpirationWarning": {
"enable": false,
"transportType": [
"email"
],
"template": {
"title": "%s Docs license expiration warning",
"body": "Attention! Your license is about to expire on %s.\nUpon reaching this date, you will no longer be entitled to receive personal technical support and install new Docs versions released after this date."
},
"policies": {
"repeatInterval": "1d"
}
},
"licenseExpirationError": {
"enable": false,
"transportType": [
"email"
],
"template": {
"title": "%s Docs license expiration warning",
"body": "Attention! Your license expired on %s.\nYou are no longer entitled to receive personal technical support and install new Docs versions released after this date.\nPlease contact sales@onlyoffice.com to discuss license renewal."
},
"policies": {
"repeatInterval": "1d"
}
},
"licenseLimitEdit": {
"enable": false,
"transportType": [
"email"
],
"template": {
"title": "%s Docs license connection limit warning",
"body": "Attention! You have reached %s%% of the %s limit set by your license."
},
"policies": {
"repeatInterval": "1h"
}
},
"licenseLimitLiveViewer": {
"enable": false,
"transportType": [
"email"
],
"template": {
"title": "%s Docs license connection limit warning",
"body": "Attention! You have reached %s%% of the live viewer %s limit set by your license."
},
"policies": {
"repeatInterval": "1h"
}
}
}
}
Dokumentenspeicherdienst
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
storage.name | Definiert den Namen des Dokumentenspeicherdienstes. | string | "storage-fs" |
storage.fs | Definiert die Parameter eines fileSystem-Objekts. | object | |
storage.fs.folderPath | Definiert einen Pfad zum Ordner App_Data , in dem alle Dateien gespeichert sind. | string | "" |
storage.fs.urlExpires | Definiert die Zeit, zu der die temporäre URL zum fileSystem-Objekt abläuft (gemessen in Sekunden). | integer | 900 |
storage.fs.secretString | Definiert die geheime Zeichenfolge, die zum Signieren der URL verwendet wird. | string | "verysecretstring" |
storage.region | Definiert eine AWS-Region, in der sich Ihr Amazon-Bucket befindet. | string | "" |
storage.endpoint | Definiert den Endpunkt der S3-AWS-Dokumentspeicherung. | string | "http://localhost/s3" |
storage.bucketName | Definiert einen eindeutigen Speichernamen für S3-AWS-Dokumente. | string | "cache" |
storage.storageFolderName | Definiert den Namen des S3-AWS-Dokumentspeicherordners, in dem alle Dateien gespeichert werden. | string | "files" |
storage.cacheFolderName | Definiert den Cache-Ordnernamen für die Arbeit im Multi-Mandanten-Modus. | string | "data" |
storage.urlExpires | Definiert die Zeit, zu der die URL zum S3-AWS-Dokumentenspeicher abläuft (gemessen in Millisekunden). | integer | 604800 |
storage.accessKeyId | Definiert eine Schlüssel-ID für den Zugriff auf den S3-AWS-Dokumentenspeicher. | string | "AKID" |
storage.secretAccessKey | Definiert einen geheimen Schlüssel für den Zugriff auf den S3-AWS-Dokumentenspeicher. | string | "SECRET" |
storage.sslEnabled | Definiert, ob SSL des S3-AWS-Dokumentenspeichers aktiviert ist oder nicht. | boolean | false |
storage.s3ForcePathStyle | Definiert, ob die Anforderungen an den S3-AWS-Dokumentenspeicher immer die Adressierung im Pfadstil verwenden. | boolean | true |
storage.externalHost | Definiert einen externen Host, der anstelle des in der Anfrage angegebenen Hosts verwendet wird. | string | "" |
Diese Parameter definieren die Konfiguration des Dokumentenspeicherdienstes.
Beispiel
"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": ""
}
Persistenter Speicher
Diese Parameter definieren die Einstellungen des persistenten Speichers, der verwendet wird, um die Einstellungen für die Speicherung der Dokument-Cache-Dateien und die Speicherung der vergessenen und fehlerhaften Dateien zu trennen. Einstellungen, die nicht in diesem Objekt angegeben sind, werden vom Speicherobjekt übernommen. Die Trennung ist für Server-Upgrades praktisch.
Beispiel
"persistentStorage": {
}
RabbitMQ
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
rabbitmq.url | Definiert die RabbitMQ-URL. Bitte beachten Sie, dass ab Version 8.3 die Werte dieses Parameters in den Dateien default.json und local.json unterschiedlich sind. | string | "amqp://localhost:5672" |
rabbitmq.socketOptions | Definiert die RabbitMQ-Socket-Optionen, die an die Socket-Bibliothek (
| object | {} |
rabbitmq.exchangepubsub | Definiert den Publisher Subscriber Exchange Server. | object | |
rabbitmq.exchangepubsub.name | Definiert einen Namen des Publisher-Subscriber-Servers. | string | "ds.pubsub" |
rabbitmq.exchangepubsub.options | Definiert die Einstellungen des Publisher-Subscriber-Servers. | object | |
rabbitmq.exchangepubsub.options.durable | Definiert, ob die Warteschlange einen Neustart des Brokers übersteht. | boolean | true |
rabbitmq.queuepubsub | Definiert die Publisher-Subscriber-Warteschlange. | object | |
rabbitmq.queuepubsub.name | Definiert einen Namen der Publisher-Subscriber-Warteschlange. | string | "" |
rabbitmq.queuepubsub.options | Definiert die Einstellungen der Publisher-Subscriber-Warteschlange. | object | |
rabbitmq.queuepubsub.options.autoDelete | Definiert, ob die Warteschlange gelöscht wird, wenn die Anzahl der Verbraucher auf Null sinkt. | boolean | true |
rabbitmq.queuepubsub.options.exclusive | Definiert, ob die Warteschlange auf die Verbindung beschränkt ist. | boolean | true |
rabbitmq.queuepubsub.options.arguments | Definiert die zusätzlichen Argumente, normalerweise Parameter für eine Art brokerspezifische Erweiterung, z. B. hohe Verfügbarkeit, TTL. | object | |
rabbitmq.queuepubsub.options.arguments.x-queue-type | Definiert einen Wert des Headers x-queue-type, der den Warteschlangentyp angibt. Es können nur klassische Warteschlangen verwendet werden. | string | "classic" |
rabbitmq.queueconverttask | Definiert eine Aufgabenwarteschlange. | object | |
rabbitmq.queueconverttask.name | Definiert einen Namen für die Aufgabenwarteschlange. | string | "ds.converttask6" |
rabbitmq.queueconverttask.options | Definiert die Einstellungen der Aufgabenwarteschlange. | object | |
rabbitmq.queueconverttask.options.durable | Definiert, ob die Warteschlange einen Neustart des Brokers übersteht. | boolean | true |
rabbitmq.queueconverttask.options.maxPriority | Definiert eine Warteschlange Priorität. | integer | 6 |
rabbitmq.queueconverttask.options.arguments | Definiert die zusätzlichen Argumente, normalerweise Parameter für eine Art brokerspezifische Erweiterung, z. B. hohe Verfügbarkeit, TTL. | object | |
rabbitmq.queueconverttask.options.arguments.x-queue-type | Definiert einen Wert des Headers x-queue-type, der den Warteschlangentyp angibt. Mit dieser Einstellung können die Quorum-Warteschlangen festgelegt werden. | string | "classic" |
rabbitmq.queueconvertresponse | Definiert eine Warteschlange von Antworten. | object | |
rabbitmq.queueconvertresponse.name | Definiert einen Namen für die Antwortwarteschlange. | string | "ds.convertresponse" |
rabbitmq.queueconvertresponse.options | Definiert die Einstellungen der Antwortwarteschlange. | object | |
rabbitmq.queueconvertresponse.options.durable | Definiert, ob die Warteschlange einen Neustart des Brokers übersteht. | boolean | true |
rabbitmq.queueconvertresponse.options.arguments | Definiert die zusätzlichen Argumente, normalerweise Parameter für eine Art brokerspezifische Erweiterung, z. B. hohe Verfügbarkeit, TTL. | object | |
rabbitmq.queueconvertresponse.options.arguments.x-queue-type | Definiert einen Wert des Headers x-queue-type, der den Warteschlangentyp angibt. Mit dieser Einstellung können die Quorum-Warteschlangen festgelegt werden. | string | "classic" |
rabbitmq.exchangeconvertdead | Definiert einen Dead-Letter-Austausch. | object | |
rabbitmq.exchangeconvertdead.name | Definiert einen Namen des Dead-Letter-Austauschs. | string | "ds.exchangeconvertdead" |
rabbitmq.exchangeconvertdead.options | Definiert die Einstellungen des Dead-Letter-Austauschs. | object | |
rabbitmq.exchangeconvertdead.options.durable | Definiert, ob die Warteschlange einen Neustart des Brokers übersteht. | boolean | true |
rabbitmq.queueconvertdead | Definiert eine Dead-Letter-Warteschlange. | object | |
rabbitmq.queueconvertdead.name | Definiert einen Namen für die Dead-Letter-Warteschlange. | string | "ds.convertdead" |
rabbitmq.queueconvertdead.options | Definiert die Einstellungen der Dead-Letter-Warteschlange. | object | |
rabbitmq.queueconvertdead.options.durable | Definiert, ob die Warteschlange einen Neustart des Brokers übersteht. | boolean | true |
rabbitmq.queueconvertdead.options.arguments | Definiert die zusätzlichen Argumente, normalerweise Parameter für eine Art brokerspezifische Erweiterung, z. B. hohe Verfügbarkeit, TTL. | object | |
rabbitmq.queueconvertdead.options.arguments.x-queue-type | Definiert einen Wert des Headers x-queue-type, der den Warteschlangentyp angibt. Mit dieser Einstellung können die Quorum-Warteschlangen festgelegt werden. | string | "classic" |
rabbitmq.queuedelayed | Definiert die verzögerte Warteschlange. | object | |
rabbitmq.queuedelayed.name | Definiert einen Namen der verzögerten Warteschlange. | string | "ds.delayed" |
rabbitmq.queuedelayed.options | Definiert die Einstellungen der verzögerten Warteschlange. | object | |
rabbitmq.queuedelayed.options.durable | Definiert, ob die Warteschlange einen Neustart des Brokers übersteht. | boolean | true |
rabbitmq.queuedelayed.options.arguments | Definiert die zusätzlichen Argumente, normalerweise Parameter für eine Art brokerspezifische Erweiterung, z. B. hohe Verfügbarkeit, TTL. | object | |
rabbitmq.queuedelayed.options.arguments.x-queue-type | Definiert einen Wert des Headers x-queue-type, der den Warteschlangentyp angibt. Mit dieser Einstellung können die Quorum-Warteschlangen festgelegt werden. | string | "classic" |
Diese Parameter definieren die RabbitMQ-Nachrichtenbroker-Konfiguration.
Beispiel
"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
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
activemq.connectOptions | Definiert die ActiveMQ-Verbindungsoptionen. | object | |
activemq.connectOptions.port | Definiert einen Port des Servers, mit dem der ActiveMQ-Container verbunden ist. | integer | 5672 |
activemq.connectOptions.host | Definiert einen Host (Hostname oder IP-Adresse) des Servers, mit dem der ActiveMQ-Container verbunden ist. | string | "localhost" |
activemq.connectOptions.reconnect | Definiert, ob das ActiveMQ-Modul automatisch versucht, die Verbindung wiederherzustellen, wenn es getrennt wird (true) oder nicht (false). | boolean | false |
activemq.queueconverttask | Definiert eine Aufgabenwarteschlange. | string | "ds.converttask" |
activemq.queueconvertresponse | Definiert eine Warteschlange mit Antworten. | string | "ds.convertresponse" |
activemq.queueconvertdead | Definiert eine Dead-Letter-Warteschlange. | string | "ActiveMQ.DLQ" |
activemq.queuedelayed | Definiert die verzögerte Warteschlange. | string | "ds.delayed" |
activemq.topicpubsub | Definiert das Publisher Subscriber-Thema. | string | "ds.pubsub" |
Diese Parameter definieren die ActiveMQ-Nachrichtenbroker-Konfiguration.
Beispiel
"activemq": {
"connectOptions": {
"port": 5672,
"host": "localhost",
"reconnect": false
},
"queueconverttask": "ds.converttask",
"queueconvertresponse": "ds.convertresponse",
"queueconvertdead": "ActiveMQ.DLQ",
"queuedelayed": "ds.delayed",
"topicpubsub": "ds.pubsub"
}
DNS-Cache
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
dnscache.enable | Definiert, ob der DNS-Cache aktiviert ist oder nicht. | boolean | true |
dnscache.ttl | Definiert die Zeit, zu der die DNS-Einträge ablaufen (gemessen in Sekunden). | integer | 300 |
dnscache.cachesize | Definiert die Größe des DNS-Cache. | integer | 1000 |
Diese Parameter definieren die Konfiguration des DNS-Cache, der für den IP-Filter verwendet wird.
Beispiel
"dnscache": {
"enable" : true,
"ttl" : 300,
"cachesize" : 1000
}
OpenPGP-Protokoll
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
openpgpjs.config | Definiert die OpenPGP-Protokollkonfiguration. | object | {} |
openpgpjs.encrypt | Definiert die OpenPGP-Verschlüsselungseinstellungen. | object | |
openpgpjs.encrypt.passwords | Definiert ein Passwort, das für die OpenPGP-Verschlüsselung verwendet wird. | array of strings | ["verysecretstring"] |
openpgpjs.decrypt | Definiert die OpenPGP-Entschlüsselungseinstellungen. | object | |
openpgpjs.decrypt.passwords | Definiert ein Passwort, das für die OpenPGP-Entschlüsselung verwendet wird. | array of strings | ["verysecretstring"] |
Diese Parameter definieren die Einstellungen des OpenPGP-Protokolls, das verwendet wird, um das Passwort zu verschlüsseln, wenn ein verschlüsseltes Dokument zum Bearbeiten geöffnet wird.
Beispiel
"openpgpjs": {
"config": {
},
"encrypt": {
"passwords": ["verysecretstring"]
},
"decrypt": {
"passwords": ["verysecretstring"]
}
}
AES-256-GCM-Algorithmus
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
aesEncrypt.config | Definiert die AES-256-GCM-Algorithmuskonfiguration. | object | |
aesEncrypt.config.keyByteLength | Definiert die Schlüssellänge in Bytes. | integer | 32 |
aesEncrypt.config.saltByteLength | Definiert die Salt-Länge in Bytes. | integer | 64 |
aesEncrypt.config.initializationVectorByteLength | Definiert die Länge des Initialisierungsvektors in Bytes. | integer | 16 |
aesEncrypt.config.iterationsByteLength | Definiert die Iterationslänge in Bytes. | integer | 5 |
aesEncrypt.secret | Definiert ein Passwort, das für die AES-256-GCM-Verschlüsselung verwendet wird. | string | "verysecretstring" |
Diese Parameter definieren die Einstellungen des AES-256-GCM-Verschlüsselungsalgorithmus, der zum Kennwortschutz der Dokumente verwendet wird.
Beispiel
"aesEncrypt": {
"config": {
"keyByteLength": 32,
"saltByteLength": 64,
"initializationVectorByteLength": 16,
"iterationsByteLength": 5
},
"secret": "verysecretstring"
}
Bottleneck
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
bottleneck.getChanges | Definiert die Konstruktoroptionen, um Begrenzer zum Bottleneck der Datenbankanforderungen zu generieren. | object | {} |
Dieser Parameter definiert die Bottleneck-Konfiguration.
Beispiel
"bottleneck": {
"getChanges": {
}
}
Windows-Systemstammzertifikate
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
win-ca.inject | Definiert den Injektionsmodus der Windows-Systemstammzertifikate. Das "+" bedeutet, dass eine neue experimentelle Methode zum Installieren von Zertifikaten verwendet wird. | string | "+" |
Dieser Parameter definiert die Einstellungen der Windows-Systemstammzertifikate.
Beispiel
"win-ca": {
"inject": "+"
}
WOPI
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
wopi.enable | Definiert, ob WOPI aktiviert ist oder nicht. | boolean | false |
wopi.host | Definiert den WOPI-Host (Hostname oder IP-Adresse). | string | "" |
wopi.htmlTemplate | Definiert einen Pfad zur WOPI-HTML-Vorlage. | string | "../../web-apps/apps/api/wopi" |
wopi.wopiZone | Definiert eine Zone, die der Document Server verwendet, um den Browser zur WOPI-Anwendung zu navigieren. | string | "external-http" |
wopi.favIconUrlWord | Definiert einen Pfad zum Favicon für den Dokumenteneditor. | string | "/web-apps/apps/documenteditor/main/resources/img/favicon.ico" |
wopi.favIconUrlCell | Definiert einen Pfad zum Favicon für den Tabellenkalkulationseditor. | string | "/web-apps/apps/spreadsheeteditor/main/resources/img/favicon.ico" |
wopi.favIconUrlSlide | Definiert einen Pfad zum Favicon für den Präsentationseditor. | string | "/web-apps/apps/presentationeditor/main/resources/img/favicon.ico" |
wopi.favIconUrlPdf | Definiert einen Pfad zum Favicon für den PDF-Editor. | string | "/web-apps/apps/pdfeditor/main/resources/img/favicon.ico" |
wopi.favIconUrlDiagram | Definiert einen Pfad zum Favicon für den Diagrammeditor. | string | "/web-apps/apps/visioeditor/main/resources/img/favicon.ico" |
wopi.fileInfoBlockList | Definiert eine Liste von WOPI-Dateiinformationsparametern, die blockiert werden, wenn dieses Array an den Browser gesendet wird. Diese Parameter sind jedoch auf dem Server verfügbar. | array of strings | ["FileUrl"] |
wopi.pdfView | Definiert die Dateitypen, die im PDF-Editor angezeigt werden können. | array of strings | ["djvu", "xps", "oxps"] |
wopi.pdfEdit | Definiert die Dateitypen, die im PDF-Editor bearbeitet werden können. | array of strings | ["pdf"] |
wopi.forms | Definiert die Formulardateitypen. | array of strings | ["pdf"] |
wopi.wordView | Definiert die Dateitypen, die im Dokumenteneditor angezeigt werden können. | array of strings | ["doc", "dotm", "dot", "fodt", "ott", "rtf", "mht", "mhtml", "html", "htm", "xml", "epub", "fb2", "sxw", "stw", "wps", "wpt", "pages", "docxf", "oform"] |
wopi.wordEdit | Definiert die Dateitypen, die im Dokumenteneditor bearbeitet werden können. | array of strings | ["docx", "dotx", "docm", "odt", "txt"] |
wopi.cellView | Definiert die Dateitypen, die im Tabellenkalkulationseditor angezeigt werden können. | array of strings | ["xls", "xlsb", "xltm", "xlt", "fods", "ots", "sxc", "xml", "et", "ett", "numbers"] |
wopi.cellEdit | Definiert die Dateitypen, die im Tabellenkalkulationseditor bearbeitet werden können. | array of strings | ["xlsx", "xltx", "xlsm", "ods", "csv"] |
wopi.slideView | Definiert die Dateitypen, die im Präsentationseditor angezeigt werden können. | array of strings | ["ppt", "ppsx", "ppsm", "pps", "potm", "pot", "fodp", "otp", "sxi", "dps", "dpt", "key"] |
wopi.slideEdit | Definiert die Dateitypen, die im Präsentationseditor bearbeitet werden können. | array of strings | ["pptx", "potx", "pptm", "odp"] |
wopi.diagramView | Definiert die Dateitypen, die im Diagrammeditor angezeigt werden können. | array of strings | ["vsdx", "vstx", "vssx", "vsdm", "vstm", "vssm"] |
wopi.diagramEdit | Definiert die Dateitypen, die im Diagrammeditor bearbeitet werden können. | array of strings | [] |
wopi.publicKey | Definiert den öffentlichen Schlüssel, den der Integrator verwendet, um den privaten Schlüssel zu prüfen. Bitte beachten Sie, dass ab Version 8.3 die Werte dieses Parameters in den Dateien default.json und local.json unterschiedlich sind. | string | "" |
wopi.modulus | Definiert das RSA-Modul im Base64-codierten Format, das zum Abrufen des öffentlichen Schlüssels verwendet wird. Bitte beachten Sie, dass ab Version 8.3 die Werte dieses Parameters in den Dateien default.json und local.json unterschiedlich sind. | string | "" |
wopi.exponent | Definiert den RSA-Exponenten im Base64-codierten Format, das zum Abrufen des öffentlichen Schlüssels verwendet wird. | string | 65537 |
wopi.privateKey | Definiert den privaten Schlüssel, der die Document Server-Anfrage signiert. Bitte beachten Sie, dass ab Version 8.3 die Werte dieses Parameters in den Dateien default.json und local.json unterschiedlich sind. | string | "" |
wopi.publicKeyOld | Definiert den alten öffentlichen Schlüssel, mit dem der Integrator den privaten Schlüssel überprüft hat. Bitte beachten Sie, dass ab Version 8.3 die Werte dieses Parameters in den Dateien default.json und local.json unterschiedlich sind. | string | "" |
wopi.modulusOld | Definiert das alte RSA-Modul im Base64-codierten Format, das zum Abrufen des öffentlichen Schlüssels verwendet wurde. Bitte beachten Sie, dass ab Version 8.3 die Werte dieses Parameters in den Dateien default.json und local.json unterschiedlich sind. | string | "" |
wopi.exponentOld | Definiert den alten RSA-Exponenten im Base64-codierten Format, der zum Abrufen des öffentlichen Schlüssels verwendet wurde. | string | 65537 |
wopi.privateKeyOld | Definiert den alten privaten Schlüssel, der die Document Server-Anfrage signiert hat. Bitte beachten Sie, dass ab Version 8.3 die Werte dieses Parameters in den Dateien default.json und local.json unterschiedlich sind. | string | "" |
wopi.refreshLockInterval | Definiert die Intervallzeit in Minuten zum Aktualisieren der Sperre einer Datei durch Zurücksetzen des automatischen Ablaufzeitgebers auf 30 Minuten. | string | "10m" |
wopi.dummy | Definiert die Eigenschaften von Dummy-Handlern für Stresstests. | object | |
wopi.dummy.enable | Definiert, ob die Dummy-Handler aktiviert sind oder nicht. | boolean | false |
wopi.dummy.sampleFilePath | Definiert den Dummy-Pfad zur Beispieldatei. | string | "" |
Diese Parameter definieren die WOPI-Protokollkonfiguration.
Beispiel
"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": ["djvu", "xps", "oxps"],
"pdfEdit": ["pdf"],
"forms": ["pdf"],
"wordView": ["doc", "dotm", "dot", "fodt", "ott", "rtf", "mht", "mhtml", "html", "htm", "xml", "epub", "fb2", "sxw", "stw", "wps", "wpt", "pages", "docxf", "oform"],
"wordEdit": ["docx", "dotx", "docm", "odt", "txt"],
"cellView": ["xls", "xlsb", "xltm", "xlt", "fods", "ots", "sxc", "xml", "et", "ett", "numbers"],
"cellEdit": ["xlsx", "xltx", "xlsm", "ods", "csv"],
"slideView": ["ppt", "ppsx", "ppsm", "pps", "potm", "pot", "fodp", "otp", "sxi", "dps", "dpt", "key"],
"slideEdit": ["pptx", "potx", "pptm", "odp"],<%--
"diagramView": ["vsdx", "vstx", "vssx", "vsdm", "vstm", "vssm"],
"diagramEdit": [],--%>
"publicKey": "",
"modulus": "",
"exponent": 65537,
"privateKey": "",
"publicKeyOld": "",
"modulusOld": "",
"exponentOld": 65537,
"privateKeyOld": "",
"refreshLockInterval": "10m",
"dummy": {
"enable": false,
"sampleFilePath": ""
}
}
Tenants
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
tenants.baseDir | Definiert ein Verzeichnis, das die Dateien begrenzt, auf die von ONLYOFFICE Docs zugegriffen werden kann. | string | "" |
tenants.baseDomain | Definiert den Basisdomänennamen des Mandanten. | string | "" |
tenants.filenameConfig | Definiert den Namen der Konfigurationsdatei im Mandantenordner, die default.json überschreibt. Sie wird im Mehrmandantenmodus verwendet, um die spezifischen Mandanteneinstellungen (WOPI, IP-Filter, JWT-Geheimnis usw.) zu initialisieren. | string | "config.json" |
tenants.filenameSecret | Definiert den Dateinamen .pem, in dem der geheime Schlüssel des Mandanten gespeichert ist. | string | "secret.key" |
tenants.filenameLicense | Definiert den Dateinamen, unter dem die Mandantenlizenz gespeichert ist. | string | "license.lic" |
tenants.defaultTenant | Definiert den Domänennamen des Standardmandanten. | string | "localhost" |
tenants.cache | Definiert die Cache-Eigenschaften zum Lesen der Mehrmandanten-Lizenz und des Geheimnisses. | object | |
tenants.cache.stdTTL | Definiert die TTL (Time to Live) für jedes generierte Cache-Element (gemessen in Sekunden). | integer | 300 |
tenants.cache.checkperiod | Definiert den Zeitraum für das automatische Löschprüfintervall (gemessen in Sekunden). | integer | 60 |
tenants.cache.useClones | Definiert, ob die zwischengespeicherten Variablen geklont werden oder nicht. Bei true wird eine Kopie der zwischengespeicherten Variable erstellt. Bei false wird nur die Referenz gespeichert. | boolean | false |
Diese Parameter definieren die Mandanteneigenschaften für die Arbeit im Mehrmandantenmodus.
Beispiel
"tenants": {
"baseDir" : "",
"baseDomain" : "",
"filenameConfig" : "config.json",
"filenameSecret" : "secret.key",
"filenameLicense" : "license.lic",
"defaultTenant" : "localhost",
"cache": {
"stdTTL": 300,
"checkperiod": 60,
"useClones": false
},
}
Externe Anfrage
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
externalRequest.directIfIn | Definiert die IP-Adressen, die für direkte Anfragen zulässig sind. | object | |
externalRequest.directIfIn.allowList | Definiert eine Liste der IP-Adressen, denen für direkte Anforderungen vertraut wird. | list | [] |
externalRequest.directIfIn.jwtToken | Definiert, ob die vertrauenswürdigen IP-Adressen im JWT sind oder nicht. | boolean | true |
externalRequest.action | Definiert die externen Anforderungsoptionen. | object | |
externalRequest.action.allow | Definiert, ob externe Anfragen zulässig sind oder nicht. | boolean | true |
externalRequest.action.blockPrivateIP | Definiert, ob die private IP-Adresse blockiert wird oder nicht. | boolean | true |
externalRequest.action.proxyUrl | Definiert die Proxy-URL. | string | "" |
externalRequest.action.proxyUser | Definiert die Proxy-Authentifizierungsparameter. | object | |
externalRequest.action.proxyUser.username | Definiert den Benutzernamen für die Proxy-Authentifizierung. | string | "" |
externalRequest.action.proxyUser.password | Definiert das Proxy-Authentifizierungskennwort. | string | "" |
externalRequest.action.proxyHeaders | Definiert die Proxy-Header. | object | {} |
Diese Parameter definieren die Konfiguration der externen Anfragen.
Beispiel
"externalRequest": {
"directIfIn" : {
"allowList": [],
"jwtToken": true
},
"action": {
"allow": true,
"blockPrivateIP": true,
"proxyUrl": "",
"proxyUser": {
"username": "",
"password": ""
},
"proxyHeaders": {
}
}
}
Document Server-Dienste
Diese Parameter definieren die Einstellungen für die Document Server-Dienste.
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
services.CoAuthoring | Definiert die Einstellungen für die Co-Authoring-Bearbeitungssitzung. | object |
Server
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
services.CoAuthoring.server.port | Definiert den Serverport. | integer | 8000 |
services.CoAuthoring.server.workerpercpu | Definiert eine Anzahl von Worker-Threads pro CPU. | integer | 1 |
services.CoAuthoring.server.mode | Definiert den Servermodus. | string | "development" |
services.CoAuthoring.server.limits_tempfile_upload | Definiert eine maximale Größe für alle hochgeladenen temporären Dateien, die von jedem Prozess verwendet werden (gemessen in kB). | integer | 104857600 |
services.CoAuthoring.server.limits_image_size | Definiert eine maximale Größe für alle Bilder, die in jedem Prozess hochgeladen werden (gemessen in kB). | integer | 26214400 |
services.CoAuthoring.server.limits_image_download_timeout | Definiert die Timeout-Eigenschaften für das Herunterladen von Bildern. | object | |
services.CoAuthoring.server.limits_image_download_timeout.connectionAndInactivity | Definiert einen Zeitraum, der zwei Timeouts angibt:
Dieser Parameter wird an das Modul npm gesendet. | string | "2m" |
services.CoAuthoring.server.limits_image_download_timeout.wholeCycle | Definiert den gesamten Anforderungszyklus – einen Zeitraum vom Start des Downloads bis zum vollständigen Download. | string | "2m" |
services.CoAuthoring.server.callbackRequestTimeout | Definiert die Timeout-Eigenschaften für die Rückrufanforderung. | object | |
services.CoAuthoring.server.callbackRequestTimeout.connectionAndInactivity | Definiert einen Zeitraum, der zwei Timeouts angibt:
Dieser Parameter wird an das Modul npm gesendet. | string | "10m" |
services.CoAuthoring.server.callbackRequestTimeout.wholeCycle | Definiert das Timeout des gesamten Anforderungszyklus. | string | "10m" |
services.CoAuthoring.server.healthcheckfilepath | Definiert einen Pfad, an den die Health-Check-Anfragen gesendet werden. | string | "../public/healthcheck.docx" |
services.CoAuthoring.server.savetimeoutdelay | Definiert die Verzögerungszeit für den Konvertierungsstart (gemessen in Millisekunden), nachdem die bearbeitete Datei geschlossen wurde. | integer | 5000 |
services.CoAuthoring.server.edit_singleton | Definiert, ob der Singleton bearbeitet werden kann oder nicht. | boolean | false |
services.CoAuthoring.server.forgottenfiles | Definiert einen Ordnernamen, in dem alle vergessenen Dateien gespeichert werden. | string | "forgotten" |
services.CoAuthoring.server.forgottenfilesname | Definiert einen vergessenen Dateinamen. | string | "output" |
services.CoAuthoring.server.maxRequestChanges | Definiert eine maximale Größe der Anforderungsänderungen. | integer | 20000 |
services.CoAuthoring.server.openProtectedFile | Definiert, ob die passwortgeschützten Dateien geöffnet werden können oder nicht. | boolean | true |
services.CoAuthoring.server.isAnonymousSupport | Legt fest, ob die anonymen Benutzer Zugriff auf den Editor oder den Live-Viewer haben oder nicht. | boolean | true |
services.CoAuthoring.server.editorDataStorage | Definiert die Datenspeicherung des Editors. Die möglichen Werte: "editorDataRedis", "". | string | "editorDataRedis" |
services.CoAuthoring.server.editorStatStorage | Definiert den Editor-Datenspeicher für Lizenzberechnung und Statistiken (lokaler Speicher oder Redis). Die möglichen Werte: "editorDataMemory", "editorDataRedis" oder "". Der Standardwert "" bedeutet, dass der Wert des Parameters editorDataStorage verwendet wird. Dieser Parameter wird hauptsächlich für Sharded-Cluster verwendet. | string | "" |
services.CoAuthoring.server.assemblyFormatAsOrigin | Legt fest, ob die zusammengesetzte Datei im Originalformat gespeichert wird oder nicht. | boolean | true |
services.CoAuthoring.server.newFileTemplate | Definiert einen Pfad zur "neuen" Dateivorlage, wenn eine Datei mit 0 Bytes vom Link zum Öffnen empfangen wurde. | string | "../../document-templates/new" |
services.CoAuthoring.server.downloadFileAllowExt | Definiert Erweiterungen, die über den downloadFile-Handler heruntergeladen werden dürfen. | array of strings | ["pdf", "xlsx"] |
services.CoAuthoring.server.tokenRequiredParams | Definiert, ob die erforderlichen Token-Parameter validiert werden. Dies ist aus Sicherheitsgründen erforderlich. Beispielsweise wird das Konvertierungstoken nicht zum Öffnen eines Dokuments verwendet. | boolean | true |
services.CoAuthoring.server.forceSaveUsingButtonWithoutChanges | Legt fest, ob eine Datei ohne Änderungen durch Klicken auf die Schaltfläche Speichern zwangsweise gespeichert werden kann. | boolean | false |
Diese Parameter definieren die Serverkonfiguration.
Beispiel
"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",
"downloadFileAllowExt": ["pdf", "xlsx"],
"tokenRequiredParams": true,
"forceSaveUsingButtonWithoutChanges": false
}
}
}
Standardanforderung
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
services.CoAuthoring.requestDefault.headers | Definiert die standardmäßigen HTTP-Anforderungsheader. | object | |
services.CoAuthoring.requestDefault.headers.User-Agent | Definiert den standardmäßigen User-Agent-Anforderungsheader. | string | "Node.js/6.13" |
services.CoAuthoring.requestDefault.headers.Connection | Definiert den standardmäßigen Connection-Anforderungsheader. | string | "Keep-Alive" |
services.CoAuthoring.requestDefault.gzip | Definiert, ob der Header Accept-Encoding hinzugefügt wird, um komprimierte Inhaltscodierungen vom Server anzufordern (falls noch nicht vorhanden) und unterstützte Inhaltscodierungen in der Antwort zu decodieren. | boolean | true |
services.CoAuthoring.requestDefault.rejectUnauthorized | Legt fest, ob die Zertifikate vom Document Server überprüft werden oder nicht. | boolean | true |
Diese Parameter definieren die Standard-Anfragekonfiguration.
Beispiel
"services": {
"CoAuthoring": {
"requestDefaults": {
"headers": {
"User-Agent": "Node.js/6.13",
"Connection": "Keep-Alive"
},
"gzip": true,
"rejectUnauthorized": true
}
}
}
Automatisches Assembly
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
services.CoAuthoring.autoAssembly.enable | Legt fest, ob das automatische Zwangsspeichern aktiviert ist oder nicht. | boolean | false |
services.CoAuthoring.autoAssembly.interval | Definiert die Intervallzeit in Minuten zum Einleiten des automatischen Zwangsspeicherns. | string | "5m" |
services.CoAuthoring.autoAssembly.step | Definiert die Verzögerung in Minuten zwischen den Intervallen. | string | "1m" |
Diese Parameter definieren die automatische Zwangsspeichern-Konfiguration.
Beispiel
"services": {
"CoAuthoring": {
"autoAssembly": {
"enable": false,
"interval": "5m",
"step": "1m"
}
}
}
Utils
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
services.CoAuthoring.utils.utils_common_fontdir | Definiert ein Verzeichnis, in dem alle Schriftarten gespeichert werden. | string | "null" |
services.CoAuthoring.utils.utils_fonts_search_patterns | Definiert die Muster für die Suche nach Schriftdateien der entsprechenden Erweiterungen. | string | "*.ttf;*.ttc;*.otf" |
services.CoAuthoring.utils.limits_image_types_upload | Definiert die unterstützten Bildformate zum Hochladen. | string | "jpg;jpeg;jpe;png;gif;bmp;svg;tiff;tif" |
Diese Parameter definieren die utils-Konfiguration.
Beispiel
"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
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
services.CoAuthoring.sql.type | Definiert den Datenbanktyp (mysql , mariadb , mssql , postgres , dameng , oracle ). | string | "postgres" |
services.CoAuthoring.sql.tableChanges | Definiert den Namen der Datenbanktabelle, in der alle Dokumentänderungen gespeichert werden. | string | "doc_changes" |
services.CoAuthoring.sql.tableResult | Definiert den Namen der Datenbanktabelle, in der das Abfrageergebnis gespeichert wird. | string | "task_result" |
services.CoAuthoring.sql.dbHost | Definiert den Host des Datenbankservers (Hostname oder IP-Adresse). | string | "localhost" |
services.CoAuthoring.sql.dbPort | Definiert den Port des Datenbankservers. | integer | 5432 |
services.CoAuthoring.sql.dbName | Definiert einen Namen einer Datenbank, die beim Start des Abbilds erstellt werden soll. | string | "onlyoffice" |
services.CoAuthoring.sql.dbUser | Definiert einen neuen Benutzernamen mit Superuser-Berechtigungen für das Datenbankkonto. | string | "onlyoffice" |
services.CoAuthoring.sql.dbPass | Definiert ein für das Datenbankkonto festgelegtes Kennwort. | string | "onlyoffice" |
services.CoAuthoring.sql.charset | Definiert den Datenbank-Zeichensatz. | string | "utf8" |
services.CoAuthoring.sql.connectionlimit | Definiert die maximale Anzahl gleichzeitiger Benutzerverbindungen zum Datenbankserver. | integer | 10 |
services.CoAuthoring.sql.max_allowed_packet | Definiert die maximale Datengröße, die in einer Anfrage gesendet werden kann. | integer | 1048575 |
services.CoAuthoring.sql.pgPoolExtraOptions | Definiert die Parameter, die direkt an Node-Postgres-Pool-Bibliothek übergeben werden können. | object | |
services.CoAuthoring.sql.pgPoolExtraOptions.idleTimeoutMillis | Definiert die Anzahl der Millisekunden, die ein Client im Pool inaktiv bleiben muss und nicht ausgecheckt werden darf, bevor er vom Backend getrennt und verworfen wird. Setzen Sie den Wert auf 0, um die automatische Trennung inaktiver Clients zu deaktivieren. | integer | 30000 |
services.CoAuthoring.sql.pgPoolExtraOptions.maxLifetimeSeconds | Definiert eine Anzahl von Sekunden, die die maximale Lebensdauer darstellt. | integer | 60000 |
services.CoAuthoring.sql.pgPoolExtraOptions.statement_timeout | Definiert eine Anzahl von Millisekunden, bevor die Abfrageanweisung abläuft. | integer | 60000 |
services.CoAuthoring.sql.pgPoolExtraOptions.query_timeout | Definiert eine Anzahl von Millisekunden, bevor ein Abfrageaufruf abläuft. | integer | 60000 |
services.CoAuthoring.sql.pgPoolExtraOptions.connectionTimeoutMillis | Definiert die Anzahl der Millisekunden, die auf eine Verbindung gewartet werden soll. | integer | 60000 |
services.CoAuthoring.sql.damengExtraOptions | Definiert die Dameng-Datenbankparameter. | object | |
services.CoAuthoring.sql.damengExtraOptions.columnNameUpperCase | Definiert, ob die Spaltennamen in Großbuchstaben geschrieben sind oder nicht. | boolean | false |
services.CoAuthoring.sql.damengExtraOptions.columnNameCase | Definiert die Groß-/Kleinschreibung von Spaltennamen. | string | "lower" |
services.CoAuthoring.sql.damengExtraOptions.connectTimeout | Definiert die Anzahl der Millisekunden, die auf eine Verbindung gewartet werden soll. | integer | 60000 |
services.CoAuthoring.sql.damengExtraOptions.loginEncrypt | Definiert, ob die Login-Verschlüsselung aktiviert ist oder nicht. | boolean | false |
services.CoAuthoring.sql.damengExtraOptions.localTimezone | Definiert die lokale Zeitzone. | integer | 0 |
services.CoAuthoring.sql.damengExtraOptions.poolTimeout | Definiert eine Anzahl von Sekunden, nach denen der Pool inaktive Verbindungen (im Pool nicht verwendete Verbindungen) beendet. | integer | 60 |
services.CoAuthoring.sql.damengExtraOptions.socketTimeout | Definiert eine Anzahl von Millisekunden, wenn eine Verbindungsanforderung eines Clients oder Servers keine Antwort vom anderen Ende erhält. | integer | 60000 |
services.CoAuthoring.sql.damengExtraOptions.queueTimeout | Definiert eine Anzahl von Millisekunden, wie lange Nachrichten in der Warteschlange verbleiben, bevor sie verworfen werden. | integer | 60000 |
services.CoAuthoring.sql.oracleExtraOptions | Definiert die Oracle-Datenbankparameter. | object | |
services.CoAuthoring.sql.oracleExtraOptions.connectTimeout | Definiert die Anzahl an Sekunden, die auf eine Verbindung gewartet werden soll. | integer | 60 |
services.CoAuthoring.sql.msSqlExtraOptions | Definiert die MS SQL-Datenbankparameter. | object | |
services.CoAuthoring.sql.msSqlExtraOptions.options | Definiert die MS SQL-Datenbankoptionen. | object | |
services.CoAuthoring.sql.msSqlExtraOptions.options.encrypt | Definiert, ob die Daten vor dem Senden über das Netzwerk verschlüsselt werden. | boolean | false |
services.CoAuthoring.sql.msSqlExtraOptions.options.trustServerCertificate | Legt fest, ob eine Verschlüsselung erfolgt, wenn kein verifiziertes Server-Zertifikat vorliegt. | boolean | true |
services.CoAuthoring.sql.msSqlExtraOptions.pool | Definiert die Parameter des Verbindungspools. | object | |
services.CoAuthoring.sql.msSqlExtraOptions.pool.idleTimeoutMillis | Definiert die Anzahl der Millisekunden, die ein Client im Pool inaktiv bleiben muss und nicht ausgecheckt werden darf, bevor er vom Backend getrennt und verworfen wird. Setzen Sie den Wert auf 0, um die automatische Trennung inaktiver Clients zu deaktivieren. | integer | 30000 |
services.CoAuthoring.sql.mysqlExtraOptions | Definiert die Verbindungsparameter der MySQL-Datenbank (einschließlich SSL-Einstellungen), die direkt an das Modul node-mysql2 übergeben werden können. | object | |
services.CoAuthoring.sql.mysqlExtraOptions.connectTimeout | Definiert die Anzahl der Millisekunden, die auf eine Verbindung gewartet werden soll. | integer | 60000 |
services.CoAuthoring.sql.mysqlExtraOptions.queryTimeout | Definiert eine Anzahl von Millisekunden, bevor ein Abfrageaufruf abläuft. | integer | 60000 |
Diese Parameter definieren die Datenbankkonfiguration.
Beispiel
"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": {
"connectTimeout": 60
},
"msSqlExtraOptions": {
"options": {
"encrypt": false,
"trustServerCertificate": true
},
"pool": {
"idleTimeoutMillis": 30000
}
},
"mysqlExtraOptions": {
"connectTimeout": 60000,
"queryTimeout": 60000
}
}
}
}
Redis
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
services.CoAuthoring.redis.name | Definiert den Datenbanknamen, "redis" oder "ioredis" . | string | "redis" |
services.CoAuthoring.redis.prefix | Definiert das Namenspräfix für alle in Redis verwendeten Strukturen. | string | "ds:" |
services.CoAuthoring.redis.host | Definiert den Redis-Server-Host (Hostname oder IP-Adresse). | string | "127.0.0.1" |
services.CoAuthoring.redis.port | Definiert den Redis-Server-Port. | integer | 6379 |
services.CoAuthoring.redis.options | Definiert die Parameter (Benutzername, Passwort, Module usw.), die direkt an die Bibliothek node-redis createClient übergeben werden können. | object | {} |
services.CoAuthoring.redis.optionsCluster | Definiert die Parameter (rootNodes, Defaults, Module usw.), die direkt an die Node-Redis Clustering-Bibliothek übergeben werden können, um eine Verbindung zum Redis-Cluster herzustellen. Diese Einstellung hat Vorrang vor dem Parameter Optionen für die Verbindung zum einzelnen Redis. | object | {} |
services.CoAuthoring.redis.iooptions | Definiert die Parameter (Benutzername, Passwort, Module usw.), die direkt an die Bibliothek ioredis RedisOptions übergeben werden können. | object | |
services.CoAuthoring.redis.iooptions.lazyConnect | Definiert, ob die Verbindung zum Server verzögert wird, bis der erste Befehl gesendet wird oder redis.connect() explizit aufgerufen wird. | boolean | true |
services.CoAuthoring.redis.iooptionsClusterNodes | Definiert eine Liste der Knoten des Clusters, mit dem Sie sich verbinden möchten. Diese können direkt an die Bibliothek ioredis cluster übergeben werden, um eine Verbindung zum Redis-Cluster herzustellen. Diese Einstellung hat Vorrang vor dem Parameter iooptions für die Verbindung zum einzelnen Redis. | array | [] |
services.CoAuthoring.redis.iooptionsClusterOptions | Definiert die Parameter (clusterRetryStrategy, dnsLookup, scaleReads usw.), die direkt an die ioredis-Cluster-Bibliothek übergeben werden können, um eine Verbindung zum Redis-Cluster herzustellen. Diese Einstellung hat Vorrang vor dem Parameter iooptions für die Verbindung zum einzelnen Redis. | object | |
services.CoAuthoring.redis.iooptionsClusterOptions.lazyConnect | Definiert, ob die Verbindung zum Server verzögert wird, bis der erste Befehl gesendet wird oder redis.connect() explizit aufgerufen wird. | boolean | true |
Diese Parameter definieren die Redis-Konfiguration.
Beispiel
"services": {
"CoAuthoring": {
"redis": {
"name": "redis",
"prefix": "ds:",
"host": "127.0.0.1",
"port": 6379,
"options": {},
"optionsCluster": {},
"iooptions": {
"lazyConnect": true
},
"iooptionsClusterNodes": [],
"iooptionsClusterOptions": {
"lazyConnect": true
}
}
}
}
PubSub-Service
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
services.CoAuthoring.pubsub.maxChanges | Definiert die maximale Größe von Änderungen, die über PubSub weitergegeben werden können. Wenn die Größe den angegebenen Wert überschreitet, werden die Änderungen aus der Datenbank gelesen. | integer | 1000 |
Dieser Parameter definiert die PubSub-Dienstkonfiguration.
Beispiel
"services": {
"CoAuthoring": {
"pubsub": {
"maxChanges": 1000
}
}
}
Ablauf
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
services.CoAuthoring.expire.saveLock | Definiert die Zeit zum Speichern von Sperren. | integer | 60 |
services.CoAuthoring.expire.presence | Definiert die Lebensdauer für den Anwesenheitsstatus des Benutzers. | integer | 300 |
services.CoAuthoring.expire.locks | Definiert die Lebensdauer der Sperren. | integer | 604800 |
services.CoAuthoring.expire.changeindex | Definiert die Zeit zum Ändern von Indizes. | integer | 86400 |
services.CoAuthoring.expire.lockDoc | Definiert die Zeit zum Sperren von Dokumenten. | integer | 30 |
services.CoAuthoring.expire.message | Definiert die Lebensdauer für die Nachrichten. | integer | 86400 |
services.CoAuthoring.expire.lastsave | Definiert die Lebensdauer für die letzte erfolgreich ausgeführte Datenbankspeicherung. | integer | 604800 |
services.CoAuthoring.expire.forcesave | Definiert die Lebenszeit für das erfolgreich durchgeführte Zwangsspeichern. | integer | 604800 |
services.CoAuthoring.expire.forcesaveLock | Definiert die Lebensdauer der erzwungenen Sperren im ioredis-Clustermodus. | integer | 5000 |
services.CoAuthoring.expire.saved | Definiert die Lebensdauer für die erfolgreich ausgeführte Datenbanksicherung. | integer | 3600 |
services.CoAuthoring.expire.documentsCron | Definiert die Startzeit der Überprüfung, während der alte Dateien aus dem Cache gelöscht werden (standardmäßig alle zwei Stunden). | string | "0 */2 * * * *" |
services.CoAuthoring.expire.files | Definiert die Lebensdauer für die Ordner in App_Data . | integer | 86400 |
services.CoAuthoring.expire.filesCron | Definiert die Startzeit der Überprüfung (standardmäßig jeden Tag um Mitternacht). | string | "00 00 */1 * * *" |
services.CoAuthoring.expire.filesremovedatonce | Definiert die Anzahl gleichzeitig gelöschter Dokumentenordner aus dem Cache. | integer | 100 |
services.CoAuthoring.expire.sessionidle | Definiert die Lebensdauer der inaktiven Sitzung. Dieser Parameter ermöglicht das Beenden der Bearbeitungssitzung für einen inaktiven Benutzer. Der Parameter wird auch verwendet, um das Dokumentspeicherverfahren zu initialisieren, indem die letzte Editiersitzung beendet wird. Er definiert also die Zeit, nach der ein inaktiver Benutzer von der Bearbeitungssitzung getrennt wird. Sein Werteformat ist "1s", "1m", "1h", "1d" usw. Bitte beachten Sie, dass wir als Inaktivität das Fehlen jeglicher Aktion im Editor meinen, einschließlich der Cursorbewegung. | string | "1h" |
services.CoAuthoring.expire.sessionabsolute | Definiert die Lebensdauer für jede Bearbeitungssitzung. | string | "30d" |
services.CoAuthoring.expire.sessionclosecommand | Definiert die Zeit, bevor die sessionidle oder sessionabsolute ttl abläuft, wenn eine Warnmeldung gesendet wird. | string | "2m" |
services.CoAuthoring.expire.pemStdTTL | Definiert die Lebensdauer für die PEM-Dateien mit Geheimnissen. | string | "1h" |
services.CoAuthoring.expire.pemCheckPeriod | Definiert die Zeit für die Überprüfung der PEM-Dateien ttl. | string | "10m" |
services.CoAuthoring.expire.updateVersionStatus | Definiert den Zeitpunkt, zu dem der Benutzer die Datei erneut öffnen kann, nachdem ein Fehler aufgrund des Öffnens einer bereits gespeicherten Datei mit dem alten Schlüssel aufgetreten ist. | string | "5m" |
services.CoAuthoring.expire.monthUniqueUsers | Definiert die Lebensdauer für die Liste der eindeutigen Benutzer des Monats. | string | "1y" |
Diese Parameter definieren die Ablaufeinstellungen.
Beispiel
"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-Filter
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
services.CoAuthoring.ipfilter.rules | Definiert die IP-Filterregeln, die die folgenden Parameter enthalten:
| Array von Objekten | |
services.CoAuthoring.ipfilter.useforrequest | Definiert, ob der IP-Filter für die Anfrage verwendet wird oder nicht. | boolean | false |
services.CoAuthoring.ipfilter.errorcode | Definiert einen Fehlercode für den IP-Filter. | integer | 403 |
Diese Parameter definieren die IP-Filterkonfiguration.
Beispiel
"services": {
"CoAuthoring": {
"ipfilter": {
"rules": [{"address": "*", "allowed": true}],
"useforrequest": false,
"errorcode": 403
}
}
}
Request Filtering Agent
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
services.CoAuthoring.request-filtering-agent.allowPrivateIPAddress | Definiert, ob es erlaubt ist, eine private IP-Adresse zu verbinden oder nicht. Dazu gehören private IP-Adressen und reservierte IP-Adressen. | boolean | false |
services.CoAuthoring.request-filtering-agent.allowMetaIPAddress | Definiert, ob es erlaubt ist, eine Meta-IP-Adresse zu verbinden oder nicht. Die Meta-Adresse kann 0.0.0.0 (IPv4) oder :: (IPv6) sein – eine Meta-Adresse, die eine andere Adresse weiterleitet. | boolean | false |
Diese Parameter definieren die Konfiguration des Request Filtering Agents.
Beispiel
"services": {
"CoAuthoring": {
"request-filtering-agent" : {
"allowPrivateIPAddress": false,
"allowMetaIPAddress": false
}
}
}
Geheimer Schlüssel
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
services.CoAuthoring.secret.browser | Definiert die Parameter eines geheimen Schlüssels zum Generieren eines Tokens in den clientseitigen Browseranforderungen an ONLYOFFICE Docs:
| object | |
services.CoAuthoring.secret.inbox | Definiert die Parameter eines geheimen Schlüssels zum Generieren eines Tokens in den eingehenden HTTP-Anforderungen mit den Befehlen vom Dokumentspeicherdienst zum Dokumentbefehlsdienst, Dokumentkonvertierungsdienst und Dokumenterstellungsdienst:
| object | |
services.CoAuthoring.secret.outbox | Definiert die Parameter eines geheimen Schlüssels zum Generieren eines Tokens in den ausgehenden HTTP-Anforderungen an die
| object | |
services.CoAuthoring.secret.session | Definiert die Parameter eines geheimen Schlüssels zum Generieren des Sitzungstokens:
| object |
Diese Parameter definieren die geheime Schlüsselkonfiguration.
Beispiel
"services": {
"CoAuthoring": {
"secret": {
"browser": {"string": "secret", "file": ""},
"inbox": {"string": "secret", "file": ""},
"outbox": {"string": "secret", "file": ""},
"session": {"string": "secret", "file": ""}
}
}
}
Token
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
services.CoAuthoring.token.enable | Definiert, ob die Token aktiviert sind oder nicht. | object | |
services.CoAuthoring.token.enable.browser | Definiert, ob ein Token in den clientseitigen Browseranforderungen aktiviert ist oder nicht. | boolean | false |
services.CoAuthoring.token.enable.request | Definiert, ob die Token in den HTTP-Anforderungen aktiviert sind oder nicht. | object | |
services.CoAuthoring.token.enable.request.inbox | Definiert, ob ein Token in den eingehenden HTTP-Anforderungen aktiviert ist oder nicht. | boolean | false |
services.CoAuthoring.token.enable.request.outbox | Definiert, ob ein Token in den ausgehenden HTTP-Anfragen aktiviert ist oder nicht. | boolean | false |
services.CoAuthoring.token.browser | Definiert die Browser-Token-Konfiguration. | object | |
services.CoAuthoring.token.browser.secretFromInbox | Definiert, ob das Browser-Token mit dem Token der eingehenden Anfragen übereinstimmt (true ) oder nicht (false ). | boolean | true |
services.CoAuthoring.token.inbox | Definiert die Konfiguration eines Tokens aus den eingehenden Anfragen. | object | |
services.CoAuthoring.token.inbox.header | Definiert den HTTP-Header, der zum Senden des eingehenden Anforderungstokens verwendet wird. | string | "Authorization" |
services.CoAuthoring.token.inbox.prefix | Definiert ein Präfix im HTTP-Header, das zum Senden des eingehenden Anforderungstokens verwendet wird. | string | "Bearer " |
services.CoAuthoring.token.inbox.inBody | Definiert, ob ein Token im eingehenden Anforderungstext aktiviert ist oder nicht. | boolean | false |
services.CoAuthoring.token.outbox | Definiert die Konfiguration eines Tokens aus den ausgehenden Anfragen. | object | |
services.CoAuthoring.token.outbox.header | Definiert den HTTP-Header, der zum Senden des ausgehenden Anforderungstokens verwendet wird. | string | "Authorization" |
services.CoAuthoring.token.outbox.prefix | Definiert ein Präfix im HTTP-Header, das zum Senden des ausgehenden Anforderungstokens verwendet wird. | string | "Bearer " |
services.CoAuthoring.token.outbox.algorithm | Definiert einen Algorithmus, der zum Signieren des ausgehenden Anforderungstokens verwendet wird. | string | "HS256" |
services.CoAuthoring.token.outbox.expires | Definiert einen Zeitraum, in dem das ausgehende Anforderungstoken abläuft. | string | "5m" |
services.CoAuthoring.token.outbox.inBody | Definiert, ob ein Token im Text der ausgehenden Anfrage aktiviert ist oder nicht. | boolean | false |
services.CoAuthoring.token.outbox.urlExclusionRegex | Definiert den regulären Ausdruck, der URLs angibt, von denen die Autorisierung ausgeschlossen werden soll. Die leere Zeichenfolge bedeutet, dass diese Option deaktiviert ist. | string | "" |
services.CoAuthoring.token.session | Definiert die Konfiguration des Sitzungstokens. | object | |
services.CoAuthoring.token.session.algorithm | Definiert einen Algorithmus, der zum Signieren des Sitzungstokens verwendet wird. | string | "HS256" |
services.CoAuthoring.token.session.expires | Definiert einen Zeitraum, in dem das Sitzungstoken abläuft. | string | "30d" |
services.CoAuthoring.token.verifyOptions | Definiert die Token-Überprüfungsoptionen. | object | |
services.CoAuthoring.token.verifyOptions.clockTolerance | Definiert eine Anzahl von Sekunden, die akzeptabel ist, wenn es um die Zeitunterschiede zwischen verschiedenen Servern geht. | integer | 60 |
Diese Parameter definieren die Tokenkonfiguration.
Beispiel
"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
}
}
}
}
Plugins
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
services.CoAuthoring.plugins.uri | Definiert einen Pfad zu dem Ordner, in dem alle Plugins gespeichert sind. | string | "/sdkjs-plugins" |
services.CoAuthoring.plugins.autostart | Definiert eine Liste von Plugins, die automatisch ausgeführt werden. | list | [] |
Diese Parameter definieren die Plugin-Konfiguration.
Beispiel
"services": {
"CoAuthoring": {
"plugins": {
"uri": "/sdkjs-plugins",
"autostart": []
}
}
}
Themen
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
services.CoAuthoring.themes.uri | Definiert einen Pfad zu dem Ordner, in dem alle json-Dateien mit den benutzerdefinierten Farbdesigns gespeichert sind. | string | "/web-apps/apps/common/main/resources/themes" |
Dieser Parameter definiert die Eigenschaften der benutzerdefinierten Farbthemen.
Beispiel
"services": {
"CoAuthoring": {
"themes": {
"uri": "/web-apps/apps/common/main/resources/themes"
}
}
}
Editor
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
services.CoAuthoring.editor.spellcheckerUrl | Definiert einen Pfad zur Rechtschreibprüfung. | string | "" |
services.CoAuthoring.editor.reconnection | Definiert die Einstellungen für die Wiederverbindung des Editors mit dem Server. | object | |
services.CoAuthoring.editor.reconnection.attempts | Definiert eine maximale Anzahl von Versuchen, den Editor wieder zu verbinden. | integer | 50 |
services.CoAuthoring.editor.reconnection.delay | Definiert die Versuchsverzögerung für die Wiederverbindung des Editors. | string | "2s" |
services.CoAuthoring.editor.binaryChanges | Definiert, ob die Dokumentänderungen im Binärformat (true) oder JSON-Format (false) gespeichert werden. | boolean | false |
services.CoAuthoring.editor.websocketMaxPayloadSize | Definiert eine maximale Nutzlastgröße von WebSocket. | string | "1.5MB" |
services.CoAuthoring.editor.maxChangesSize | Definiert einen Grenzwert für die Gesamtgröße der am Dokument vorgenommenen Änderungen. Bei Überschreitung des Limits erhält der Benutzer ein Dialogfenster mit dem Vorschlag, die letzte Aktion abzubrechen oder in den Offline-Modus zu wechseln. Diese Einstellung ist standardmäßig deaktiviert. | string | "150MB" |
Diese Parameter definieren die Editorkonfiguration.
Beispiel
"services": {
"CoAuthoring": {
"editor":{
"spellcheckerUrl": "",
"reconnection":{
"attempts": 50,
"delay": "2s"
},
"binaryChanges": false,
"websocketMaxPayloadSize": "1.5MB",
"maxChangesSize": "150MB"
}
}
}
SockJs
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
services.CoAuthoring.sockjs.sockjs_url | Definiert einen Pfad zur Datei sockjs.min.js . | string | "" |
services.CoAuthoring.sockjs.disable_cors | Definiert, ob CORS deaktiviert wird oder nicht. Der Wert true verhindert die Sicherheitslücke im Header Access-Control-Allow-Origin. | boolean | true |
services.CoAuthoring.sockjs.websocket | Definiert, ob das WebSocket-Protokoll aktiviert ist oder nicht. | boolean | true |
Diese Parameter definieren die SockJs-Konfiguration.
Beispiel
"services": {
"CoAuthoring": {
"sockjs": {
"sockjs_url": "",
"disable_cors": true,
"websocket": true
}
}
}
Socket.IO
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
services.CoAuthoring.socketio.connection | Definiert die Verbindungseigenschaften. | object | |
services.CoAuthoring.socketio.connection.path | Definiert den Pfad, der serverseitig erfasst wird. | string | "/doc/" |
services.CoAuthoring.socketio.connection.serveClient | Definiert, ob die Clientdateien bereitgestellt werden oder nicht. | boolean | false |
services.CoAuthoring.socketio.connection.pingTimeout |
Definiert den Timeout-Zeitraum in Millisekunden, innerhalb dessen der Client mit einem Pong auf den Server-Ping antworten muss.
Erfolgt keine Antwort, geht der Server davon aus, dass die Verbindung geschlossen ist.
Die Verbindung zwischen dem Server und dem Client wird alle pingInterval Millisekunden überprüft.
| integer | 20000 |
services.CoAuthoring.socketio.connection.pingInterval |
Definiert die Intervallzeit in Millisekunden, mit der überprüft wird, ob die Verbindung zwischen dem Server und dem Client noch besteht.
Der Server sendet ein Ping-Paket an den Client. Wenn der Client nicht innerhalb des pingTimeout -Zeitraums mit einem Pong antwortet,
der Server geht davon aus, dass die Verbindung geschlossen ist.
| integer | 25000 |
services.CoAuthoring.socketio.connection.maxHttpBufferSize | Definiert die maximale Anzahl von Bytes, die eine einzelne Nachricht umfassen kann, bevor der Socket geschlossen wird. | integer | 1e8 |
Diese Parameter definieren die Socket.IO-Modulkonfiguration.
Beispiel
"socketio": {
"connection": {
"path": "/doc/",
"serveClient": false,
"pingTimeout": 20000,
"pingInterval": 25000,
"maxHttpBufferSize": 1e8
}
}
Callback-Backoff-Optionen
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
services.CoAuthoring.callbackBackoffOptions.retries | Definiert die maximale Anzahl von Wiederholungen des Vorgangs. | integer | 0 |
services.CoAuthoring.callbackBackoffOptions.timeout | Definiert die Callback-Backoff-Timeouts. | object | |
services.CoAuthoring.callbackBackoffOptions.timeout.factor | Definiert den zu verwendenden Exponentialfaktor. | integer | 2 |
services.CoAuthoring.callbackBackoffOptions.timeout.minTimeout | Definiert die Anzahl der Millisekunden vor dem Start des ersten Versuchs. | integer | 1000 |
services.CoAuthoring.callbackBackoffOptions.timeout.maxTimeout | Definiert die maximale Anzahl von Millisekunden zwischen zwei Wiederholungen. | integer | 2147483647 |
services.CoAuthoring.callbackBackoffOptions.timeout.randomize | Legt fest, ob die Timeouts durch Multiplikation mit einem Faktor zwischen 1 bis 2 randomisiert werden oder nicht. | boolean | false |
services.CoAuthoring.callbackBackoffOptions.httpStatus | Definiert die HTTP-Status des Callback-Backoffs. | string | "429,500-599" |
Diese Parameter definieren die Callback-Backoff-Optionen.
Beispiel
"services": {
"CoAuthoring": {
"callbackBackoffOptions": {
"retries": 0,
"timeout":{
"factor": 2,
"minTimeout": 1000,
"maxTimeout": 2147483647,
"randomize": false
},
"httpStatus": "429,500-599"
}
}
}
Lizenz
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
license.license_file | Definiert einen Pfad zur Lizenzdatei. | string | "" |
license.warning_limit_percents | Definiert einen Prozentbereich der connections und connections_view, bei dessen Überschreitung in den Protokollen eine Warnung bezüglich der Lizenzbeschränkung angezeigt wird. | integer | 70 |
license.packageType | Definiert den Lizenzpakettyp: 2 – Developer Edition. Dieser Parameter wird beim Erstellen der Version festgelegt. Sie müssen ihn nicht manuell konfigurieren. | integer | 2 |
license.warning_license_expiration | Definiert die Zeit vor Ablauf der Lizenz, wenn eine Warnmeldung gesendet wird. | string | "30d" |
Diese Parameter definieren die Lizenzkonfiguration.
Beispiel
"license" : {
"license_file": "",
"warning_limit_percents": 70,
"packageType": 2,
"warning_license_expiration": "30d"
}
Konverter
Parameter | Beschreibung | Typ | Standard |
---|---|---|---|
FileConverter.converter | Definiert die Konvertereigenschaften. | object | |
FileConverter.converter.maxDownloadBytes | Definiert eine maximale Größe der angeforderten Datei (gemessen in Byte). | integer | 104857600 |
FileConverter.converter.downloadTimeout | Definiert die Timeout-Eigenschaften für das Herunterladen der konvertierten Datei. | object | |
FileConverter.converter.downloadTimeout.connectionAndInactivity | Definiert einen Zeitraum, der zwei Timeouts angibt:
Dieser Parameter wird an das Modul npm gesendet. | string | "2m" |
FileConverter.converter.downloadTimeout.wholeCycle | Definiert das Timeout des gesamten Anforderungszyklus. | string | "2m" |
FileConverter.converter.downloadAttemptMaxCount | Definiert eine maximale Anzahl von Versuchen, die konvertierte Datei herunterzuladen. | integer | 3 |
FileConverter.converter.downloadAttemptDelay | Definiert die Versuchsverzögerung, die konvertierte Datei herunterzuladen. | integer | 1000 |
FileConverter.converter.maxprocesscount | Definiert eine maximale Anzahl von Konvertierungsprozessen, die gleichzeitig aktiv sein können. | integer | 1 |
FileConverter.converter.fontDir | Definiert einen Pfad zum Ordner mit Schriftarten. | string | "null" |
FileConverter.converter.presentationThemesDir | Definiert einen Pfad zum Ordner mit den Präsentationsthemen. | string | "null" |
FileConverter.converter.x2tPath | Definiert einen Pfad zum x2t-Dateikonverter. | string | "null" |
FileConverter.converter.docbuilderPath | Definiert einen Pfad zur Document Builder-Anwendung. | string | "null" |
FileConverter.converter.args | Definiert die zusätzlichen Parameter zum Ausführen von x2t. | string | "" |
FileConverter.converter.spawnOptions | Definiert die Parameter, die direkt an die node.js child_process.spawn-Bibliothek (nur zum Ausführen von x2t) übergeben werden können. | object | {} |
FileConverter.converter.errorfiles | Definiert einen Pfad zu den Fehlerdateien. | string | "" |
FileConverter.converter.streamWriterBufferSize | Definiert die StreamWriter-Puffergröße. | integer | 8388608 |
FileConverter.converter.maxRedeliveredCount | Definiert eine maximale Anzahl von erneuten Zustellungen von Nachrichten. | integer | 2 |
FileConverter.converter.inputLimits | Definiert Grenzen für Eingabedateien. | object | |
FileConverter.converter.inputLimits.type | Definiert die OOXML-Dateitypen, für die die Grenzen angegeben werden (Textdokumente/Kalkulationstabellen/Präsentationen). Dies schließt andere Objekte wie Bilder nicht ein. | string | "docx;dotx;docm;dotm"/"xlsx;xltx;xlsm;xltm"/"pptx;ppsx;potx;pptm;ppsm;potm" |
FileConverter.converter.inputLimits.zip | Definiert die Eigenschaften des ZIP-Archivs. | object | |
FileConverter.converter.inputLimits.zip.uncompressed | Definiert die unkomprimierte Gesamtdateigröße für Textdokumente/Kalkulationstabellen/Präsentationen. | string | "50MB"/"300MB"/"50MB" |
FileConverter.converter.inputLimits.zip.template | Definiert die Namensvorlage für Dateien, deren Größe gezählt wird. | string | "*.xml" |
Diese Parameter definieren die Konfiguration des Dateikonverters.
Beispiel
"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"
}
}
]
}
}