1. Термины и сокращения.

ПО - Программное обеспечение "CRM Мираж"
Заказчик - Физическое или юридическое лицо, получатель услуг, имеющее доступ к ПО.
API - Application Programming Interface (программный интерфейс приложения)
JWT - JSON Web Token (токен веб-доступа)
FTS - Full-Text Search (полнотекстовый поиск)

2. Функциональные характеристики.

2.1. Цели и назначение.
Программное обеспечение "CRM Мираж" — это корпоративная система управления, состоящая из серверной части, разворачиваемой на сервере организации, и клиентского настольного приложения для операционной системы Windows, устанавливаемого на рабочие места сотрудников.

ПО предназначено для сотрудников разного уровня и разных отделов организации.

Система обеспечивает централизованное хранение и управление корпоративной информацией на сервере, упрощает коммуникации между сотрудниками и отделами через клиентское приложение, предоставляет инструменты для поиска и доступа к актуальной информации. Клиентское приложение подключается к серверной части через сеть и обеспечивает пользовательский интерфейс для работы с системой.

2.2. Подсистемы CRM Мираж
Сервер CRM Мираж — серверная часть приложения на базе NestJS. Разворачивается на серверах заказчика, обеспечивает обработку запросов, работу с базой данных PostgreSQL, аутентификацию пользователей и управление данными. Серверная часть предоставляет REST API для взаимодействия с клиентским приложением.
Клиентское приложение CRM Мираж - настольное приложение на базе Tauri для операционной системы Windows, устанавливаемое на ПК сотрудников организации. Приложение подключается к серверной части через сеть и предоставляет пользовательский интерфейс для работы с системой.

2.3. Ключевые функции.

- Система аутентификации и авторизации пользователей с использованием JWT токенов,
- Поддержка механизма обновления токенов доступа (refresh token),
- Разграничение прав доступа на основе ролей: Администратор, Руководитель, Сотрудник,
- Управление профилями сотрудников с информацией о полном имени, должности, адресе, телефоне, аватаре,
- Создание и управление новостями с категоризацией: события, достижения, пресс-релизы, интервью,
- Возможность закрепления важных новостей для отображения в верхней части списка,
- Загрузка превью-изображений для новостей в форматах: JPG, JPEG, PNG, WEBP,
- Загрузка изображений в контент новостей,
- Создание и управление статьями базы знаний с категоризацией: процессы, регламенты, инструкции, продукты, услуги, шаблоны, кейсы, брендбуки,
- Возможность закрепления важных статей для отображения в верхней части списка,
- Загрузка изображений в контент статей базы знаний,
- Загрузка и управление файлами различных форматов: изображения (PNG, JPG, JPEG, GIF, WEBP), документы (TXT, DOC, DOCX, ODT, PDF), таблицы (XLSX),
- Возможность загрузки до 10 файлов одновременно,
- Скачивание загруженных файлов с сохранением оригинального имени,
- Управление правами доступа к файлам: администраторы видят все файлы, руководители – файлы отдела, обычные пользователи - только свои,
- Удаление файлов с проверкой прав доступа,
- Управление организационной структурой: создание отделов, назначение руководителей отделов,
- Привязка сотрудников к отделам,
- Полнотекстовый поиск по новостям, статьям базы знаний и сотрудникам с использованием PostgreSQL Full-Text Search,
- Фильтрация результатов поиска по типам контента: все, новости, база знаний, сотрудники,
- Ранжирование результатов поиска по релевантности,
- Главная страница с дашбордом: статистика по количеству сотрудников, новостей, отделов,
- Отображение последних записей по сотрудникам, отделам, новостям и статьям базы знаний,
- Автоматическое определение периода для отображения последних записей (до 30 дней),
- Кэширование данных для повышения производительности с настраиваемым временем жизни кэша,
- Защита от злоупотреблений с помощью rate limiting (ограничение количества запросов),
- Валидация входных данных на уровне API,
- Безопасная обработка загружаемых файлов с проверкой расширений и размеров,
- Система уведомлений для пользователей,
- Возможность изменения пароля пользователем через интерфейс,
- Возможность администратором изменять пароли других пользователей,
- Экспорт контактной информации сотрудников в формате vCard для импорта в адресные книги,
- Адаптивный интерфейс с поддержкой различных размеров экрана,
- Поддержка тегов для новостей и статей базы знаний,
- Отслеживание авторов публикаций новостей и статей,
- Отслеживание дат создания и обновления записей,

3. Информация необходимая для установки и эксплуатации системы.

3.1. Требования к серверной части
- рекомендуемый объем жесткого диска не менее 100 ГБ (SSD или зеркальный дисковый массив RAID-1);
- рекомендуемый объем RAM-сервера от 8 ГБ DDR4,
- минимальное кол-во ядер процессора 4 с частотой от 2.0 GHz на ядро,
- пропускная способность локальной сети не менее 10 Mbit,
- операционная система Linux (Ubuntu 18.04 LTS и выше)
- предустановленные зависимости: Docker, Docker Compose (для контейнеризованного развертывания),
- база данных PostgreSQL 15 и выше,
- Node.js 18 и выше (для разработки и запуска без Docker).

3.2. Требования к клиентской части

3.2.1. Требования к рабочему месту пользователя:
- операционная система Windows 7/8/10/11,
- входящая/исходящая скорость соединения с сервером - не менее 256 кбит/с,
- 200 мб свободного дискового пространства (для установки клиентского приложения),
- от 4 Гб оперативной памяти,
- разрешение экрана не менее 1200x800 пикселей,
- наличие сетевого подключения к серверу CRM Мираж

3.3. Требования к квалификации пользователя:
- опыт работы с персональным компьютером под управлением Windows,
- базовые навыки работы с файлами и папками,
- умение работать с настольными приложениями,

3.5. Режим функционирования ПО

В основном режиме функционирования ПО обеспечивает беспрерывную работу в режиме 24 часа в день, 7 дней в неделю, а так же выполнение всех функций в полном объеме, за исключением периодов проведения профилактических и других работ, а также устранения нештатных ситуаций.

4. Выполнение программного обеспечения.

4.1. Загрузка и запуск ПО.
4.1.1. Запуск серверной части приложения.

Порядок действий по установке серверной части ПО описан в документе “Инструкция по установке экземпляра программного обеспечения”

4.1.2. Запуск клиентского приложения.

Пользователям необходимо скачать и установить клиентское приложение CRM Мираж для операционной системы Windows. Установочный файл распространяется в виде исполняемого файла (exe) или установщика.
После установки приложения для начала работы необходимо:
- Запустить клиентское приложение CRM Мираж
- Указать адрес сервера CRM Мираж в корпоративной сети
- Заполнить авторизационную форму (email и пароль)

Клиентское приложение доступно пользователям после установки серверной части приложения и получения учетных данных для доступа.