Инструкция по установке к ПО
«Microboard, Белая доска»

Оглавление


1. Введение
2. Системные требования
3. Модули ПО «Microboard, Белая доска»
4. Инструкция по установке и настройке ПО «Microboard, Белая доска» (SaaS)
5. Инструкция по установке и настройке ПО «Microboard, Белая доска» (On-premise)
6. Установка и запуск образа ПО «Microboard, Белая доска»


  1. Введение
Программное обеспечение «Microboard, Белая доска» предоставляется в формате серверного решения, а также Программное обеспечение «Microboard, Белая доска» предоставляется в виде SaaS (программное обеспечение как услуга), что позволяет пользователям получить доступ к его функционалу через Интернет без необходимости установки и настройки на локальных устройствах. Это руководство поможет вам пройти процесс регистрации и начать работу с ПО «Microboard, Белая доска».

  • Создание новых досок
Возможность быстро создавать новые рабочие пространства для различных проектов.
  • Редактирование существующих досок
Добавление текста, изображений, фигур и других элементов для удобной визуализации идей и информации.
  • Удаление досок
Управление и организация рабочего пространства с возможностью удаления ненужных досок.
  • Совместная работа в режиме реального времени
Поддержка работы нескольких участников одновременно, что позволяет улучшить командное взаимодействие и эффективность.

2. Системные требования

ПО «Microboard, Белая доска» может распространяться в двух форматах:

  • Облачное решение (Интернет-сервис, SAAS)
Настройка облачного формата и обеспечение всех необходимых ресурсов для его работы выполняются Правообладателем ПО.
  • Серверное решение (On-premise)
При установке на локальных серверах заказчика установка дополнительных компонентов не требуется, так как ПО уже включает все необходимые компоненты.

Минимальные системные требования для установки:

  • 4 Гбайт (GB) RAM;
  • 30 Гбайт (GB) свободного дискового пространства.

3. Модули ПО «Microboard, Белая доска»

Все необходимые для реализации рабочих процессов включены в стандартные программные модули (программные части) и доступны в базовой сборке ПО. Примеры доступных модулей:

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

4. Инструкция по установке и настройке ПО «Microboard, Белая доска» (SaaS)

Введение


Программное обеспечение «Microboard, Белая доска» предоставляется в виде SaaS (программное обеспечение как услуга), что позволяет пользователям получить доступ к его функционалу через Интернет без необходимости установки и настройки на локальных устройствах. Это руководство поможет вам пройти процесс регистрации и начать работу с ПО «Microboard, Белая доска».

Шаг 1: Регистрация

1. Откройте браузер на вашем устройстве. Поддерживаются следующие браузеры:
- Mozilla Firefox
- Яндекс.Браузер
- Opera

2. Перейдите на страницу регистрации по следующей ссылке: https://alpha.microboard.ru/auth/sign-up.

3. Заполните регистрационную форму, указав необходимые данные (электронная почта, пароль и т.д.).

4. Подтвердите вашу регистрацию через ссылку, отправленную на указанную электронную почту.

5. После подтверждения вы автоматически получите доступ к личному кабинету ПО «Microboard, Белая доска».

Шаг 2: Настройка учетной записи

1. Войдите в личный кабинет, используя учетные данные, указанные при регистрации.

2. Настройте профиль пользователя, добавив информацию о вашей компании и настроив основные параметры работы.

3. При необходимости добавьте дополнительных пользователей и назначьте им соответствующие роли и права доступа.

Шаг 3: Начало работы

1. Ознакомьтесь с основными функциями ПО «Microboard, Белая доска» через встроенное руководство пользователя или ознакомительный тур, который будет предложен при первом входе в систему.

2. Настройте рабочие процессы и интеграции, необходимые для эффективного использования ПО «Microboard, Белая доска» в вашей компании.

3. Начните использовать ПО «Microboard, Белая доска» для управления задачами, проектами и другими аспектами вашей деятельности.

Системные требования

Для корректной работы ПО «Microboard, Белая доска» вам потребуется:

- Доступ к стабильному интернет-соединению.
- Современный браузер, указанный выше.
- Устройство с достаточной производительностью для работы с веб-приложениями.

