Use apapche2
This is a quick start to use apache2 as Web server instead of default Web server.
Setup Env
First of all, please add small-shell user to the OS and then please install required commands and libraries. required commands and libraries are "curl, bc, cron, php, jq". In this example, will use apt command on Ubuntu for intallation.
# addd 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 apache2
sudo apt install apache2
sudo a2enmod cgid
sudo service apache2 restart
sudo update-rc.d apache2 defaults
# install php library, it will be used for url encoding (required)
sudo apt install php
##install jq
sudo apt install jq
Installation
Once installed required commands and libraries, let's install small-shell from git HUB. and then you need to edit sudoers file.
# 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
Sudo setting
# change sudo setting
sudo visudo
## add to last line
## sudo setting for httpd user (e.g.) www-data for apache2
www-data ALL=(small-shell) NOPASSWD: /usr/local/small-shell/bin/*, /usr/local/small-shell/sbin/*
Generate Databox
Then Let's generate databox as the data store of Web APP. DATA shell details are in DATA shell
sudo /usr/local/small-shell/adm/gen -databox
#-> dialog will be started
Note
You can exit dialog anytime with ctrl + C
Dialog
In this expamle, "item_name" is set as priary 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, detail of this APP is in APP shell
sudo /usr/local/small-shell/adm/gen -app
Type of APP (1.BASE | 2.FORM | 3.CUSTOM): 1
Type of Server (1.small-shell Web srv | 2.other Web srv): 2
#-> Dialog will be started, for making Base APP
Following is result of dialog, in this example http is used as protocol. if you want to use https, please create cert and key for the web server and deploy to your apache server.
# Dialog result
--------------------------------------------------------------------------
APP Type: 1.BASE
Srv Type: other
Protocol: http
APP Exec User: www-data
Root Directory: /var/www
CGI Directory: /usr/lib/cgi-bin
CGI base URL: http://${server}/
Static Page Directory: /var/www/html
Server: $server
Access URL: https://$[server}/cgi-bin/
--------------------------------------------------------------------------
Add symlink on ubuntu
If you are using ubuntu and apache2, please add symlink by answering "yes" in the dialog.
www dir must have relation with CGI dir. Is it OK to make symbolic link on /usr/lib ?
following command will be executed
-----------------------------------------------------------------
ln -s /var/www/bin /usr/lib/bin
ln -s /var/www/def /usr/lib/def
ln -s /var/www/tmp /usr/lib/tmp
-----------------------------------------------------------------
(yes | no): yes
Add user
Following example is adding user name "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^M
URL can be accessed only 1 time, please inform to the user
-------------------------------------------------------------------------------
This is the URL for key initialization and generation for test on Base APP
-------------------------------------------------------------------------------
http://${server}/cgi-bin/auth.base?initialize=*****26fd2,4c5a2ae68d20e530b4ce457c71eae42590135268e1fb933a945f7e188678ccf4
End user can access to the Base APP by click the button and key will be stored to local storage of browser.
Connect to the Base APP
Image of authentication page of Base APP is as following. the access URL will be shown in the end of the gen dialog but basically it will be "http://${FQDN}/base". key will be inserted automatically if it's stored in local storage.
Then end user can use following APP features as default. ofcourse you can make your own APP,
please see detail on Create Custom APP
Base APP FEATURES
- Push or Get datas thorough simplest UI
- Can use "And" search using space [e.g. word1 word2]
- Multi type of sort using sort command
- Serch 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]
+ Command Console
- 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, you need to define statistics job. Please see the pyshell for further details.
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
SE linux setting change
If you are using SE linux, pelase change to permissive mode and then please make specific rule for SE linux before enforcing.
## check SE linux
sestatus
## if current mode is enforcing. please change to permissive. then please make rule later.
sudo vi /etc/selinux/config
SELINUX=permissive
##reoobt
sudo reboot
Update to latest version
You can update small-shell very easily. this is exmaples of update procedure.
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
sudo /usr/local/small-shell/adm/gen #renew global.conf
Then please re-generate Web app using gen command if needed.