Быстрый старт

Быстрый старт поможет вам начать работу с VK Registry и познакомиться с его возможностями. VK Registry поддерживает разные форматы пакетов, в качестве примера рассмотрим работу с npm.

Пройдя все шаги быстрого старта, вы:

1. Войдете в VK Registry.
2. Настроите npm.
3. Опубликуете npm-пакет в репозиторий.
4. Скачаете npm-пакет из репозитория и проверите его работоспособность.

Созданный артефакт и локальные директории можно удалить после прохождения, а настройки npm — вернуть к исходному значению. Подробнее — в разделе Удалите неиспользуемые ресурсы.

Убедитесь, что выполнены следующие условия:

1. Вы знаете адрес экземпляра VK Registry. Пример: vk-registry.example.ru.

2. Для вас создана локальная учетная запись, есть логин и пароль для входа в VK Registry.

3. На вашем компьютере установлены Node.js и npm.

   Команды для проверки:

    
   $ node -v$ npm -v

   Если все установлено, в ответе будут версии. Пример: v20.11.0, 10.2.4.

   Если команда не распознается или возвращает ошибку — установите Node.js (с npm) и перезапустите терминал.

4. Вашей учетной записи назначена роль с правами на просмотр, скачивание, загрузку и удаление артефактов в репозитории npm. Пример набора прав доступа:

   • nx-repository-view-*-*-browse — для просмотра репозиториев;
   • nx-repository-view-*-*-read — для скачивания артефактов;
   • nx-repository-view-*-*-add и nx-repository-view-*-*-edit — для загрузки артефактов;
   • nx-repository-view-*-*-delete — для удаления артефактов.

5. Локальный репозиторий npm создан, вы знаете его название.

6. В VK Registry используется активная область безопасности npm Bearer Token Realm.

Обратитесь к администратору VK Registry вашей организации, чтобы проверить выполнение всех условий.

1. Откройте VK Registry в браузере.
2. Нажмите кнопку Войти справа сверху.
3. Выберите Войти через ID и пароль и укажите логин и пароль.
4. Нажмите кнопку Войти.

Для настройки npm вам понадобится URL-адрес репозитория, с которым вы будете работать.

1. Перейдите в раздел Репозитории → Просмотр.
2. Найдите локальный репозиторий npm. Используйте поиск по названию или фильтр по типу (Локальный) и формату (npm).
3. Нажмите для репозитория и выберите Копировать URL.
4. Сохраните URL-адрес.

Настройте npm для работы с репозиторием VK Registry:

1. Проверьте, какой реестр npm настроен на вашем компьютере:

    
   $ npm config get registry

2. Если вывод отличается от https://registry.npmjs.org/, сохраните его, чтобы позже корректно вернуть настройки.

3. Укажите VK Registry в качестве нового реестра npm:

    
   $ npm config set registry <URL_РЕПОЗИТОРИЯ>

   Здесь <URL_РЕПОЗИТОРИЯ> — URL-адрес локального репозитория npm, скопированный на шаге 2 (подробнее — в разделе Шаг 2. Получите URL-адрес репозитория).

4. Настройте аутентификацию:

    
   $ npm adduser --auth-type=legacy --registry=<URL_РЕПОЗИТОРИЯ>

5. Укажите запрашиваемые логин, пароль для входа в VK Registry и email.

6. Проверьте, что в файле ~/.npmrc (для Windows — C:\Users\<ПОЛЬЗОВАТЕЛЬ>\.npmrc) появились данные для работы с репозиторием VK Registry:

    
   registry=<URL_РЕПОЗИТОРИЯ>//<FQDN_РЕПОЗИТОРИЯ>/repository/<РЕПОЗИТОРИЙ>/:_authToken=<ТОКЕН>

   Здесь:

   • <URL_РЕПОЗИТОРИЯ> — URL-адрес локального репозитория npm, скопированный на шаге 2 (подробнее — в разделе Шаг 2. Получите URL-адрес репозитория).
   • <FQDN_РЕПОЗИТОРИЯ> — полное доменное имя узла вашего экземпляра VK Registry.
   • <РЕПОЗИТОРИЙ> — название локального репозитория npm.
   • <ТОКЕН> — токен доступа к локальному репозиторию npm, который будет привязан к вашей учетной записи.

Создайте npm-пакет и опубликуйте его в VK Registry:

1. Создайте директорию и инициализируйте проект:

   Linux/macOS

   Windows (PowerShell)

    
   $ mkdir ~/myapp && cd ~/myapp$ npm init -y

    
   mkdir ~/myapp; cd ~/myappnpm init -y

2. Проверьте, что в файле package.json указаны имя, версия и точка входа для npm-пакета:

    
   {  "name": "myapp",  "version": "1.0.0",  "main": "index.js"}

   Остальные поля, созданные командой npm init -y, можно оставить без изменений.

3. Создайте файл index.js с проверочной функцией, которая возвращает строку:

   Linux/macOS

   Windows (PowerShell)

    
   $ echo "module.exports = () => 'Hello from VK Registry';" > index.js

    
   Set-Content -Path index.js -Value "module.exports = () => 'Hello from VK Registry';"

4. Опубликуйте пакет:

    
   $ npm publish

5. Проверьте, что пакет myapp опубликован в репозитории VK Registry:

    
   $ npm view myapp version

   Ожидаемый вывод:

    
   1.0.0

   Если команда возвращает ошибку 404, проверьте URL-адрес репозитория, указанный на шаге 3, и права доступа. В редких случаях стоит подождать несколько минут.

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

1. Создайте директорию для нового проекта и инициализируйте его:

   Linux/macOS

   Windows (PowerShell)

    
   $ mkdir ~/myapp-new && cd ~/myapp-new$ npm init -y

    
   mkdir ~/myapp-new; cd ~/myapp-newnpm init -y

2. Установите пакет myapp в новый проект:

    
   $ npm install myapp

3. Проверьте, что пакет myapp появился в новом проекте, вызвав проверочную функцию:

    
   $ node -e "console.log(require('myapp')())"

   Ожидаемый вывод:

    
   Hello from VK Registry

Удалите npm-пакет myapp, чтобы освободить место в репозитории.

Также верните URL-адрес реестра npm по умолчанию. Иначе последующие запросы на установку пакетов будут отправляться в VK Registry.

1. Удалите артефакт из репозитория:

   1. Перейдите в раздел Репозитории → Просмотр.
   2. Нажмите на имя локального репозитория.
   3. Найдите артефакт в структуре репозитория и нажмите на его имя.
   4. Нажмите для артефакта и подтвердите удаление.

2. Верните реестр npm:

    
   $ npm config set registry https://registry.npmjs.org/

   Здесь https://registry.npmjs.org/ — реестр npm по умолчанию. Если ранее вы использовали другой реестр, укажите его (подробнее — в разделе Шаг 3. Настройте npm).

3. Верните файл ~/.npmrc (для Windows — C:\Users\<ПОЛЬЗОВАТЕЛЬ>\.npmrc) к исходному состоянию, удалив из него строки, добавленные на шаге 3:

    
   registry=<URL_РЕПОЗИТОРИЯ>//<FQDN_РЕПОЗИТОРИЯ>/repository/<РЕПОЗИТОРИЙ>/:_authToken=<ТОКЕН>

4. При необходимости удалите локальные директории проектов:

   Linux/macOS

   Windows (PowerShell)

    
   $ rm -rf ~/myapp ~/myapp-new

    
   Remove-Item ~/myapp, ~/myapp-new -Recurse -Force