Поддержка и обновления

Программное обеспечение «Microboard, Белая доска» постоянно обновляется для улучшения функциональности и безопасности. Все обновления происходят автоматически, без вмешательства со стороны пользователя. В случае возникновения проблем или вопросов, свяжитесь с технической поддержкой через личный кабинет или по электронной почте info@microboard.ru.

Поздравляем! Теперь вы готовы к эффективному использованию ПО «Microboard, Белая доска» в вашей ежедневной работе.
5. Инструкция по установке и настройке ПО «Microboard, Белая доска» (On-premise)
Введение

Программное обеспечение «Microboard, Белая доска» в формате (версии) On-premise устанавливается на серверную инфраструктуру заказчика и предназначено для использования внутри организации. Этот вариант позволяет организации (компании) иметь полный контроль над данными и инфраструктурой, обеспечивая высокий уровень безопасности и кастомизации.

Шаг 1: Предварительные требования

Перед началом установки необходимо подготовить серверное оборудование, которое будет соответствовать требованиям для корректной работы ПО «Microboard, Белая доска» .

1. Системные требования сервера:

Общие требования

  • Операционная система: Современные Linux-дистрибутивы База данных: PostgreSQL
  • Хранилище медиафайлов: S3-совместимое хранилище (MINIO)

Требования к кластерному развертыванию
  • Система оркестрации контейнеров: Kubernetes
  • Система мониторинга и логирования: Prometheus, Grafana
Требования для различных масштабов пользователей

До 1 000 пользователей
Минимальные требования:
  • Процессор: 4 ядра
  • ОЗУ: 16 ГБ
  • Хранилище для PostgreSQL: 1 ТБ SSD Хранилище для медиафайлов: 3 ТБ Пропускная способность сети: 1 Гбит/с
Рекомендуемые требования:
  • Процессор: 8 ядер
  • ОЗУ: 32 ГБ
  • Хранилище для PostgreSQL: 2 ТБ SSD Хранилище для медиафайлов: 5 ТБ
  • Пропускная способность сети: 1 Гбит/с

До 10 000 пользователей
Минимальные требования:
  • Процессор: 8 ядер
  • ОЗУ: 32 ГБ
  • Хранилище для PostgreSQL: 10 ТБ SSD Хранилище для медиафайлов: 30 ТБ Пропускная способность сети: 10 Гбит/с
Рекомендуемые требования:
  • Процессор: 16 ядер
  • ОЗУ: 64 ГБ
  • Хранилище для PostgreSQL: 20 ТБ SSD Хранилище для медиафайлов: 50 ТБ
  • Пропускная способность сети: 10 Гбит/с
До 100 000 пользователей
Минимальные требования:
  • Процессор: 32 ядра
  • ОЗУ: 256 ГБ
  • Хранилище для PostgreSQL: 100 ТБ SSD Хранилище для медиафайлов: 300 ТБ Пропускная способность сети: 100 Гбит/с
Рекомендуемые требования:
  • Процессор: 64 ядра
  • ОЗУ: 512 ГБ
  • Хранилище для PostgreSQL: 200 ТБ SSD Хранилище для медиафайлов: 500 ТБ Пропускная способность сети: 100 Гбит/с
Примечание: Указанные требования представляют целевые характеристики системы. Они могут быть достигнуты как вертикальным, так и горизонтальным масштабированием, однако конкретные технические требования и архитектурные решения могут существенно различаться в зависимости от выбранного подхода. Выбор стратегии масштабирования зависит от специфических потребностей проекта, технических возможностей и долгосрочных целей развития системы.
Примечание: Эти требования являются приблизительными и могут потребовать корректировки в зависимости от реальной нагрузки и специфики использования системы. Рекомендуется произвести нагрузочное тестирование.
Примечание: Объём использования закладываемый для расчёта минимальных требований:
  • Хранение событий на доску: 25 МБ
  • Хранение медиафайлов на доску: 75 МБ Количество досок на пользователя: 30
  • Пиковый процент активных пользователей: 30%

