Веб-консоль
Веб-консоль — это интерфейс Arkvory в браузере. Она входит в состав сервера, поэтому отдельно её устанавливать не нужно. Откройте /console/ по адресу вашего сервера, например http://127.0.0.1:8080/console/ на самом сервере или https://arkvory.example/console/ после настройки HTTPS.
Консоль использует тот же HTTP API, что и клиент командной строки и SDK. Сервер проверяет каждый запрос. Если кнопка скрыта, это лишь означает, что ваша учётная запись или ваш ключ не могут использовать эту операцию.
Структура интерфейса
Боковая панель группирует разделы. На узком экране она превращается в кнопку Разделы.
| Группа | Разделы |
|---|---|
| Библиотека | Артефакты, Пакеты, История файлов, Свойства артефакта |
| Передачи | Загрузка, Скачивания |
| Ресурсы | Пользователи и доступ, Репозитории, Сервисный доступ, Обновления, Резервные копии, Начало работы, API и CLI |
В верхней панели показаны заголовок раздела, кнопки Загрузить файл и Обратная связь и элементы управления оформлением и языком.
У каждого раздела свой адрес, например #/catalog, #/packages или #/backups. Открытый артефакт имеет адрес #/artifact/<репозиторий>/<id>. Эти адреса можно добавлять в закладки и отправлять другим людям. В адресе никогда нет пароля, ключа или текста поиска. Если открыть ссылку до входа, консоль откроет её после входа.
Некоторые разделы видны только части пользователей:
| Раздел | Кому виден |
|---|---|
| Пользователи и доступ | Администраторам |
| Репозитории | Всем, кто вошёл |
| Сервисный доступ | Ключу восстановления и ключам операторов с делегированными правами |
| Обновления | Администраторам |
| Резервные копии | Администраторам и ключу восстановления |
Вход
Карточка Подключение к репозиторию находится в верхней части страницы.
- Заполните поля Имя пользователя и Пароль.
- Нажмите Войти. Сессия длится 12 часов.
- Консоль выбирает в поле Репозиторий первый репозиторий, который вам доступен для чтения. Чтобы работать в другом репозитории, введите его имя или выберите из списка.
Чтобы подключиться ключом вместо пароля, откройте Подключиться ключом сервиса или автоматизации, вставьте ключ и нажмите Подключиться. Ключ остаётся в памяти этой вкладки браузера. Консоль его никогда не сохраняет.
Кнопка Регистрация появляется, только если администратор разрешил самостоятельную регистрацию. Кнопка Отключиться завершает подключение.
После входа с паролем вам доступны Сменить свой пароль и Персональные токены доступа. Персональный токен доступа — это ключ для ваших собственных инструментов. См. Учётные записи и доступ.
Первый владелец
В новой установке нет учётных записей. В Windows владельца создаёт программа установки. В остальных установках создайте владельца в консоли:
- Откройте раздел Начало работы и разверните Создать первого владельца.
- Вставьте ключ восстановления из файла
config/bootstrap-token.txtв каталоге установки. - Введите имя и пароль не короче 12 символов, затем нажмите Создать владельца.
- Войдите с новым именем и паролем.
Форма работает, только пока нет ни одной учётной записи. Владелец — администратор. Кроме того, владелец получает доступ на запись в репозиторий releases через группу arkvory-owners.
Библиотека
Артефакты
В разделе Артефакты перечислены опубликованные файлы репозитория. Ищите по имени или по значению метаданных. Чтобы показать одну метку, используйте Фильтр по метке, а для точного ключа и значения — Точные метаданные. В каждой строке указаны имя, размер, время публикации, стадии и метки. Нажмите Скачать, чтобы скачать файл, или Открыть, чтобы увидеть его свойства. Кнопка Загрузить ещё показывает следующую страницу.
Пакеты
В разделе Пакеты перечислены зарегистрированные версии UPack. Отфильтруйте их по полям Группа UPack и Имя пакета, настройте Сортировать и Группировать, затем нажмите Применить. В столбце стадий видно, куда продвинута каждая версия. См. Пакеты.
История файла
Путь к файлу, например builds/game/1.4/GameSetup.exe, может много раз указывать на новое содержимое. Каждое изменение — это новая версия. В разделе История файлов введите путь и нажмите Загрузить историю. Вы увидите каждую версию с автором и временем. Любую версию можно открыть, чтобы скачать её исходное содержимое. Восстановление старой версии создаёт новую версию и ничего не удаляет. См. Файлы и пути.
Свойства артефакта
Раздел Свойства артефакта показывает один артефакт:
- Сводка: Размер, Загружен и SHA-256 с кнопкой Копировать.
- Свойства: Метки, Коллекции и Метаданные сборки. Нажмите Сохранить изменения, чтобы сохранить их. Сам файл не меняется.
- Действия: Скачать; Ссылка на скачивание создаёт ссылку, которая работает один час без ключа; Зарегистрировать UPack индексирует архив UPack.
- Ссылка на файл: Привязать файл делает этот артефакт текущим содержимым пути к файлу.
- Продвижение: Добавить стадию отмечает артефакт стадией, например
qaилиrelease. Продвинуть публикует его в другом репозитории. См. Продвижение. - Манифесты и дополнительные файлы: Добавить вложение привязывает к этой сборке манифест, SBOM, подпись, отчёт или другой файл. История вложений показывает прежние наборы.
- Удаление артефакта: Проверить зависимости показывает, что ещё использует артефакт. Чтобы удалить артефакт, вставьте его ID и нажмите Удалить этот артефакт. Для удаления нужен ключ сервиса с действием
artifact.delete; вход с паролем, персональный токен и ключ восстановления удалять не могут.
Передачи
Загрузка
В разделе Загрузка выберите файл и нажмите Загрузить / продолжить. Консоль сначала вычисляет SHA-256 файла, затем отправляет его по частям. Кнопка Пауза останавливает передачу и сохраняет уже загруженные части.
Чтобы продолжить позже, сохраните ID загрузки. Откройте Продолжить загрузку, выберите тот же файл и введите ID загрузки. Во время загрузки браузер предупредит вас, если вы попытаетесь покинуть страницу. См. Передачи.
Скачивания
Раздел Скачивания — это очередь файлов, которые вы скачиваете из консоли. Консоль проверяет SHA-256 каждого файла, прежде чем сохранить итоговый файл.
- В Настройки очереди задаются Одновременные скачивания (от 1 до 8), Интервал запуска, мс и Предел ожидания, секунды.
- Кнопки Приостановить все, Продолжить очередь, Отменить ожидающие, Отменить все и Убрать завершённые управляют всей очередью.
- После перезагрузки страницы войдите снова и нажмите Восстановить очередь. Затем возобновите каждый файл и выберите, куда его сохранить.
Для больших скачиваний нужен Chrome или Edge на защищённом адресе (HTTPS или локальный компьютер). Временные данные хранятся в закрытом хранилище браузера.
Ресурсы
Пользователи и доступ
Здесь администраторы управляют людьми. В списке Учётные записи перечислены учётные записи, в списке Группы и права — группы. Используйте Создать пользователя, Сменить пароль, Создать группу и Участники групп. В Доступ к репозиториям дайте группе доступ Чтение или Чтение и запись к репозиторию по имени. Отдельного шага для создания репозитория нет: он появляется, как только его имя указано в выданном доступе или в политике сервисной учётной записи.
Репозитории
Раздел Репозитории показывает репозитории, которые вы видите, и Ваши права в каждом из них. В каждой карточке есть Открыть файлы, Хранение и очистка (квота, автоматическая очистка и физическая очистка; нужен ключ сервиса с действием storage.read или storage.manage) и, для администраторов, Управление доступом. Репозиторий-зеркало помечен значком Зеркало. См. Репозитории и Хранение.
Сервисный доступ
Здесь создаются учётные записи для инструментов и систем CI. Чтобы увидеть этот раздел, подключитесь с ключом восстановления или ключом оператора. Нажмите Создать сервисный аккаунт, затем задайте Права на репозитории. Кнопки Набор для чтения и Набор для публикации заполняют типовые наборы прав.
Чтобы выпустить ключ, откройте Сервисные ключи и нажмите Выпустить ключ. Секрет показывается только один раз. Скопируйте его, подтвердите Секрет сохранён и нажмите Активировать ключ. Ключ, который не активирован, истекает через 15 минут. Кнопка Ротировать заменяет ключ новым, а Отозвать — прекращает его действие. В разделе Делегирование управления владелец может дать оператору ограниченные права администрирования.
Обновления
Раздел Обновления показывает Установленная версия и Последний стабильный релиз. Нажмите Проверить сейчас или Установить обновление. В Автообновление включите Автоматически устанавливать совместимые стабильные релизы и выберите Час обслуживания (UTC). См. Обновления.
Резервные копии
Раздел Резервные копии показывает, исправны ли резервные копии, последнюю копию, следующий запуск, агент резервного копирования и хранилище копий. Нажмите Создать копию сейчас, чтобы запустить резервное копирование. В Точки восстановления перечислены точки восстановления; можно проверить каждый байт точки или закрепить её. В Расписание и хранение задаются время ежедневного запуска, часовой пояс и число хранимых точек. Восстановление выполняется командой на сервере. См. Резервные копии.
Начало работы и справочник API
Раздел Начало работы показывает первые шаги для нового сервера. В разделе API и CLI перечислены примеры команд. Кнопка Загрузить доступные операции API показывает операции API, которые может вызывать ваша текущая учётная запись или ключ.
Обратная связь
После входа кнопка Обратная связь отправляет сообщение в ProAnimaStudio через хаб. Можно добавить до 6 изображений и адрес электронной почты для ответа. Администраторы могут приложить журнал сервера. Нажмите Показать, что будет приложено, чтобы увидеть, что именно будет отправлено.
Оформление и язык
У параметра Оформление три значения: Системная, Светлая и Тёмная. В списке Язык каждый язык консоли указан его собственным названием: English, Русский, Español, Français, Deutsch, Português, 中文, 日本語, 한국어, हिन्दी и العربية. Страница переключается сразу, без перезагрузки и без потери введённого текста; арабский текст читается справа налево. При первом посещении консоль учитывает языки браузера и, если подходящего нет, использует английский. Кнопка Документация в разделе API и CLI открывает эту документацию на языке консоли. Браузер сохраняет только тему и язык и ничего не сохраняет об учётной записи или репозиториях.