Quick start

This quick start guide will walk you through setting up Small-Shell using the default web server included in the package.

Setup Env

First of all, add small-shell user to the OS and then install required commands and libraries. Required commands and libraries are "curl, bc, cron, npm, php, jq". In this example, will use the apt command on Ubuntu or Debian for installation.

# add a user
sudo useradd -s /sbin/nologin small-shell

# update apt list and install curl
sudo apt update
sudo apt install curl

# install bc and crontab if its not installed
sudo apt install bc
sudo apt install cron

# install npm/php libraries, php will be used for encoding and node.js will be used for writing Web server
sudo apt install npm
sudo apt install php

##install jq
sudo apt install jq

Installation

Once installed required commands and libraries, let's install small-shell from GitHub.

# install
cd /usr/local
sudo git clone https://github.com/small-shell/small-shell.git
sudo chown -R small-shell:small-shell /usr/local/small-shell
sudo chmod 755 /usr/local/small-shell/adm/gen

Generate a Databox

Then Let's generate databox as the data store of Web App. For more details, please see the DATA shell documentation.

sudo /usr/local/small-shell/adm/gen -databox
#-> dialog will be started

Dialog

In this example, "item_name" is set as primary key.

Databox Name: item.db
Primary Key Name: item_name
Primary Key Label: Item Name
Add more columns to the databox? (yes | no): yes
Col2 Key Name: description
Col2 Key Label: Description
Data Type (text | select | radio | checkbox | email | num | tel | date | date-time | url | textarea | file | pdls | mls): text
Set this as required? (yes | no): yes
Add more columns to the databox? (yes | no): no


The databox will be generated in the following order. Please check it.
-----------------------------------------------------------------
Databox Name:item.db
#primary_key
name="item_name"
label="Item Name"
type="text"
option="required"

#key(col2)
name="description"
label="Description"
type="text"
option="required"
-----------------------------------------------------------------
Is that OK? (yes | no): yes

Generate Base App

Once databox is ready, let's generate Base App.

sudo /usr/local/small-shell/adm/gen -app

In this example, HTTP is used as the protocol. If you have an SSL certificate and key, use HTTPS instead. Alternatively, if you want to generate a Let's Encrypt SSL certificate, please refer to the cookbook.

Type of App (1.BASE | 2.FORM | 3.CUSTOM): 1
Type of Server (1.small-shell Web srv | 2.other Web srv): 1
protocol (http | https): http
Web Server FQDN or IP addr (e.g. 192.168.10.1): $your_server_FQDN

Add a user

The following example shows how to add the username "test", "test" can initialize and get base64 key by accessing the URL that will be generated by the command.

sudo /usr/local/small-shell/adm/ops add.usr:test

Please notice that the URL can be accessed only 1 time.

-------------------------------------------------------------------------------
This is the URL for key initialization and generation for test on Base App
-------------------------------------------------------------------------------
http://${your_server_FQDN}/cgi-bin/auth.base?initialize=*****26fd2,4c5a2ae68d20e530b4ce457c71eae42590135268e1fb933a945f7e188678ccf4

End user can access to Base App by clicking the button and key will be stored to local storage of browser.

Access to Base App

The authentication page image of Base App is shown below. The access URL will be shown in the end of the gen dialog but basically it will be "http://${your_server_FQDN}/base". The key will be inserted automatically if it's stored in local storage.

Base App Features

End user can use following features on Base App.

• Push or Get data through simple UI
• Use spaces to perform an and search [e.g. word1 word2]
• Multiple sorting options using sort command
• Search using specific key of column [e.g key{wordA}]
• Download search result by CSV format
• Import Data with CSV format
• Define number of line per page [e.g #line:20] [e.g word #line:20]

• Analyze data using linux commands [grep, wc, awk, uniq, sed, tail, head, nl, sort, cut ..]
• Search log with freewords by adding tag [e.g. word1 word2 #log]
• Show statistics #stats, if you define statistics job.

Re-generate initialize URL

If end user lost their key, you can re-generate initialize URL by following command. In this example, admin will re-generate initialize URL for user name "test"

sudo /usr/local/small-shell/adm/ops initialize.usr:test

SELinux setting change

If you are using SELinux, change to permissive mode and then make specific rule for SElinux before enforcing.

## check SELinux
sestatus
## if current mode is enforcing. change to permissive. then make rule later.
sudo vi /etc/selinux/config
SELINUX=permissive
##reoobt
sudo reboot

Web server operation

If you want to restart Web server, use systemctl command.

sudo systemctl restart small-shell

# check process
ps -ef | grep app.sh
# check log
ls -ltr /var/www/log

Update to the latest version

You can update small-shell very easily. Here is an example of update procedure.
Once you clone the latest code, please re-generate Base App.

cd /var/tmp
sudo git clone https://github.com/small-shell/small-shell.git
sudo \cp -Rf small-shell/* /usr/local/small-shell/
sudo rm -rf small-shell

# re-generate Base App
sudo /usr/local/small-shell/adm/gen -app
-----------------------------------------------
Type of App (1.BASE | 2.FORM | 3.CUSTOM): 1
------------------------------------------------
-> dialog will be started

Create Custom App

Custom App is editable app that you can add many functions to the app. See detail in here.