Add package descriptions

This commit is contained in:
Evgeniy Antonyuk 2023-06-14 12:52:35 +05:00
parent 4bd617dff4
commit 5ff5dae582
2 changed files with 74 additions and 32 deletions

View File

@ -40,123 +40,150 @@ Architecture: any
Depends: adduser, logrotate, ${misc:Depends}, ${shlibs:Depends}
Recommends: default-mysql-client
Description: {{product}}-common
{{product}}-common
A package containing configs and scripts
Package: {{product}}-backup
Architecture: any
Depends: {{product}}-common (= {{package_header_tag_version}}), dotnet-sdk-7.0, ${misc:Depends}, ${shlibs:Depends}
Description: {{product}}-backup
{{product}}-backup
The service which handles API requests related to backup
Package: {{product}}-files
Architecture: any
Depends: {{product}}-common (= {{package_header_tag_version}}), dotnet-sdk-7.0, ${misc:Depends}, ${shlibs:Depends}
Recommends: elasticsearch (= 7.10.0)
Description: {{product}}-files
{{product}}-files
The service which handles API requests related to
documents and launches the OFormService service
Package: {{product}}-files-services
Architecture: any
Depends: {{product}}-common (= {{package_header_tag_version}}), dotnet-sdk-7.0, ${misc:Depends}, ${shlibs:Depends}
Recommends: ffmpeg, elasticsearch (= 7.10.0)
Description: {{product}}-files-services
{{product}}-files-services
The service which launches additional services related to file management:
- ElasticSearchIndexService - indexes documents using elasticsearch;
- FeedAggregatorService - aggregates notifications;
- FeedCleanerService - removes notifications;
- FileConverterService - converts documents;
- ThumbnailBuilderService - generates thumbnails for documents;
- Launcher - removes outdated files from Trash;
Package: {{product}}-notify
Architecture: any
Depends: {{product}}-common (= {{package_header_tag_version}}), dotnet-sdk-7.0, ${misc:Depends}, ${shlibs:Depends}
Recommends: ffmpeg, elasticsearch (= 7.10.0)
Description: {{product}}-notify
{{product}}-notify
The service which launches additional services
related to notifications about DocSpace events:
NotifySenderService which sends messages from the base,
and NotifyCleanerService which removes messages
Package: {{product}}-people-server
Architecture: any
Depends: {{product}}-common (= {{package_header_tag_version}}), dotnet-sdk-7.0, ${misc:Depends}, ${shlibs:Depends}
Description: {{product}}-people-server
{{product}}-people-server
The service which handles API requests related to the People module
Package: {{product}}-socket
Architecture: any
Depends: {{product}}-common (= {{package_header_tag_version}}), nodejs (>= 16), ${misc:Depends}, ${shlibs:Depends}
Recommends: redis-server
Description: {{product}}-socket
{{product}}-socket
The service which provides two-way communication between a web browser and the server
Package: {{product}}-studio-notify
Architecture: any
Depends: {{product}}-common (= {{package_header_tag_version}}), dotnet-sdk-7.0, ${misc:Depends}, ${shlibs:Depends}
Description: {{product}}-studio-notify
{{product}}-studio-notify
The service responsible for creating notifications and
sending them to other services, for example, TelegramService and NotifyService
Package: {{product}}-api
Architecture: any
Depends: {{product}}-common (= {{package_header_tag_version}}), dotnet-sdk-7.0, ${misc:Depends}, ${shlibs:Depends}
Recommends: rabbitmq-server, apache-activemq, redis-server
Description: {{product}}-api
{{product}}-api
The service which is used for working with a certain portal. This service
handles API requests not related to backup, documents, and the People
module, for example, requests related to settings, audit, authentication, etc.
Package: {{product}}-api-system
Architecture: any
Depends: {{product}}-common (= {{package_header_tag_version}}), dotnet-sdk-7.0, ${misc:Depends}, ${shlibs:Depends}
Description: {{product}}-api-system
{{product}}-api-system
The service which is used for working with portals (creating, removing portals, etc.)
Package: {{product}}-studio
Architecture: any
Depends: {{product}}-common (= {{package_header_tag_version}}), dotnet-sdk-7.0, ${misc:Depends}, ${shlibs:Depends}
Description: {{product}}-studio
{{product}}-studio
The service which processes storage handlers and authorization pages
Package: {{product}}-proxy
Architecture: any
Depends: {{product}}-common (= {{package_header_tag_version}}), nginx-extras (>= 1.9.5), ${misc:Depends}, ${shlibs:Depends}
Description: {{product}}-proxy
{{product}}-proxy
The service which is used as a web server and reverse proxy,
it receives and handles requests, transmits them to other services,
receives a response from them and returns it to the client
Package: {{product}}-ssoauth
Architecture: any
Depends: {{product}}-common (= {{package_header_tag_version}}), nodejs (>= 16), ${misc:Depends}, ${shlibs:Depends}
Description: {{product}}-ssoauth
{{product}}-ssoauth
The service responsible for enabling and configuring
SAML-based single sign-on (SSO) authentication to provide a more quick,
easy and secure way to access DocSpace for users
Package: {{product}}-backup-background
Architecture: any
Depends: {{product}}-common (= {{package_header_tag_version}}), dotnet-sdk-7.0, ${misc:Depends}, ${shlibs:Depends}
Description: {{product}}-backup-background
{{product}}-backup-background
The service which launches additional services related to backup creation:
- BackupWorkerService - launches WorkerService which runs backup/restore, etc.;
- BackupListenerService - waits for a signal to delete backups;
- BackupCleanerTempFileService - removes temporary backup files;
- BackupCleanerService - removes outdated backup files;
- BackupSchedulerService - runs backup according to a schedule;
Package: {{product}}-clear-events
Architecture: any
Depends: {{product}}-common (= {{package_header_tag_version}}), dotnet-sdk-7.0, ${misc:Depends}, ${shlibs:Depends}
Description: {{product}}-clear-events
{{product}}-clear-events
The service responsible for clearing the login_events and audit_events tables
by LoginHistoryLifeTime and AuditTrailLifeTime to log out users after a timeout
Package: {{product}}-migration-runner
Architecture: any
Depends: {{product}}-common (= {{package_header_tag_version}}), dotnet-sdk-7.0, ${misc:Depends}, ${shlibs:Depends}
Description: {{product}}-migration-runner
{{product}}-migration-runner
The service responsible for the database creation.
A database connection is transferred to the service and
the service creates tables and populates them with values
Package: {{product}}-radicale
Architecture: any
Depends: {{product}}-common (= {{package_header_tag_version}}), python3-pip, python3-requests, python3-setuptools, ${misc:Depends}, ${shlibs:Depends}
Description: {{product}}-radicale
{{product}}-radicale
Radicale is a server designed to support the CalDav and CardDav protocols.
It operates either as a standalone package using its own internal http server
or can be integrated with an existing webserver
Package: {{product}}-doceditor
Architecture: any
Depends: {{product}}-common (= {{package_header_tag_version}}), nodejs (>= 16), ${misc:Depends}, ${shlibs:Depends}
Description: {{product}}-doceditor
{{product}}-doceditor
The service which allows interaction with documentserver
Package: {{product}}-login
Architecture: any
Depends: {{product}}-common (= {{package_header_tag_version}}), nodejs (>= 16), ${misc:Depends}, ${shlibs:Depends}
Description: {{product}}-login
{{product}}-login
The service which is used for logging users and displaying the wizard
Package: {{product}}-healthchecks
Architecture: any
Depends: {{product}}-common (= {{package_header_tag_version}}), dotnet-sdk-7.0, ${misc:Depends}, ${shlibs:Depends}
Description: {{product}}-healthchecks
{{product}}-healthchecks
The service which displays launched services

