Skip to content

Установка

Загрузка установочного файла

Скачайте установочный файл на ту машину, куда вы планируете установить Apiary. Выберите вариант установки:

  • Онлайн. Размер установочного файла чуть больше 100 килобайт. В процессе установки все необходимые для работы образы контейнеров будут скачаны на вашу машину. Для инсталляции на целевой машине требуется доступ в интернет. URL: https://hexway.io/download/apiary/latest.

  • Оффлайн. Размер установочного файла несколько сотен мегабайт (Осторожно, трафик!). Все необходимые для работы образы контейнеров уже упакованы в инсталлятор. Для инсталляции на целевой машине не требуется доступ в интернет. URL: https://hexway.io/download/apiary-offline/latest.

Чтобы скачать инсталлятор на машину, воспользуйтесь доступным вам инструментом:

  • curl — можно скачать прямо с целевой машины.
    Рекомендуем добавить опции --location --remote-header-name --remote-name.
    Выполните команду:

    curl --location --remote-header-name --remote-name https://hexway.io/download/apiary/latest

  • wget — можно скачать прямо с целевой машины.
    Рекомендуем добавить опцию --content-disposition.
    Выполните команду:

    wget --content-disposition https://hexway.io/download/apiary/latest

  • Или скачать по указанной выше ссылке локально на ваш десктоп и залить на целевую машину любым доступным способом (scp, ftp, smb и т.д.).

Установка

Для запуска установки выполните команду:

sudo bash ./install_hw_fh_en-US_2026.3.2.run

Команда для оффлайн-инсталлятора:

sudo bash ./install_offline_hw_fh_en-US_2026.3.2.run

По завершении установки 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/bin/show-info

⚠️ Как только процесс начальной инсталляции завершён, пароль суперпользователя из файла /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.

Использование прокси для реестра образов

Вы можете использовать ваш внутренний OCI совместимый реестр образов согласно политикам вашей организации.

В этом случае, вам требуется добавить два свойства в ваш файл конфигурации /opt/hw-fh/config/user.ini:

[main]
registry.prefix = reg-proxy.corp.example.com/hexway-proxy
registry.proxy.prefix = reg-proxy.corp.example.com/hub-proxy

Вы можете это сделать до первой инсталляции, или после ее завершения. Если вы меняете эти настройку на существующей инсталляции, то вам нужно сделать reconfig:

/opt/hw-fh/bin/reconfig

Свойство registry.prefix задаёт префикс для OCI совместимого реестра образов контейнеров, который может проксировать образы контейнеров Apiary или хранить их другим способом. Если это свойство не задано, то будет использоваться префикс по умолчанию: registry.hexway.io/hexway.

Свойство registry.proxy.prefix указывает на префикс для OCI совместимого registry сервера через который можно получить доступ к сторонним образам, используемым в Apiary:

  • redis

  • postgresql

  • rabbitmq

Если свойство registry.proxy.prefix не задано, то будет использоваться префикс по умолчанию: registry.hexway.io на котором в проекте library находятся копии используемых в Apiary образов сторонних контейнеров. Обратите внимание, что для корректной работы требуется, что бы в вашем прокси OCI реестра эти образы были доступны c префиксом library. Например:

  • Если в качестве registry.proxy.prefix указать docker.io то образы сторонних контейнеров будут получены из docker hub.
  • Если в качестве registry.proxy.prefix указать reg-proxy.corp.example.com/hub-proxy как в примере выше, то образы сторонних контейнеров необходимых для работы Apiary будут загружены из reg-proxy.corp.example.com/hub-proxy/library. Например, для redis полное имя образа будет: reg-proxy.corp.example.com/hub-proxy/library/redis:<tag>