• Korean: 이 페이지는 아직 한글로 번역되지 않았습니다.

Jangbi-it Development

Jangbi-it uses Bash-it system overall. Differences are only few functions to override Bash-it's function. You could find it from janbi_it.sh.

# enable jangbi-it
$ cd /opt/jangbi
$ source jangbi_it.sh

# show enalbed plugins
$ jangbi-it show plugins
Plugin               Enabled?   Description
base                 [ ]        base tools
misc                 [ ]        miscellaneous tools
net-darkstat         [x]        darkstat install configurations.
net-dnscryptproxy    [x]        dnscryptproxy install configurations.
net-dnsmasq          [x]        dnsmasq install configurations.
net-hostapd          [x]        hostapd install configurations.
net-ifupdown         [x]        network configurations.
net-iptables         [x]        iptables install configurations.
net-knockd           [ ]        knockd install configurations.
net-netplan          [ ]        netplan install configurations.
net-sshd             [x]        sshd install configurations.
net-xtables          [x]        xtables install configurations.
os-aide              [x]        aide install configurations.
os-auditd            [x]        auditd install configurations.
os-conf              [x]        custom os configurations
os-disablebins       [x]        disable binaries.
os-firmware          [ ]        custom os firmware install in kernel.
os-kparams           [x]        custom kernel params in cmdline.
os-minmon            [x]        minmon install configurations.
os-redis             [x]        redis install configurations.
os-sysctl            [x]        sysctl install configurations.
os-systemd           [x]        setup systemd.
os-vector            [x]        vector install configurations.

# restart jangbi-it to reload src changes
$ jangbi-it restart

Documentation

Jangb-it's documentation uses mkdocs.

# making environment
$ cd /opt/jangbi
$ python -m venv .
$ source bin/activate

# install documentation dependency
$ pip install -r requirements.txt

# build mkdocs.yml
$ mkdocs build

# server from localhost
$ mkdocs serve

# you could open web brwoser http://127.0.0.1:8000/jangbi/

Jangbi init system

Because jangbi is running on every boot with rc.local. the init system will check enabled plugin's status and restart each plugin's daemon.

Plugin Development

Jangbi-it plugin uses mkdocstrings for documentation within the script. you could find more info here. syntax / tags / example shell file / example rendering

# enabling new plugin
$ janbi-it enable plugin new-plugin

used bash system

• composure : function organize system.
• bash-it : bash-it is base bash based system.
• slog : init script wizard system.

composure notations

cite about-plugin
about-plugin 'darkstat install configurations.'

function net-darkstat {
    about 'darkstat install configurations'
    group 'postnet'
    runtype 'minmon'
    deps  ''
    param '1: command'
    param '2: params'
    example '$ net-darkstat subcommand'
    local PKGNAME="darkstat"
    local DMNNAME="net-darkstat"
    BASH_IT_LOG_PREFIX="net-darkstat: "
...
}

plugin's group

there are three group types.

• prenet : apps running before network initializes.
• (net) : reseved types for processing to initialize network.
• postnet : apps running after network initializes.

plguin's runtype

• systemd : daemon managed by systemd.
• minmon : daemon managed by minmon.
• (none) : non-daemonized plugins.

plugin's deps

(in-development)

• any-text
• (none)

plugin documentation

these are rendering order for mkdocstring-shell.

1.   ## \brief darkstat install configurations.
2.   ## \usage net-darkstat [COMMAND]
     ## \usage net-darkstat install|uninstall|configgen|configapply|check|run|download
3.   ## \desc This tool helps install, configure, and manage darkstat (network traffic analyzer)
     ## for network monitoring. .
4.(options)
5.   ## \file /etc/super_script/default_conf.rc The default configuration file for my super script.
6.   ## \exit 1 Invalid command or parameters provided.
7.   ## \stdin 
8.   ## \stdout
9.   ## \stderr
10.  ## \function
10-1.## \function-brief
11.  ## \example Install and configure darkstat:
11-1.## \example-code bash
     ##   net-darkstat install
     ##   net-darkstat configgen
     ##   net-darkstat configapply
     ## \example-description
     ## In this example, we install darkstat, generate the configuration files,
     ## and apply them to the system for network traffic monitoring.
12.  ## \error Just like bugs, notes, caveats...
     ## An error is something the user should not do,
     ## something that is considered wrong or bad practice when using your script.
     ## If you want to document the standard error messages, or the exit status,
     ## see \stderr and \exit.
13.  ## \history 2018-08-31: this example was written.
14.  ## \note If shellman does not work as expected, please file a bug on GitHub.
     ## Here is the URL: https://github.com/pawamoy/shellman.
15.  ## \seealso A note about something else to look at.