Перейти к основному содержимому

Установка серверной версии

Установив AtChat, вы получаете 2 версии приложения: demo и production. Для demo версии не нужен лицензионный ключ и не требуется настройка или установка каких-либо отдельных компонентов. Она позволяет познакомиться с мессенджером и его возможностями, но не подходит для полноценного использования, поскольку не дает в полном объеме использовать функционал резервного копирования или настройки сохранности данных.

Перед началом установки

Убедитесь, что установлены следующие зависимости:

  1. zip
  2. docker
  3. docker-compose

Ознакомиться с инструкцией по уставновке Docker можно в официальной документации для вашей ОС:

Для запуска Production версии приложения необходимо дополнительно установить и настроить:

  1. PostgreSQL >= 11.2
  2. RabbitMQ >= 3.7
  3. Redis >= 5.0
  4. ElasticSearch >= 8.2

Demo версия приложения использует их Docker версии.

Установка

  1. Скачайте архив AtChat-v<Версия>.zip.
  2. Распакуйте архив.
  3. Запустите скрипт установки и ответьте на вопросы.
sudo bash ./atchat-docker-install.sh

Описание вопросов

  1. installation directory — папка, в которую будет установлено приложение. По умолчанию используется /opt/atchat/docker.
  2. HTTP site hostname — доменное имя, по которому будет доступен AtChat. По умолчанию используется имя хоста.
  3. HTTP port — порт сервера на котором будет доступен AtChat, по умолчанию 443.
  4. license key — лицензионный ключ приложения (в demo версии оставьте поле пустым).
  5. SMTP host — настройки почтового аккаунта.
  6. tls certificate path — путь до SSL сертификата, обязателен.
  7. tls key path — путь до приватного ключа SSL сертификата, обязателен.

Пример ответов на вопросы

Select the installation directory [/opt/atchat/docker]: /opt/atchat/docker
Atchat is going to be installed into /opt/atchat/docker
Enter the HTTP site hostname [ubuntu-no-vm]: localhost
Enter the HTTP port [443]:
Enter the license key:
Enter the SMTP host:
Enter the tls certificate path []: /tmp/fullchain.pem
Enter the tls key path []: /tmp/privkey.pem
Unpacking...
Configuring...

После установки

Создание docker volume

Создайте 2 docker volume:

  1. atchat-file-storage-vol — хранилище файлов, загруженных пользователями.
  2. atchat-data-storage-vol — хранилище файлов, необходимых для работы AtChat.

Пример создания docker volume:

docker volume create atchat-data-storage-vol
Важно

Чтобы узнать больше, обратитесь к документации Docker.

Настройка приложения

Важно

Изменить настройки можно только в production версии.

Основные настройки приложения находятся в файле конфигурации .env в папке, где установлен AtChat. Для запуска необходимо указать настройки подключения к PostgreSQL, RabbitMQ, Redis и ElasticSearch.

POSTGRES_PASSWORD=password # Пароль
RABBITMQ_PASSWORD=password
LOGSTASH_PG_HOST=postgres
LOGSTASH_PG_PORT=5432
LOGSTASH_PG_USER=postgres
LOGSTASH_PG_PASSWORD=password
LOGSTASH_PG_DB=atchat_db
POSTGRES_ENDPOINT=postgres://postgres:password@postgres:5432/atchat_db?sslmode=disable
RABBITMQ_ENDPOINT=amqp://rabbit:password@rabbitmq:5672/atchat_vhost
REDIS_ENDPOINT=redis://:@redis:6379/0
ELASTICSEARCH_ENDPOINTS=http://elasticsearch:9200

Для demo окружения можно оставить настройки по умолчанию.

Лицензионный ключ

Важно

Лицензионный ключ можно добавить или изменить только в production версии.

Лицензионный ключ указывается во время установки AtChat. Если по какой-то причине это не было сделано и вы хотите его указать или обновить:

  1. Откройте файл конфигурации .env. Он хранится в папке, где установлен AtChat.
  2. Укажите новый ключ в переменной ATCHAT_LICENSE и сохраните изменения.
Внимание!

После обновления ключа необходимо перезапустить сервер.

Запуск AtChat

В папке, куда вы установили AtChat, есть папка scripts. В ней есть несколько скриптов:

  1. atchat_start.sh / atchat_stop.sh — запуск / остановка production версии приложения.
  2. demo_start.sh / demo_stop.sh — запуск / остановка demo версии приложения.
Важно

Запуск приложения занимает некоторое количество времени. Если установка и настройка прошла успешно, подождите пока приложение запустится (пока не будет 200 ОК на <https://<HTTP site hostname>:<HTTP port>>/api/v1/health).

Первоначальная инициализация

После установки выполните следующие шаги:

  1. Откройте страницу инициализации приложения, доступную по адресу: <https://<HTTP site hostname>:<HTTP port>>/admin/welcome. Имя хоста и порт — те, что были указаны при установке. Например, https://demo.atchat.ru/admin/welcome.
  2. В открывшейся форме заполните все поля и нажмите Готово. Приложение будет инициализировано и будет создана учетная запись администратора с указанными в форме именем пользователя и паролем.
  3. Теперь можно открыть панель администратора <расположение atchat>/admin и продолжить настройку сервера.
Важно

Приложение можно инициализировать только один раз.