View File

@ -6,7 +6,7 @@ Requires: %name-common = %version-%release
Requires: dotnet-sdk-7.0
AutoReqProv: no
%description backup
Backup
The service which handles API requests related to backup
%package common
Packager: %{packager}
@ -14,7 +14,7 @@ Summary: Common
Group: Applications/Internet
Requires: logrotate
%description common
Common
A package containing configs and scripts
%package files-services
Packager: %{packager}
@ -25,7 +25,13 @@ Requires: dotnet-sdk-7.0
Requires: ffmpeg
AutoReqProv: no
%description files-services
Files-services
The service which launches additional services related to file management:
- ElasticSearchIndexService - indexes documents using elasticsearch;
- FeedAggregatorService - aggregates notifications;
- FeedCleanerService - removes notifications;
- FileConverterService - converts documents;
- ThumbnailBuilderService - generates thumbnails for documents;
- Launcher - removes outdated files from Trash;
%package notify
Packager: %{packager}
@ -35,7 +41,10 @@ Requires: %name-common = %version-%release
Requires: dotnet-sdk-7.0
AutoReqProv: no
%description notify
Notify
The service which launches additional services
related to notifications about DocSpace events:
NotifySenderService which sends messages from the base,
and NotifyCleanerService which removes messages
%package files
Packager: %{packager}
@ -45,7 +54,8 @@ Requires: %name-common = %version-%release
Requires: dotnet-sdk-7.0
AutoReqProv: no
%description files
Files
The service which handles API requests related to
documents and launches the OFormService service
%package proxy
Packager: %{packager}
@ -56,7 +66,9 @@ Requires: nginx >= 1.9.5
Requires: mysql-community-client >= 5.7.0
AutoReqProv: no
%description proxy
Proxy
The service which is used as a web server and reverse proxy,
it receives and handles requests, transmits them to other services,
receives a response from them and returns it to the client
%package studio-notify
Packager: %{packager}
@ -66,7 +78,8 @@ Requires: %name-common = %version-%release
Requires: dotnet-sdk-7.0
AutoReqProv: no
%description studio-notify
Studio-notify
The service responsible for creating notifications and
sending them to other services, for example, TelegramService and NotifyService
%package people-server
Packager: %{packager}
@ -76,7 +89,7 @@ Requires: %name-common = %version-%release
Requires: dotnet-sdk-7.0
AutoReqProv: no
%description people-server
People-server
The service which handles API requests related to the People module
%package socket
Packager: %{packager}
@ -86,7 +99,7 @@ Requires: %name-common = %version-%release
Requires: nodejs >= 16.0
AutoReqProv: no
%description socket
Socket
The service which provides two-way communication between a web browser and the server
%package studio
Packager: %{packager}
@ -96,7 +109,7 @@ Requires: %name-common = %version-%release
Requires: dotnet-sdk-7.0
AutoReqProv: no
%description studio
Studio
The service which processes storage handlers and authorization pages
%package api
Packager: %{packager}
@ -106,7 +119,9 @@ Requires: %name-common = %version-%release
Requires: dotnet-sdk-7.0
AutoReqProv: no
%description api
Api
The service which is used for working with a certain portal. This service
handles API requests not related to backup, documents, and the People
module, for example, requests related to settings, audit, authentication, etc.
%package api-system
Packager: %{packager}
@ -116,7 +131,7 @@ Requires: %name-common = %version-%release
Requires: dotnet-sdk-7.0
AutoReqProv: no
%description api-system
Api-system
The service which is used for working with portals (creating, removing portals, etc.)
%package ssoauth
Packager: %{packager}