Требования к рабочим местам пользователей
Десктопные устройства
Минимальные требования:
  • Процессор: 2 ядра 2 GHz или выше
  • ОЗУ: 4 GB
  • Свободное место на диске: 1 GB
  • Операционные системы: Windows 8 или новее, macOS 10.14 (Mojave) или новее Linux
  • Браузеры: Google Chrome и другие браузеры на базе Chromium (Edge, Opera, Vivaldi, Yandex) 83 версия и выше, Mozilla Firefox 85 версия и выше, Safari 14 версия и выше, Microsoft Edge 88+ (Chromium-based)
  • Разрешение экрана: 1366x768 или выше
  • Интернет-соединение: 1 Mbps или выше

Рекомендуемые требования:
  • Процессор: 4 ядра 3 GHz или выше
  • ОЗУ: 8 GB или больше
  • Свободное место на диске: 5 GB или больше
  • Операционные системы: Последние версии вышеуказанных систем Браузеры: Последние версии вышеуказанных браузеров Разрешение экрана: 1920x1080 или выше
  • Интернет-соединение: 20 Mbps или выше

Мобильные устройства
Минимальные требования:
  • Операционные системы: iOS 13 или новее, Android 8.0 или новее
  • Браузеры: Safari на iOS, Google Chrome на Android
  • ОЗУ: 2 GB
  • Свободное место на устройстве: 500 MB
  • Разрешение экрана: 720x1280 или выше
  • Интернет-соединение: 4G LTE или Wi-Fi
Рекомендуемые требования:
  • Операционные системы: iOS 15 или новее, Android 11 или новее
  • Браузеры: Последние версии браузеров, установленных по умолчанию
  • ОЗУ: 4 GB или больше
  • Свободное место на устройстве: 1 GB или больше
  • Разрешение экрана: 1080x1920 или выше
  • Интернет-соединение: 5G или высокоскоростной Wi-Fi
Примечание: Производительность может варьироваться в зависимости от конкретного устройства и его характеристик.

Шаг 2: Развертывание ПО

Процесс развертывания включает следующие этапы:

1. Подготовка среды:
- Проверка соответствия серверного оборудования и программного обеспечения требованиям.
- Настройка необходимых сервисов (Kubernetes, PostgreSQL, S3-хранилище).

2. Установка ПО:
- Развертывание контейнеров с ПО «Microboard, Белая доска» в среде Kubernetes.
- Настройка базы данных PostgreSQL и интеграция её с ПО «Microboard, Белая доска».
- Подключение и настройка S3-совместимого хранилища для корректного хранения файлов и данных.

3. Конфигурация и тестирование:
- Первичная настройка системы в соответствии с требованиями заказчика.
- Тестирование работы системы для проверки корректности установки и настройки.

Шаг 3: Обновления и поддержка

После завершения установки система готова к использованию.

1. Обновления ПО:
- Обновления загружаются и устанавливаются на серверы заказчика по мере их выпуска.
- Для установки обновлений необходимо предоставить доступы, аналогичные тем, что использовались при первоначальном развертывании.

Поздравляем! Теперь ваше программное обеспечение «Microboard, Белая доска» установлено и готово к использованию в инфраструктуре вашей компании.
6. Установка и запуск образа ПО «Microboard, Белая доска»
Предварительные требования

Docker и Docker Compose:

Убедитесь, что у вас установлены Docker и Docker Compose. Инструкции по установке можно найти на официальном сайте Docker.

Установка образа

1. Импортировать контейнер:
Выполните команду для импорта контейнера:
docker import api_container.tar.gz api:imported

2. Запустить приложение:
Запустите приложение с использованием Docker Compose:
docker-compose --verbose -f docker-compose.import.yml up

Доступ к приложению в браузере

После успешного запуска приложения, вы можете открыть его в браузере, перейдя по следующему адресу:
Если ваш сервер доступен по определенному IP-адресу или доменному имени, замените localhost на соответствующий адрес.

Заключение

Теперь ваше ПО «Microboard, Белая доска» должно быть доступно в браузере. Если возникнут какие-либо проблемы, проверьте логи контейнеров Docker для диагностики и устранения ошибок.