lmangani / ngcp-klish-config Goto Github PK

ngcp-klish-config 
=================

Sipwise NGCP/SPCE CLI shell based on klish/clish


                    #######
               #################
             ######         ######
            ####                ####
           ###                    ###
          ##                     EEEEEEEE
          ##                   EEEEE  EEEEE
          ##                  EEE        EEE
          ##                  EE          EED
           ###               EEE           EE
            ###              EEE           EE
             ## ####        ##EE          EEE
             ##################EE        EEE
            #####    #####     EEEEEE  EEEE
            ####                 EEEEEEEE
            ###                    EEEEEE
            ##                        EEE
     ####  ##  #####       E    E   E  EE    EEE   EEEEEE
   ###### ### #######  ##  EE  EE  EEE EEE EEEEEE EEEEEEE
   ######  ## ######## ##  EE  EE  EEE EEE EEEEED EEEEEEE
   ####    ## ###   ## ##  EE  EE  EEE EEE EEE    EEE
   ######  ## ###   ##     EE  EE  EEE EEE EEEEEE EEEEEE
     ####  ## ###   ##     EE  EE  EEE EEE    EEE EEE
    #####  ## ######## ##  EEEEEEEEEEE EEE   EEEE EEEEEEE
   ######  ## #######  ##  EEEEEEEEEEE EEE EEEEEE  EEEEEE
    ###     # ###            EEEEEEEE   E   EEE     DEEEE
              ###



WARNING:
=======

The status is work-in-progress. Do not expect a full blown shell just yet!
This package & its components are meant for a SIP:Provider CE 3.x Server *ONLY*


BASIC HOW-TO:
============

1) Clone & Install the system & software requirements:

    - NGCP-CLISH (https://github.com/sipwise/klish)
    - LUA-URI (https://github.com/sipwise/lua-uri.git)

2) Clone & Deploy NGCP-KLISH-CONFIG to your /etc:

        # git clone https://github.com/sipwise/ngcp-clish-config
        # cd ngcp-clish-config; cp -r etc/* /etc/
    
3) Add execution permisions to the launcher if needed, ie:

    # chmod +x /etc/cli.sh

4) Create a limited user (ie: cliuser) with default clish shell:

    # useradd -s /etc/cli.sh -r -M cliuser
    # passwd cliuser

5) Modify /etc/sudoers to allow 'cliuser'' to execute enable clish. For example:

    Defaults:cliuser targetpw
    cliuser ALL=(ALL) /usr/bin/clish, /usr/local/bin/clish



BASIC USAGE:
===========

1) SSH to the system as 'cliuser' using the new account or manually launch /etc/cli.sh

2) Use tab/autocompletion and ? to explore the menus, commands and parameters

3) Use 'enable' to enter priviledged mode (use the system's root password when asked)


EXAMPLE COMMANDS:
================

- coming soon! -