Apps services
Introduction
Service is the ONLYOFFICE Apps 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 Apps services.
| Service | Description |
|---|---|
| AI | The REST API server for working with AI features. The service which handles API requests related to AI. The port number is 5157. |
| AI.Worker | 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 port number is 5124. |
| ApiSystemService | The service which is used for working with workspaces (creating, removing workspaces, etc.). The port number is 5010. |
| BackupService | Handles the API requests related to the backups. The port number is 5012. |
| ClearEvents | Clears the login_events and audit_events tables by LoginHistoryLifeTime and AuditTrailLifeTime to log out users after the timeout. The port number is 5027. |
| Data.Backup.Worker | 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 port number is 5032. |
| DocEditor | The service which allows interaction with documentserver. The port number is 5013. |
| FileServer | • Handles the API requests related to the documents. • Launches OFormService. The port number is 5007. |
| Files.Worker | Launches the additional services related to the file management: • ElasticSearchIndexService - indexes documents using OpenSearch; • FeedAggregatorService - aggregates notifications; • FeedCleanerService - removes notifications; • FileConverterService - converts documents; • ThumbnailBuilderService - generates thumbnails for documents; • Launcher - removes the outdated files from the recycle bin. The port number is 5009. |
| Identity.Authorization | The service responsible for authentication methods used to access the workspace, e.g., the OAuth technology. |
| Identity.Registration | The service responsible for managing user identities and authentication within the workspace by using the OAuth technology. |
| Login | The service which is used for logging users and displaying the wizard. The port number is 5011. |
| Management | The service responsible for creating and managing several workspaces (Workspace Management). The port number is 5015. |
| MCP | The server that operates using the Model Context Protocol, which provides AI with functionality for working in the workspace. For example, AI can be asked to create a room. The port number is 5158. |
| MigrationRunner | The service which runs the migration of users and their data from third-party services when the data import is performed. |
| NewAi | The service which provides the interface for working with the AI features. |
| NotifyService | Launches the additional services related to the notifications about workspace events: • NotifySenderService - sends messages from the database; • NotifyCleanerService - removes messages. The port number is 5005. |
| PeopleServer | Handles the API requests related to the People module. The port number is 5004. |
| SDK | The service which allows integrating ONLYOFFICE Apps into your own web application by using Embed SDK. The port number is 5099. |
| Socket.IO | 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. |
| SsoAuth.Svc | 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 the workspace. The port number is 9834. |
| StudioNotifyService | Generates notifications and sends them to other services (for example, NotifyService). The port number is 5006. |
| Telegram | The service which is used for receiving workspace notifications via Telegram. The port number is 5075. |
| Web.HealthChecks.UI | Displays the list of launched services. The port number is 5033. |
| WebApi | 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. |
| WebStudio | Processes the storage handlers and the authorization pages. The port number is 5003. |