CmdFreak 1.2.0

1. CmdFreak summary

Several information systems and application software suites use a RDBMS (Relational Database Management System) as a persistence mechanism for their own data. The range of RDBMS usage shows a tendency of expansion. Most RDBMSs are used as a background service for information systems and application software. However, such systems can also be accessed directly for data mining, quicker commercial operation and maintenance. An appropriate RDBMS can be chosen to match the characteristics of the target information system and application software. As a result, multiple RDBMSs are often used simultaneously in the same business operation and maintenance environment. However, multiple RDBMS usage is characterized by the following problems:

Different data reference software applications need to be provided, which may increase the learning cost.
Data reference software needs to be installed on each client-side PC. The cost of introduction is therefore higher with a greater number of client PCs.

CmdFreak is a relational database viewer (data reference software) that provides solutions for the above problems.

CmdFreak supports the major free RDBMS MySQL, PostgreSQL and MariaDB systems, providing a common user interface for these RDBMSs and enabling data reference as a common operation. It does not need to learn different reference software applications for multiple RDBMSs, which helps to reduce related learning costs.
CmdFreak works as web application software, and comes with an all-in-one installer incorporating web server software. This eliminates the need for web server pre-configuration and the use of script language. The introduction cost is practically zero.

CmdFreak provides the following functions for database reference:

List records/paging
Table selection
Table information reference
Column filtering and sorting
DBMS selection

2. System requirements

CmdFreak works on systems with the following specifications:

CPU: 2 GHz or more

Memory:1 GB or more

Free disk space: 20 MB or more

Operating systems/editions supported:
Windows 10
Windows Server 2016
Windows Server 2019

Web browsers supported:
Microsoft Internet Explorer 11
Microsoft Edge
Google Chrome
Mozilla Firefox

DBMSs supported:
MySQL 5.7 (+ ODBC Driver: MySQL Connector/ODBC 5.3)
MySQL 8.0 (+ ODBC Driver: MySQL Connector/ODBC 8.0)
MariaDB 10.3 (+ ODBC Driver: MariaDB Connector/ODBC 3.0)
MariaDB 10.4 (+ ODBC Driver: MariaDB Connector/ODBC 3.1)
PostgreSQL 9.6 (+ ODBC Driver: psqlODBC 9.6)
PostgreSQL 12.2 (+ ODBC Driver: psqlODBC 12.1)

3. Change history

Version 1.0.0 ---> 1.1.0

Support for displaying unlimited record.
Performance improvement for multiple user access.

Version 1.1.0 ---> 1.2.0

Responsive design has been adopted for smartphone user.
User management function has been added.

4. Installation

Execute cmdfreak.msi and launch the installer.
Follow the on-screen dialog prompts.
CmdFreak installer performs following steps during the installation.

Register exceptions of Windows firewall for CmdFreak.
Register service of CmdFreak to the target system.
Auto start of CmdFreak service and Web server.

Overwrite installation(Repair) can be performed if cmdfreak.msi is executed after CmdFreak installation. Note that the items shown below for overwrite installation.

Stop CmdFreak service before overwrite installation. If you perform the overwrite installation without service stop, restart of operating system is required after overwrite installation done.
During overwrite installation, port numbers which Web server and CmdFreak service use might be changed into default. Confirm the port number after overwrite installation.

5. Uninstallation

Select Remove CmdFreak with execution of cmdfreak.msi or perform uninstallation of CmdFreak from Control Panel.
CmdFreak uninstallation performs following things during uninstallation.

Auto stop of CmdFreak service and Web server.
Deletion of CmdFreak service from the target system.
Deletion of Windows firewall exception for CmdFreak.

6. Login to CmdFreak

Connect to the URL shown below by Web browser for use of CmdFreak after installation. If main console is displayed after login sequence of CmdFreak, it shows the installation is successfully completed.

http://<Host name or IP address of CmdFreak>:<Port number of Web server>/cmdfreak.html

In case of specification of default installations parameters : http://localhost/cmdfreak.html

Initial login user name and password are follows.

User name : admin
Password : manager

If main console is not appeared or an error ocurred, confirm the things shown below.

When host name is specified in the URL for the connection to CmdFreak from browser, confirm that the host name can be solved. In case the host name is not solved, change the host name to other name which can be solved, and then retry.
Confirm that CmdFreak(nginx.exe) is registered as an exception of Windows firewall. If not, register nginx.exe to the Windows firewall as an exception.
Confirm that the specified port number is not duplicated from other port numbers. If duplicated, specify the independent port number according to the description shown later.

7. Start/Stop CmdFreak service

Start and stop of CmdFreak service can be performed by Windows start menu.

[CmdFreak]-[Start CmdFreak service] : Start service
[CmdFreak]-[Stop CmdFreak service] : Stop service

8. Change IP address/host name and port number

CmdFreak uses two kinds of IP addresses/host names and ports.

IP address/host name and port of Web server
IP address/host name and port of CmdFreak service

In order to change the IP address/host name and port number after installation, following steps are required.

Stop CmdFreak service.
Change IP address/host name and port number.

In case you change IP address/host name and port number which CmdFreak service uses:
Specify IP address/host name and port number to servicehost and serviceport properties in <Installation folder>\CmdFreak\sample.conf
Specify IP address/host name and port number to proxy_pass of location /api/ section in <Installation folder>\CmdFreak\conf\nginx.conf

In case you change IP address/host name and port number which Web server uses:
Change listen and server_name in <Installation folder>\CmdFreak\conf\nginx.conf
CHange firewall setting if necessary.
Start CmdFreak service.

10. About ODBC driver

CmdFreak uses ODBC for connecting to RDBMS. Therefore ODBC driver needs to be installed into same server where CmdFreak works. ODBC driver needs to be choosen depending on the type of target RDBMS. For example, If you want to use MySQL, ODBC driver for MySQL is required. CmdFreak works as a 32-bit application hense ODBC driver has to be 32-bit edition of driver (Even if the operating system where CmdFreak works is 64-bit edition, 32-bit ODBC driver needs to be installed). ODBC driver is provided by the vendor who provides RDBMS. Download it from the vendoer Web site.

10. Management limitations

Maximum length of table name: 64
Maximum length of column name: 64
Maximum length of column value(characters): 63 (64th or later characters are not displayed)
Maximum number of tables: 300
Maximum number of columns: 50 (51st or later columns are not displayed)

11. Contact

Please use the E-mail address below for inquiries about this product.

sy-takeuchi@outlook.com
https://github.com/s-takeuchi

Shinya Takeuchi