DocSpace services

Introduction

Service is the ONLYOFFICE DocSpace component that is used to perform long-running background operations without user interaction. The service can be started and stopped from any application component or other services.

Below you can find a list of the ONLYOFFICE DocSpace services.

ServiceDescription
The REST API server for working with AI features. The service which handles API requests related to AI.
The service for background tasks related with AI. It vectorizes documents from the knowledge base for subsequent semantic search and performs chat/message export.
The service which is used for working with portals (creating, removing portals, etc.
Handles the API requests related to the backups. The port number is 5012.
Clears the login_events and audit_events tables by LoginHistoryLifeTime and AuditTrailLifeTime to log out users after the timeout.

Launches the additional services related to the backup creation:

  • BackupWorkerService - launches WorkerService that runs backups/restore etc.;
  • BackupListenerService - waits for a notification to delete backups according to the schedule;
  • BackupCleanerTempFileService - deletes the temporary files remaining after backup;
  • BackupCleanerService - deletes outdated backups;
  • BackupSchedulerService - runs backups according to the schedule.
The service which allows interaction with documentserver.
  • Handles the API requests related to the documents. The port number is 5007.
  • Launches OFormService.

Launches the additional services related to the file management:

  • ElasticSearchIndexService - indexes documents using Elasticsearch;
  • FeedAggregatorService - aggregates notifications;
  • FeedCleanerService - removes notifications;
  • FileConverterService - converts documents;
  • ThumbnailBuilderService - generates thumbnails for documents;
  • Launcher - removes the outdated files from the recycle bin.
The service responsible for authentication methods used to access DocSpace, e.g., the OAuth technology.
The service responsible for managing user identities and authentication within DocSpace by using the OAuth technology.
The service which is used for logging users and displaying the wizard.
The service responsible for creating and managing several spaces (Space Management).
The server that operates using the Model Context Protocol, which provides AI with functionality for working in DocSpace. For example, AI ​​can be asked to create a room.

Launches the additional services related to the notifications about DocSpace events:

  • NotifySenderService - sends messages from the database;
  • NotifyCleanerService - removes messages.
Handles the API requests related to the People module.
The service which allows integrating DocSpace into your own web application by using JavaScript SDK.
Provides the two-way communication between a client and a server. It allows pages to receive data without restarting (for example, thumbnails or new documents). The port number is 9899.
Allows you to enable and configure the SAML-based single sign-on (SSO) authentication providing a faster, easier, and more secure way for users to access DocSpace. The port number is 9834.
Generates notifications and sends them to other services (for example, NotifyService).
The service which is used for receiving DocSpace notifications via Telegram.
Displays the list of launched services. The port number is 5027.
Handles the API requests not related to the services above. For example, it handles requests related to settings, audit, authentication, etc. The port number is 5000.
Processes the storage handlers and the authorization pages. The port number is 5003.

Host ONLYOFFICE DocSpace on your own server or use it in the cloud

Get it nowUse in the cloud
Article with the tag:
Browse all tags