Skip to content

ServantJS/servantjs-agent

Repository files navigation

ServantJS Agent

ServantJS Agent - клиентское приложение для ServantJS сервера, главной задачей которой является прием и обработка поступающих заданий от сервера. После выполнения каждого задания, клиент отправляет отчет на сервер о выполненных командах и статусе задания.

Агент, также как и сервер, поддерживает расширение функционала за счет middleware обработчиков и дополнительных модулей.

Создание модуля

Структура модуля

Ниже представлена базовая структура каждого модуля.

module_name/
├── middlewares/
│   ├── middleware_handle.js
│   ├── ...
│   └── index.js
├── index.js
└── module.js

index.js файл должен вернуть массив middleware обработчиков и объект класса модуля. middlewares/index.js файл возвращает массив объектов, унаследованных от MiddlewareBase. module.js файл содержит реализацию класса модуля, который должен быть унаследован от ModuleBase.

В папке modules, в качестве примера, есть модуль template, в котором можно увидеть базу любого модуля.

Требования для установки

  • Node.js >= 5.0.0
  • NPM >= 2.0.0

Установка

Для установки можно воспользоваться файлом install.sh в корне проект. Он скачивает исходники проекта с github и копирует их в нужную директорию. Также создает удобный линк для запуска агента. Установочный файл тестировался на Linux машинах. На других еще не тестировался.

Внимание! Прежде чем запускать агента, отредактируйте config.json файл!

Запуск

Для работы имеюся следующие функции:

    servant-agent start | stop | restart | status 

status - выводит информацию о процессе, запущенном с помощью утилиты forever для запуск node.js приложений в виде демона.

Контакты

Если у вас есть вопрос или предложения, то пишите на почту servantjs.company@gmail.com или оставляйте свои пожелания через "Issue" в github'е.

About

ServantJS agent for main server

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published