Информация, необходимая для установки

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

• Google Chrome 87.0 и выше;
• Mozilla Firefox 84.0 и выше;
• Safari 14.0;
• Opera 72.0 и выше.

Программное обеспечение может распространяться в виде Интернет-сервиса.

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

Минимальные характеристики сервера

Программное обеспечение может сопровождаться установкой на собственный сервер, для установки системы PARTS SOFT требуется сервер с следующими минимальными характеристиками:

• 3 ядра CPU
• 4 GB оперативной памяти (RAM)
• 30 GB SSD, NVME диска
• Операционная система Ubuntu 22.04

Для развертывания сайта используется Ansible (лицензия GNU General Public License v3 (GPL-3.0)) — это программное решение для удаленного управления конфигурациями, которое позволяет настраивать удаленные машины. Допускается минимальная версия Ansible 2.9.21 или выше.
Перед началом развертывания, необходимо настроить Ansible и указать необходимые данные, такие, как:

• домен, на котором будет запущен сайт;
• IP адрес сервера, на котором будет развернута система и прочие данные, которые будут описаны ниже.

Настройка Ansible

ШАГ 1. Необходимо подключиться по SSH к удаленному серверу и прописать SSH ключи для пользователя root. Это необходимо, чтобы Ansible мог успешно подключаться к серверу без ввода паролей.

ШАГ 2. Перейдите к настройке самого Ansible. Для этого необходимо из-под папки проекта, в директории deploy/hosts/, в файле client, указать IP адрес сервера, на котором будет запущен сайт. Если файла client нет, необходимо его создать.

На примере файла ниже 77.88.8.8 — это IP адрес сервера.

Пример файла

ШАГ 3. В папке проекта, в директории deploy/vars/, найдите файл default.host.data.example.yml и переименуйте его в default.host.data.yml.

Пример структуры файла:

Пример структуры файла

Подробнее о значениях:

• subdomain — используется для создания поддоменов, значение которого указано в subdomain, создаст в конфигурации веб-сервера поддомен, который будет частью домена более высокого уровня. Например, конфигурация subdomain: partssoft в систему домен partssoft-www.ps-ex.ru для клиентской части и partssoft-admin.ps-ex.ru , для доступов в админпанель сайта;
• domain — подключает любой клиентский домен, по которому будет работать сайт;
• syn_domains — используется для синонимов домена. Основной домен у сайта может быть один, но через syn_domains можно подключить два и более доменов, которые будут перенаправлять на основной домен, который был указан в domain;
• restore_user — используется как системное лого, которое отвечает за создание резервных копий либо для восстановления сайта из резервной копии. Обычно restore_user такой же, как subdomain;
• www_https: 'no' — используется для установки SSL (HTTPS) сертификатов на основной домен. При развертывании всегда должно стоять в положении 'no', так как сертификат выдается после полного запуска сайта;
• external: 'no' — используется для установки ограничений на стороне сервера. Например, в положении 'no' , устанавливается запрет на доступ по SSH с использованием логина и пароля, запрет на подключение по SSH с любых IP, кроме разрешенных (на сервер загружается список IP адресов, которым разрешен доступ), а также устанавливается запрет на доступ к базе данных на сервере извне.

Для автоматизации и упрощения развертывания мы применяем Anistrano в связке с Ansible. Перед тем как начать развертывание, необходимо настроить файл default.anistrano.yml, который находится в директории.

Файл необходимо привести к следующему виду:
ansistrano_shared_paths: ["shared"]
ansistrano_deploy_to: "/home/parts-soft/www/parts-soft"
ansistrano_keep_releases: 3
ansistrano_version_dir: "releases"
ansistrano_current_dir: "current"
ansistrano_current_via: "symlink"
ansistrano_deploy_via: rsync
ansistrano_allow_anonymous_stats: false
ansistrano_deploy_from: "/home/user/code/base/"

Подробнее о важных значениях в этом файле:

• ansistrano_deploy_via — метод развертывания, может иметь два положения: rsync (более быстрый) и copy;
• ansistrano_deploy_from — полный путь до директории с проектом.

После того как были добавлены SSH ключи на сервер, на который будет установлен сайт, был прописан IP адрес сервера в файле client, и настроены файлы default.host.data.yml и default.anistrano.yml, можно приступать к развертыванию системы.

Развертывание системы запускается командой ansible-playbook -i deploy/hosts/client deploy/server.install.yml из-под папки проекта.

Пока выполняется развертывание сайта, можно подключить основной домен к IP адресу сервера чтобы сайт был доступен по основному домену.

По завершению развертывания, сайт будет доступен по поддомену, основному домену (если IP адрес был подключен к серверу), либо по IP адресу. В этом случае откроется админпанель сайта.