Разделы документации

Скрипты

Небольшие программы на JavaScript или Python, которые Archepelag запускает вручную или по расписанию в изолированном контейнере.

Что это

Скрипт (в редакторе он называется workflow) — код автоматизации, который Archepelag выполняет в отдельном контейнере: без доступа к файлам портала, с ограничением по памяти и времени. Запустить его можно вручную или по расписанию.

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

Создание

На странице Создать новый скрипт заполните Название, при желании Описание и выберите Язык программирования. Скрипт создаётся с заготовкой кода и сразу открывается в редакторе.

ЯзыкЗапуск
JavaScriptРаботает (Node.js 20)
PythonРаботает (Python 3.12)
TypeScript, Bash, PowerShellМожно выбрать при создании, но запуск завершится ошибкой: исполнитель их пока не поддерживает

Список скриптов

Если скриптов нет, раздел показывает Нет скриптов и кнопку Создать скрипт. В таблице — Название, Описание, Язык, Создан и Последний запуск; метка Cron означает, что у скрипта есть расписание. Справа кнопки История запусков, Редактировать и Удалить.

Редактор

Слева — файлы скрипта: основной файл и, для JavaScript, package.json с зависимостями (только чтение). В центре — код, под ним панель с вкладками Переменные, Логи и Результат. Справа — Последние запуски со ссылкой Вся история.

Пока в файле только заготовка, поверх кода висит подсказка Создайте Workflow: Создать первый шаг вставляет шаблон, Добавить триггер открывает настройки.

КнопкаЧто делает
ЗапуститьВыполняет сохранённую версию сразу и показывает логи и результат
СохранитьСохраняет код, название и описание
ОпубликоватьСохраняет и переводит скрипт из Черновик в Активен
ИсторияОткрывает полную историю запусков

Ограничения запуска

ОграничениеЗначение по умолчанию
Время выполнения60 секунд, потом запуск прерывается и считается ошибкой
Память512 MB
ВыводДо 1 MB, дальше запуск прерывается
ЗависимостиДо 30 пакетов

Входные данные (вкладка Переменные) передаются только при запуске через API с токеном. Из редактора скрипт запускается без них.

Расписание

Расписание задаётся в Настройки workflow (шестерёнка в шапке редактора). Там же меняют название и описание.

  • Активен — включает запуск по расписанию. Ручной запуск работает и без него.
  • Расписание запуска (Cron) — выражение из пяти полей: минута, час, день, месяц, день недели. Есть готовые варианты, например Каждый день в 9
    .

История запусков

Страница История запусков показывает все выполнения скрипта с фильтром Статус:

СтатусЧто означает
УспешноСкрипт завершился с кодом 0
ОшибкаНенулевой код выхода, ошибка запуска или превышен лимит времени
ВыполняетсяЗапуск идёт сейчас
ОжиданиеЗапуск по расписанию стоит в очереди

Колонка Триггер показывает Вручную или По расписанию. Кнопка Детали открывает Детали выполнения с вкладками Обзор, Результат, Консоль и Входные данные. Строки, которые скрипт вывел в поток ошибок, в консоли помечены [STDERR].