status-im
/
cabot-check-nim-waku
mirror of https://github.com/status-im/cabot-check-nim-waku.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
About Cabot plugin for running a nim-waku canary
9 Commits 1 Branch 0 Tags 52 KiB
Python 100%
Go to file
Jakub Sokołowski 2d39fe1319
use upper case ERROR log level by default 
Signed-off-by: Jakub Sokołowski <jakub@status.im>
 		2022-11-16 22:21:23 +01:00
cabot_check_nim_waku use upper case ERROR log level by default 2022-11-16 22:21:23 +01:00
.gitignore add Python setup files and gitignore 2022-11-04 09:34:54 +01:00
LICENSE add MIT license 2022-11-04 09:34:51 +01:00
README.md add readme file 2022-11-04 09:34:56 +01:00
setup.cfg add Python setup files and gitignore 2022-11-04 09:34:54 +01:00
setup.py add Python setup files and gitignore 2022-11-04 09:34:54 +01:00

README.md

Description

This is a Cabot Check Plugin for running a nim-waku canary.

Installation

The simplest way is to just use:

pip install git+git://github.com/status-im/cabot-check-nim-waku.git

Edit conf/production.env in your Cabot clone to include the plugin:

CABOT_PLUGINS_ENABLED=cabot_check_nim_waku,<other plugins>

Configuration

This plugin requries one environment variable:

NIM_WAKU_CANARY_PATH=<path_to_nim_waku_canary_binary>

API

The plugin exposes the standard check API under:

/plugins/cabot_check_nim_waku/api/nim_waku_checks/

Which accepts the standard GET/POST/OPTIONS methods.