Konfigurisanje ONLYOFFICE Docs Developer izdanja

Uvod

Da biste promenili bilo koje postavke servera ONLYOFFICE Docs, konfigurišite odgovarajući parametar u konfiguracionoj datoteci ONLYOFFICE Docs, koja se nalazi na sledećoj putanji:

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

Ako želite da ga promenite, možete koristiti datoteku local.json, gde bi svi izmenjeni parametri trebalo da budu sačuvani. Ova datoteka se nalazi u istom direktorijumu kao i datoteka default.json, i cela struktura objekta za potrebni parametar mora biti zadržana.

Podrazumevane postavke servera su opisane ispod.

Administratorska tabla

Ovi parametri definišu svojstva Administratorske table. Za više detalja o korišćenju Administratorske table, možete se obratiti ovom članku.

Primer

"adminPanel": {
    "port": 9000
  }

StatsD

Ovi parametri definišu svojstva StatsD servera, specificirajući agregator metrika.

Primer

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

Postavke AI dodatka

Ovi parametri definišu svojstva AI dodatka.

Primer

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

Logger

Ovi parametri definišu svojstva logera.

Primer

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

Runtime konfiguracija

Ovi parametri definišu svojstva dinamičkog konfiguracionog fajla runtime.json. Ovaj fajl vam omogućava da promenite parametre bez ponovnog pokretanja. Fajl se ponovo čita na osnovu događaja nadgledanja ili svakih 5 minuta.

Primer

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

Redovi

Ovi parametri definišu red poruka primljenih od posrednika poruka.

Primer

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

Email

Ovi parametri definišu podešavanja eksternog mail servera, koji se koristi za slanje obaveštenja. Za povezivanje sa mail serverom, koristite biblioteku nodemailer. Mnoga podešavanja konfiguracije se direktno prosleđuju ovoj biblioteci.

Primer

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

Obaveštenje

Ovi parametri definišu postavke obaveštenja.

Obaveštenja sa sledećim tipovima događaja i sadržajem se šalju:

• Prekoračeno je 70% kvote konekcija (kvota jedinstvenih korisnika).

  Upozorenje o ograničenju konekcija licence: "Pažnja! Dostigli ste 70% limita konekcija postavljenog vašom licencom."

• Dosegnuta je kvota konekcija (kvota jedinstvenih korisnika).

  Upozorenje o ograničenju konekcija licence: "Pažnja! Dostigli ste 100% limita konekcija postavljenog vašom licencom."

• 30 dana pre nego što licenca istekne.

  Upozorenje o isteku licence: "Pažnja! Vaša licenca ističe 8. septembra 2024. Nakon ovog datuma, više nećete imati pravo na ličnu tehničku podršku i instalaciju novih verzija Docs-a objavljenih nakon ovog datuma."

• Licenca je istekla.

  Upozorenje o ograničenju konekcija licence: "Pažnja! Vaša licenca je istekla 8. septembra 2024. Više nemate pravo na ličnu tehničku podršku i instalaciju novih verzija Docs-a objavljenih nakon ovog datuma. Molimo kontaktirajte sales@onlyoffice.com za razgovor o obnovi licence."

Ova obaveštenja se beleže u server log sa WARN ili ERROR nivoom.

Primer

"notification": {
"rules": {
"licenseExpirationWarning": {
"enable": false,
"transportType": [
"email"
],
"template": {
"title": "%s Docs upozorenje o isteku licence",
"body": "Pažnja! Vaša licenca ističe %s.\nNakon ovog datuma, više nećete imati pravo na ličnu tehničku podršku i instalaciju novih verzija Docs-a objavljenih nakon ovog datuma."
},
"policies": {
"repeatInterval": "1d"
}
},
"licenseExpirationError": {
"enable": false,
"transportType": [
"email"
],
"template": {
"title": "%s Docs upozorenje o isteku licence",
"body": "Pažnja! Vaša licenca je istekla %s.\nViše nemate pravo na ličnu tehničku podršku i instalaciju novih verzija Docs-a objavljenih nakon ovog datuma.\nMolimo kontaktirajte sales@onlyoffice.com za razgovor o obnovi licence."
},
"policies": {
"repeatInterval": "1d"
}
},
"licenseLimitEdit": {
"enable": false,
"transportType": [
"email"
],
"template": {
"title": "%s Docs upozorenje o ograničenju konekcija licence",
"body": "Pažnja! Dostigli ste %s%% od %s limita postavljenog vašom licencom."
},
"policies": {
"repeatInterval": "1h"
}
},
"licenseLimitLiveViewer": {
"enable": false,
"transportType": [
"email"
],
"template": {
"title": "%s Docs upozorenje o ograničenju konekcija licence",
"body": "Pažnja! Dostigli ste %s%% od limita za live viewer %s postavljenog vašom licencom."
},
"policies": {
"repeatInterval": "1h"
}
}
}
}

