Установка
Загрузка установочного файла
Скачайте установочный файл на целевую машину, то есть, на машину, на которую вы планируете установить Apiary. Есть два варианта установочного файла:
-
Онлайн. Размер установочного файла чуть больше 100 килобайт. В процессе установки все необходимые для работы образы контейнеров будут скачаны на вашу машину. Для инсталляции на целевой машине требуется доступ в интернет. URL: https://hexway.io/download/apiary/latest.
-
Оффлайн. Размер установочного файла несколько сотен мегабайт (Осторожно трафик!). Однако, все необходимые для работы образы контейнеров упакованы внутрь инсталлятора. Для инсталляции на целевой машине не требуется доступ в интернет. URL: https://hexway.io/download/apiary-offline/latest.
Для того что бы скачать инсталлятор на машину вы можете воспользоваться доступным Вам инструментом:
-
curl
- можно скачать прямо с целевой машины. Рекомендуем добавить опции--location --remote-header-name --remote-name
. Например, так: -
wget
- так же можно скачать прямо с целевой машины. Рекомендуем добавить опцию--content-disposition
.
Например, так: -
Или скачать по указанной выше ссылке локально на ваш десктоп и залить на целевую машину любыми доступными вам способами (
scp
,ftp
,smb
и т.д.).
Установка
Для запуска установки выполните команду:
или для offline инсталлятора:
По завершению установки Apiary автоматически запустится и вы увидите следующее сообщение:
hexway Apiary ready to use.
UI accessible on http://0.0.0.0 or https://0.0.0.0
Login as root@ro.ot password: <password>
⚠️ При установке Apiary без использования дополнительных параметров,
пароль пользователя root@ro.ot
будет сгенерирован автоматически.
Теперь вы можете открыть Apiary в браузере,
например: http://<ip-server>/
или http://<your-domain-name>/
,
если у вас есть доменное имя указывающее на этот IP адрес.
Что может быть важно:
-
Что-то пошло не так? Посмотрите главу ЧаВо, возможно, что ответ на ваш вопрос уже есть.
-
У нашего инсталлятора есть ряд дополнительных параметров. Возможно, что эти параметры могут вам пригодиться.
-
Здесь вы можете узнать как останавливать, запускать, обновлять и конфигурировать Apiary.
-
Скорее всего, вы хотите настроить доступ к Apiary с использованием
https
. Здесь вы можете узнать как это можно сделать. -
Возможно, что вы не хотите запускать на вашей машине что-то скачанное из интернета, с правами
root
не изучив это. здесь вы можете познакомиться с тем, как можно распаковать и изучить содержимое инсталлятора.
Пароли по умолчанию
После первого логина вам будет предложено сменить пароль суперпользователя root@ro.ot
.
Настоятельно рекомендуем вам это сделать и сохранить новый пароль в надёжном месте.
Пароль суперпользователя root@ro.ot
, сгенерированный во время установки Apiary
сохраняется в файл /opt/hw-fh/config/local.ini
.
Если вы стёрли содержимое терминала, не сохранив пароль, вы можете его посмотреть при помощи команды:
⚠️ Как только процесс начальной инсталляции завершён, пароль суперпользователя,
из файла /opt/hw-fh/config/local.ini
больше не используется.
А если вы, следуя нашим рекомендациям, сменили его после первого логина, то пароль,
хранящийся в файле /opt/hw-fh/config/local.ini
не имеет значения - он устарел.
Пути к файлам
Все файлы хранятся в директориях, перечисленных ниже:
-
/opt/hw-fh/
- базовая директория для хранения данных, конфигурации продукта, управляющих скриптов и прочих вспомогательных файлов; -
/opt/hw-fh/data
- в этой директории хранятся все изменяемые файлы, такие как:- данные встроенных в продукт СУБД (
postgresql
,redis
, etc); - файлы, проектов и уязвимостей;
- кеш обратного прокси сервера reverse proxy server (
nginx
);
- данные встроенных в продукт СУБД (
-
/opt/hw-fh/config
- в этой директории хранятся все конфигурации Apiary:- конфигурации, предоставленные в дистрибутиве;
- конфигурации, сформированные в процессе установки;
- пользовательские конфигурации - файл
/opt/hw-fh/config/users.ini
. Пример заполнения файлаusers.ini
можно посмотреть в файле/opt/hw-fh/config/user-template.ini
;
-
/opt/hw-fh/compose
: в этой директории хранится файл docker-compose, сформированный конфигуратором продукта из конфигурации, хранящейся в/opt/hw-fh/config
; -
/opt/hw-fh/systemd
: в этой директории хранятся файлы шаблонов дляsystemd
модуля и используемый в настоящее время systemd модуль.