С помощью Gramax можно очень быстро развернуть собственный портал с документацией по продукту для читателей. Для этого не нужно обладать техническими знаниями или привлекать инженеров.

Что понадобится:

  1. Хранилище GitLab или GitHub.

  2. Собственный сервер или аккаунт в облаке. В этой статье рассмотрим процесс разворачивания в Yandex Cloud, так как он дарит грант за регистрацию.

Шаги:

  1. Создание каталога.

  2. Публикация каталога в хранилище.

  3. Создание виртуальной машины.

  4. Загрузка каталога на созданный портал.

Шаг 1. Создание каталога

  1. Откройте браузерное приложение app.gram.ax. Или скачайте десктопную версию с сайта gram.ax.

  2. Нажмите Создать новый.

  3. Добавьте новые статьи и оформите их. Например, создайте диаграмму, заметку, добавьте картинку.

  4. Измените URL статей.

  5. Настройте вид каталога на главной.

Шаг 2. Публикация каталога в хранилище

  1. Кликните значок с облаком в синей панели.

  2. Добавьте новое хранилище — GitLab или GitHub.

  3. Войдите в хранилище.

    1. GitHub — следуйте интерфейсным подсказкам.

    2. GitLab — создайте и укажите Access Token. Инструкция по созданию есть тут.

  4. Подключите хранилище — в нем автоматически появится репозиторий с созданным каталогом.

Шаг 3. Создание виртуальной машины

  1. Создайте аккаунт в Yandex Cloud или войдите в существующий.

  2. Создайте платежный аккаунт. Он нужен для того, чтобы Yandex выделил грант на тестирование в размере 4000 рублей. С карты спишется 11 рублей. Позже карту можно отвязать.

  3. Создайте ресурс Виртуальная машина.

  4. Укажите имя машины — например,  testgramax .

  5. Перейдите на вкладку Container solution и кликните Настроить.

  6. Перейдите на вкладку Docker compose.

  7. Cкопируйте настройки:

    Docker compose

    services:
    gramax:
    image: gramax/gramax:latest
    container_name: gramax
    restart: unless-stopped
    ports:
    - 80:80
    environment:
    - ADMIN_LOGIN=admin
    - ADMIN_PASSWORD=password
    - AUTO_PULL_TOKEN
    - AUTO_PULL_INTERVAL
    volumes:
    - catalogs:/app/data
    volumes:
    catalogs:
    name: "catalogs"

  8. Вставьте скопированный текст в поле Docker compose. В нем можно заменить некоторые параметры:

    1. Номер порта. Если у вас локально что-то развернуто на 80:80 — замените его. Например, на порт 81:80.

    2. Логин и пароль администратора. Администратор добавляет и обновляет новые каталоги на портале. Чтобы в админку никто не смог забраться без вашего ведома, замените данные.

  9. Нажмите Применить.

  10. В блоке Доступ задайте любое имя и сгенерируйте SSH-ключ. Для этого откройте терминал на компьютере.

    1. Введите команду: для Mac —  ssh-keygen -t ed25519 -f ~/.ssh/yandex_cloud_gramax , для PowerShell —  ssh-keygen -t ed25519 -f $env:USERPROFILE\.ssh\yandex_cloud_gramax .

    2. Нажмите 3 раза  Enter .

    3. Скопируйте ключ командой: для Mac —  cat ~/.ssh/yandex_cloud_gramax.pub | pbcopy , для Win —  cat ~/.ssh/yandex_cloud_gramax.pub | clip .

  11. Вернитесь в Yandex Cloud и вставьте ключ в поле. Также задайте логин администратора — например,  testgramax .

  12. Нажмите Создать ВМ.

Шаг 4. Загрузка каталога на портал

Теперь нам нужно открыть портал, который мы только что создали. Он доступен по адресу:  http://{ip адрес}:{порт}/admin . Где:

  •  ip-адрес Публичный iPv4 в списке виртуальных машин в Yandex Cloud.

  •  порт  — указывали в Docker compose. Если оставили по умолчанию, удалите из пути этот параметр.

По получившейся ссылке переходим в админку портала для читателей.

  1. Введите логин и пароль администратора. Их указывали в 4 шаге. Если не указывали, используйте стандартные:  admin / password .

  2. Подключите хранилище. Как делали это во 2 шаге.

  3. Нажмите Загрузить существующий и выберите каталог в хранилище.

  4. Кликните Загрузить — каталог появится на главной и станет доступен читателям по той же ссылке.