Servis za skladištenje dokumenata

Ovi parametri definišu konfiguraciju usluge skladištenja dokumenata.

Primer

"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
  }

Persistentno skladište

Ovi parametri definišu podešavanja za persistentno skladište, koje se koristi za odvajanje podešavanja za skladištenje keširanih dokumenata i skladištenje zaboravljenih i greškom nastalih fajlova. Podešavanja koja nisu navedena u ovom objektu nasleđuju se iz storage objekta. Ovo odvajanje je pogodno za nadogradnje servera.

Primer

"persistentStorage": {
}

RabbitMQ

Ovi parametri definišu konfiguraciju RabbitMQ posrednika poruka.

Primer

"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

Ovi parametri definišu konfiguraciju ActiveMQ posrednika poruka.

Primer

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

DNS keš

Ovi parametri definišu konfiguraciju DNS keša koji se koristi za IP-filter.

Primer

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

OpenPGP protokol

Ovi parametri definišu postavke OpenPGP protokola, koji se koristi za enkripciju lozinke prilikom otvaranja enkriptovanog dokumenta za uređivanje.

Primer

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

AES-256-GCM algoritam

Ovi parametri definišu postavke AES-256-GCM algoritma enkripcije koji se koristi za zaštitu lozinkom dokumenata.

Primer

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

Bottleneck

Ovaj parametar definiše konfiguraciju Bottleneck-a.

Primer

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

Windows System Root certifikati

Ovaj parametar definiše podešavanja za Windows System Root certifikate.

Primer

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

WOPI

Ovi parametri definišu konfiguraciju WOPI protokola.

Primer

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

Stanari

Ovi parametri definišu svojstva stanara za rad u režimu sa više stanara.

Primer

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

Eksterni zahtev

Ovi parametri definišu konfiguraciju eksternih zahteva.

Primer

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

Document Server usluge

Ovi parametri definišu podešavanja za Document Server usluge.

Server

Ovi parametri definišu konfiguraciju servera.

Primer

"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
        }
    }
}

Podrazumevani zahtev

Ovi parametri definišu podrazumevanu konfiguraciju zahteva.

Primer

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

Automatsko sastavljanje

Ovi parametri definišu konfiguraciju automatskog forcesaving.

Primer

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

Utils

Ovi parametri definišu konfiguraciju utils-a.

Primer

"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

Ovi parametri definišu konfiguraciju baze podataka.

Primer

"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

Ovi parametri definišu Redis konfiguraciju.

Primer

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

PubSub servis

Ovaj parametar definiše konfiguraciju PubSub servisa.

Primer

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

Isticanje

Ovi parametri definišu postavke isteka.

Primer

"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

Ovi parametri definišu konfiguraciju IP filtera.

Primer

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

Agent za filtriranje zahteva

Ovi parametri definišu konfiguraciju agenta za filtriranje zahteva.

Primer

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

Tajni ključ

Ovi parametri definišu konfiguraciju tajnog ključa.

Primer

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

Token

Ovi parametri definišu konfiguraciju tokena.

Primer

"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
        }
    }
}
}

Dodaci

Ovi parametri definišu konfiguraciju dodataka.

Primer

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

Teme

Ovaj parametar definiše svojstva prilagođenih tema boja.

Primer

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

Editor

Ovi parametri definišu konfiguraciju editora.

Primer

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

SockJs

Ovi parametri definišu konfiguraciju SockJs.

Primer

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

Socket.IO

Ovi parametri definišu konfiguraciju Socket.IO modula.

Primer

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

Opcije povratnog poziva sa odlaganjem

Ovi parametri definišu opcije povratnog poziva sa odlaganjem.

Primer

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

Licenca

Ovi parametri definišu konfiguraciju licence.

Primer

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

Konverter

Ovi parametri definišu konfiguraciju konvertora fajlova.

Primer

"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"
            }
            }
        ]
    }
}