Портал документации Рутокен

Page tree

Общая информация

Настоящее руководство описывает процесс установки Рутокен Базы и настройки почтового адреса, который будет использоваться для отправки системных уведомлений и ссылок для регистрации в Рутокен Базе. Установка происходит путем запуска контейнера в Docker.

Сотрудники, осуществляющие установку Рутокен Базы, должны обладать знанием и опытом работы с Linux и Docker на уровне администратора.

Требования к серверу

Аппаратные требования

  • 2-ядерный процессор;
  • 8ГБ оперативной памяти;
  • 80ГБ свободного пространства на SSD.

Программные требования

  • ОС Linux;
  • Docker версии 24.0.1 и выше;
  • Docker Compose версии 2.26.1 и выше;
  • доступ в интернет;
  • свободные порты: 8080, 4222, 8222, 8418;
  • порты с открытым доступом в интернет: 8080, 4222;
  • возможность удаленного подключения для выполнения установки.

Подготовка к установке

Подготовка установочных файлов

  1. Скачайте установочные файлы из облачного хранилища.

  2. Убедитесь, что файлы base.tar, config.yaml, delete.sh, docker-compose.yml, install.sh, postgres.tar, redis.tar, update.tar, update_worker.sh и worker.tar находятся на одном уровне каталога, а файл base.sql.gz — в подкаталоге /sql.

    Структура каталога установочных файлов Рутокен Базы
    └─ Корневой каталог
    └─ /sql
		└─ base.sql.gz
    ├─ base.tar
    ├─ config.yaml
	├─ delete.sh
	├─ docker-compose.yml
	├─ install.sh
	├─ postgres.tar
	├─ redis.tar
	├─ update.sh
	├─ update_worker.sh
    └─ worker.tar

  3. Откройте терминал.

  4. Измените права доступа к установочным файлам:

    sudo chmod -R 777 /путь/к/корню/каталога/с/файлами

Настройка конфигурационного файла

Перед установкой в конфигурационном файле нужно указать IP-адрес сервера, на котором запускается Рутокен База. Для этого:

  1. Скачайте файл docker-compose.yml из облачного хранилища.
  2. Узнайте IP-адрес сервера, выполнив на нем команду ip address.
  3. Откройте файл docker-compose.yml в любом текстовом редакторе.
  4. В строке 53 замените значение HOST_NAME на IP-адрес, который нашли в шаге 2.
  5. Сохраните файл.

Определение параметров почтового сервера

Для того, чтобы настроить отправку уведомлений и системных сообщений Рутокен Базой, понадобится следующая информация о почтовом сервере:

  • почтовый протокол (IMAP или POP3);

  • адреса серверов входящей и исходящей почты;

  • порт для входящей почты;

  • порт для исходящей почты;

  • способ авторизации (обычный пароль или OAuth);

  • используются ли протоколы SSL и TLS.

Установка Рутокен Базы

  1. Откройте терминал.

  2. В терминале перейдите в корень каталога с установочными файлами Рутокен Базы:

    cd /путь/к/каталогу/с/файлами

  3. Запустите скрипт установки:

    sudo ./install.sh

Настройка почты

Добавление почтового домена

Если для отправки уведомлений будет использоваться общедоступная почтовая служба (например, Gmail), после входа в Рутокен Базу можно сразу перейти к настройке адреса.

  1. В браузере перейдите по адресу <IP-адрес сервера Рутокен Базы>:8080. Например: 127.0.0.1:8080.

  2. Введите логин «Administrator» и пароль «aktivsoft».

  3. В левом верхнем углу нажмите логотип Рутокен Базы и перейдите в раздел Settings.

  4. В колонке Email / Notification нажмите Email Domain.

  5. Справа вверху нажмите кнопку Add Email Domain.

  6. Заполните форму:

    • Domain Name — название домена;

    • Incoming Settings:

      • Incoming Server — сервер входящей почты;

      • Port — порт входящей почты;

      • Use IMAP — если используется протокол IMAP;

      • Use SSL — если используется протокол шифрования SSL;

      • Use STARTTLS — для использования команды StartTLS (только для IMAP);

      • Attachment Limit — ограничение на размер вложений.

    • Outgoing Settings:

      • Outgoing Server — сервер исходящей почты;

      • Port — порт исходящей почты;

      • Use TLS — если используется протокол шифрования TLS;

      • Use SSL — если используется протокол шифрования SSL;

      • Append Emails to Sent Folder — сохранять исходящие письма в папку Sent/Отправленные.

  7. Пролистайте страницу вверх и в правом верхнем углу нажмите Save, чтобы сохранить изменения.

    Если при сохранении возникнет ошибка, проверьте, верно ли указаны порты и методы шифрования.

Добавление почтового адреса для отправки системных писем

  1. В левом верхнем углу нажмите логотип Рутокен Базы и перейдите в раздел Settings.
  2. В колонке Email / Notification нажмите Email Account.
  3. Справа вверху нажмите кнопку Add Email Account.
  4. Заполните форму. Для настройки системных уведомлений необходимо заполнить следующие поля:
    • Account:
      • Email Address — адрес почты, который будет использоваться для отправки уведомлений;
      • Domain — название домена, настроенного в предыдущем разделе инструкции. Не нужно заполнять, если заполняется поле Service;

      • Service — выбор одной из предустановленных почтовых служб;

        У почтовых служб в этом списке есть ограничения на количество исходящих писем за определенный срок. Если вы используете одну из этих служб, убедитесь, что массовые рассылки уведомлений сотрудникам не превысят ограничения тарифа.

      • Email Account Name — название аккаунта, которое будет использоваться как имя отправителя. Необходимо в данное поле ввести Support.
    • Authentication:
      • Method — способ аутентификации. Поддерживается базовая аутентификация (по логину и паролю) и протокол авторизации OAuth.
        • Password — пароль от почты. Заполняется, если выбран метод Basic. При создании почтового аккаунта надо создать новый пароль для входа в систему Рутокен База. Он должен отличаться от пароля почтового аккаунта.
        • Connected App и Connected User — приложение с поддержкой OAuth и связанный с ним пользователь. Заполняются, если выбран метод OAuth.
      • Use ASCII encoding for password — использовать кодировку ASCII для пароля. При этом пароль должен состоять только из символов, входящих в таблицу ASCII, иначе при сохранении изменений в форме произойдет ошибка.
      • Use different Email ID — использовать другой Email ID для доступа к этой почте. Заполняется, если используется система доменных имен.
    • Incoming (POP/IMAP) Settings:
      • Enable Incoming — включить получение входящих писем на эту почту.
    • Outgoing (SMTP) Settings:
      • Enable Outgoing — включить отправку исходящих писем с этой почты.

  5. Пролистайте страницу вверх и в правом верхнем углу нажмите Save, чтобы сохранить изменения.

    Если при сохранении возникнет ошибка, проверьте, верно ли указаны порты и методы шифрования.

Смена пароля администратора

После завершения установки и первичной настройки, рекомендуем сменить пароль от аккаунта администратора. Для этого:

  1. Перейдите в раздел Сотрудники > Пользователи.
  2. Нажмите на имя пользователя Administrator.
  3. Пролистайте страницу вниз, нажмите Change Password и в открывшемся поле введите новый пароль.
  4. Пролистайте страницу вверх и в правом верхнем углу нажмите Save, чтобы сохранить изменения.

  • No labels