Mupssoft Wiki - User contributions [en]

Install and Basic Configuration

2021-06-13T14:32:45Z

Sergey:

<h1>'''How to install and Upgrade MupsBox'''</h1>
<p>Starting with version 1.4, the program is shipped with the installer, which simplifies the process of installing and updating the program. When you start the installer, you are prompted to select the installation path. By default destination location is Letter of installed operation system and application name. For example: C:\MupsBox.</p>

[[File:Install selectdir.png|Install selectdir]]
<br>Type Installation page provides chose options between:

<li>Server - default installation application with database on current machine.<br>
</li>
<li>Client - Installation only application without database. There is need put IP address and folder path information for connect to database on remote host.
</li>

[[File:Installation - Type installation.png]]

<p>On select components page can be chosen custom next options:

* Main Files - the core of application.
* Firebird SQL Server - Database, that keep information data of application. During update process installer will be compare current database SQL server and new one.
* Web components - Not necessary components for new web features.</p>

[[File:Installation - select components.png]]

<p>During first installation, if Firebird SQL served was not installed and select component was checked, application provide page for fill SYSDBA password for new instance.</p>

[[File:Installation - SYSDBA password.png]]

Select Start Menu folder:

[[File:Installation - select start menu option.png]]

Create desktop shortcut

[[File:Installation - create shortcut.png]]

After progress installation, installer show

[[File:Installation - Complete.png]]

<h2>'''Using Firebird 3.x'''</h2>
There is a Firebird database used to store data like connection data to devices, temporary data, statistical data, etc. MupsBox uses version 3.x. Firebird can be installed using application installer or manually. When you run manual installation, select a language, accept the terms of the agreement, select the installation folder, select which components to install (you can leave the default), create shortcuts in the menu, select additional tasks ( can be left by default).<br>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Warning:</b> Firebird 2.5 database support terminated. Firebird 4.0 database support not optimized. Please use only 3.0 version.</p></div>
<h2>The location of the program on the server.</h2>
<p>You need to place the executable program files in the same folder with the following files</p>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">
[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Attention:</b> If your antivirus warns that one of our services is Trojan or Malware, send these files to the antivirus vendor so that they add their signatures to the exceptions. We do not have Trojans and other filth.</p><p style="margin-top:10px; margin-left: 56px;"></p></div>There is some of main files of application:<ul>
<li>MupsBox.exe - is the main application, a device management GUI application.<br>
</li>
<li>MBTrafficser.exe - is a service for regularly receiving Traffic Accounting data.<br></li>
<li>MBBackupService.exe - is a service for running backup tasks.<br></li>
<li>MBFtpService.exe - is a service for running an ftp server on your PC.<br></li>
<li>MBSyslogService.exe - is a data collection service for the Syslog module.<br></li>
<li>MBPoolingService.exe - A service that polls devices for a given timer.<br></li>
<li>Config.ini - application configuration file.<br></li>
<li>MBDB.FDB - application database file.<br></li>
<li>Fbclient.dll - is an application and database interaction library.<br></li>
<li>deftitle.rtf - File for editing the report title<br></li>
<li>defbottom.rtf - File for editing report style<br></li>
<li>ssleay32.dll and libeay32.dll - SSL libraries</li>
<li>libssh2.dll and libcrypto-1_1-x64.dll - library for the client part of sftp</li>
<li>msvcp110.dll, vcruntime140.dll, msvcr110.dll, msvcr100.dll - supporting libraries</li>
</ul></p>

<h1>'''First start'''</h1>
<p>When you first start MupsBox.exe, you should create a new database or open an existing database.</p>
[[File:Create-DB2.png|alt=|DataBase Settings]]
<p>If you are installing the program for the first time, then click Create. If you already have a database, click Open.</p>
<p>After clicking on the selected button, a window will appear, where you need to select the path and name to save or open your database.</p>
[[File:Select-path1.png|alt=|Select Path]]
<p>After you have chosen a place to create or open your database and give it a name, click the Save or Open button. And you will see that the database was created (opened) as in the image below.</p>
[[File:DB-created1.png|alt=|DB Created]]

<h1>'''Before install services'''</h1>
<p>It's necessary to configure settings for services Syslog, FTP and also configure notifications.</p><p>The application provide different type of notification: via mail, via sms, via telegram</p>

<h2>Notifications via mail</h2>
[[File:Notification1.png|alt=|Notifications]]
<ul>
<li><p>Mail server - your mail server</p></li>
<li><p>SSL options - choose appropriate method of security: SSLv2, SSLv23, SSLv3, TLSv1, TLSv1.1, TLSv.1.2 or without SSL option.</p></li>
<li><p>Mail port - port without SSL</p></li>
<li><p>Mail user - username to logon to mail server</p></li>
<li><p>Mail password - password for your username</p></li>
<li><p>Mail From - Custom MAIL FROM</p></li>
<li><p>Mail global recipient - mail to send all notifications(can be redefined in jobs)</p></li>
<li><p>Check - MupsBox will send a test email</p></li>
<li><p>Save - save your settings for notifications</p></li>
</ul>

<h2>Notifications via telegram</h2>

[[File:Notification telegram.png|alt=|Notifications]]
<ul>
<li><p>Key bot - link on telegram channel</p></li>
<li><p>Client id - Id that new massages should be send.</p></li>
<li><p>use proxy - use proxy setting for send messages</p></li>
<li><p>Proxy server - proxy server for send telegram messages</p></li>
<li><p>Proxy port - port of proxy server for send telegram messages</p></li>
<li><p>User - user on proxy server for send telegram messages</p></li>
<li><p>Password - password on proxy server for send telegram messages</p></li>
<li><p>Test string - Send a test telegram string</p></li>
</ul>

<h2>Local FTP/SFTP</h2>
[[File:SFP-service1.png|alt=|FTP Service]]
<br>
[[File:FTP-service1.png|alt=|SFTP Service]]

By default, please use SFTP service for your goals.
<ul>
<li><p>User - username to connect to the local SFTP or FTP service</p></li>
<li><p>Password - Password to connect to the local SFTP or FTP service</p></li>
<li><p>Directory - Folder in which they will connect via SFTP or FTP</p></li>
<li><p>Port - SFTP / FTP - port</p></li>
</ul>

<h2>Syslog</h2>
[[File:Syslog-service1.png|alt=|Syslog]]
<ul>
<li><p>127.0.0.1 - your local IP or your IP address to listen all by UDP</p></li>
<li><p>514 - UDP port to listen to messages</p></li>
</ul>

<h2>HotSpot</h2>
[[File:Hotspot-service1.png|alt=|Hotspot]]
<ul>
<li><p>IP Address Syslog for Hotspot gateway - your local IP or your IP address to listen all by UDP</p></li>
<li><p>Port Syslog for Hotspot Gateway - UDP port to listen to messages. <b style="color:red;">Warning:</b> The port must be different from the port for syslog </p></li>
<li><p>Spam SMS tries - counts of fail tries to use SMS authentication. After threshold, mac address will add to black list. </p></li>
</ul>

<h2>Options</h2>
[[File:Options1.png|alt=|Options]]
<ul>
<li><p>Number of device threads - How many threads to use for polling devices</p></li>
<li><p>Number of IP scanner threads - How many threads to use to search for devices</p></li>
<li><p>Web server port - port on which the web server will be launched</p></li>
<li><p>* debug - additional logs for services</p></li>
<li><p>Device service timer (min) - how often to automatically poll devices</p></li>
<li><p>Double click on device - choose what will happen when you double-click or when you click on enter</p></li>
<li><p>SSH/Telnet - which application will open when you click on the button [[File:ssh.png|Start ssh]]</p></li>
<li><p>Text Backup alert - Adds a warning with the given text to the message body</p></li>
<li><p>Size logs/tmp - shows folder size</p></li>
<li><p>Clear logs/tmp - clears all contents of folders</p></li>
</ul>

<h3>Users and permissions</h3>
<p>When you click on the [[File:add.png|Add User]] button, you can add a user with defined access rights to the application.</p>
[[File:User-permissions.png|alt=|Users and permissions]]

<h1>'''Install and Start services'''</h1>
<ul>
<li><p>To install the service, you must click on the install button next to the name of the service.</p></li>
<li><p>To start the service, you must click on the start button next to the name of the service.</p></li>
</ul>
[[File:Services1.png|alt=|Services]]

<h1>'''How to Upgrade MupsBox'''</h1>
<ul>
<li><p>The first step is to stop all services.</p></li>
<li><p>Next, you need to uninstall all services.</p></li>
<li><p>After downloading the archive of the new version of the program.</p></li>
<li><p>Unpack the contents of the archive into the folder where MupsBox software is installed.</p></li>
<li><p>After starting the program, the system will offer you to update the database. Click Update.</p></li>
</ul>
[[File:Upgrade_db2.png|Upgrade DB]]
<ul>
<li><p>After updating the database, install and start the services.</p></li>
</ul>
<h1>'''Activation'''</h1>
<p>Activation shows what level of license is installed in your copy of the MupsBOX program.
To activate your license level, you need to fill your real email address, select the license level of the module you want to activate and click Save Level. After that, you need to generate your License ID by clicking the Get License ID button, you will receive a unique identifier that you need to send to email '''support@mupssoft.com''', our specialists will generate a key that will send you back to email. The resulting key must be placed in the License key field, click the Save button and restart the program. </p>
<p>There is faster way for provide license ID information. The lic.id file button provide save license for all modules to file. Then send file to email '''support@mupssoft.com''', our specialists will generate a key file that will send you back to email. Then you use Load key button for fill license keys for each modules.</p>
[[File:Activation1.png|alt=|Activation]]

<div id="BackToTop" class="noprint" style="background-color:#DDEFDD; position:fixed;
bottom:32px; left:2%; z-index:9999; padding:0; margin:0;"><span style="color:blue;
font-size:8pt; font-face:verdana,sans-serif; border:0.2em outset #ceebf7;
padding:0.1em; font-weight:bolder; -moz-border-radius:8px; ">
[[#top| Back to the Top]]</span></div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>

File:Activation1.png

2021-06-13T14:24:18Z

Sergey:

Activation

File:Services1.png

2021-06-13T13:18:07Z

Sergey:

Services

File:User-permissions.png

2021-06-13T13:16:56Z

Sergey:

User permissions

File:Options1.png

2021-06-13T12:56:04Z

Sergey:

Options1

Install and Basic Configuration

2021-06-13T12:41:05Z

Sergey:

<h1>'''How to install and Upgrade MupsBox'''</h1>
<p>Starting with version 1.4, the program is shipped with the installer, which simplifies the process of installing and updating the program. When you start the installer, you are prompted to select the installation path. By default destination location is Letter of installed operation system and application name. For example: C:\MupsBox.</p>

[[File:Install selectdir.png|Install selectdir]]
<br>Type Installation page provides chose options between:

<li>Server - default installation application with database on current machine.<br>
</li>
<li>Client - Installation only application without database. There is need put IP address and folder path information for connect to database on remote host.
</li>

[[File:Installation - Type installation.png]]

<p>On select components page can be chosen custom next options:

* Main Files - the core of application.
* Firebird SQL Server - Database, that keep information data of application. During update process installer will be compare current database SQL server and new one.
* Web components - Not necessary components for new web features.</p>

[[File:Installation - select components.png]]

<p>During first installation, if Firebird SQL served was not installed and select component was checked, application provide page for fill SYSDBA password for new instance.</p>

[[File:Installation - SYSDBA password.png]]

Select Start Menu folder:

[[File:Installation - select start menu option.png]]

Create desktop shortcut

[[File:Installation - create shortcut.png]]

After progress installation, installer show

[[File:Installation - Complete.png]]

<h2>'''Using Firebird 3.x'''</h2>
There is a Firebird database used to store data like connection data to devices, temporary data, statistical data, etc. MupsBox uses version 3.x. Firebird can be installed using application installer or manually. When you run manual installation, select a language, accept the terms of the agreement, select the installation folder, select which components to install (you can leave the default), create shortcuts in the menu, select additional tasks ( can be left by default).<br>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Warning:</b> Firebird 2.5 database support terminated. Firebird 4.0 database support not optimized. Please use only 3.0 version.</p></div>
<h2>The location of the program on the server.</h2>
<p>You need to place the executable program files in the same folder with the following files</p>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">
[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Attention:</b> If your antivirus warns that one of our services is Trojan or Malware, send these files to the antivirus vendor so that they add their signatures to the exceptions. We do not have Trojans and other filth.</p><p style="margin-top:10px; margin-left: 56px;"></p></div>There is some of main files of application:<ul>
<li>MupsBox.exe - is the main application, a device management GUI application.<br>
</li>
<li>MBTrafficser.exe - is a service for regularly receiving Traffic Accounting data.<br></li>
<li>MBBackupService.exe - is a service for running backup tasks.<br></li>
<li>MBFtpService.exe - is a service for running an ftp server on your PC.<br></li>
<li>MBSyslogService.exe - is a data collection service for the Syslog module.<br></li>
<li>MBPoolingService.exe - A service that polls devices for a given timer.<br></li>
<li>Config.ini - application configuration file.<br></li>
<li>MBDB.FDB - application database file.<br></li>
<li>Fbclient.dll - is an application and database interaction library.<br></li>
<li>deftitle.rtf - File for editing the report title<br></li>
<li>defbottom.rtf - File for editing report style<br></li>
<li>ssleay32.dll and libeay32.dll - SSL libraries</li>
<li>libssh2.dll and libcrypto-1_1-x64.dll - library for the client part of sftp</li>
<li>msvcp110.dll, vcruntime140.dll, msvcr110.dll, msvcr100.dll - supporting libraries</li>
</ul></p>

<h1>'''First start'''</h1>
<p>When you first start MupsBox.exe, you should create a new database or open an existing database.</p>
[[File:Create-DB2.png|alt=|DataBase Settings]]
<p>If you are installing the program for the first time, then click Create. If you already have a database, click Open.</p>
<p>After clicking on the selected button, a window will appear, where you need to select the path and name to save or open your database.</p>
[[File:Select-path1.png|alt=|Select Path]]
<p>After you have chosen a place to create or open your database and give it a name, click the Save or Open button. And you will see that the database was created (opened) as in the image below.</p>
[[File:DB-created1.png|alt=|DB Created]]

<h1>'''Before install services'''</h1>
<p>It's necessary to configure settings for services Syslog, FTP and also configure notifications.</p><p>The application provide different type of notification: via mail, via sms, via telegram</p>

<h2>Notifications via mail</h2>
[[File:Notification1.png|alt=|Notifications]]
<ul>
<li><p>Mail server - your mail server</p></li>
<li><p>SSL options - choose appropriate method of security: SSLv2, SSLv23, SSLv3, TLSv1, TLSv1.1, TLSv.1.2 or without SSL option.</p></li>
<li><p>Mail port - port without SSL</p></li>
<li><p>Mail user - username to logon to mail server</p></li>
<li><p>Mail password - password for your username</p></li>
<li><p>Mail From - Custom MAIL FROM</p></li>
<li><p>Mail global recipient - mail to send all notifications(can be redefined in jobs)</p></li>
<li><p>Check - MupsBox will send a test email</p></li>
<li><p>Save - save your settings for notifications</p></li>
</ul>

<h2>Notifications via telegram</h2>

[[File:Notification telegram.png|alt=|Notifications]]
<ul>
<li><p>Key bot - link on telegram channel</p></li>
<li><p>Client id - Id that new massages should be send.</p></li>
<li><p>use proxy - use proxy setting for send messages</p></li>
<li><p>Proxy server - proxy server for send telegram messages</p></li>
<li><p>Proxy port - port of proxy server for send telegram messages</p></li>
<li><p>User - user on proxy server for send telegram messages</p></li>
<li><p>Password - password on proxy server for send telegram messages</p></li>
<li><p>Test string - Send a test telegram string</p></li>
</ul>

<h2>Local FTP/SFTP</h2>
[[File:SFP-service1.png|alt=|FTP Service]]
<br>
[[File:FTP-service1.png|alt=|SFTP Service]]

By default, please use SFTP service for your goals.
<ul>
<li><p>User - username to connect to the local SFTP or FTP service</p></li>
<li><p>Password - Password to connect to the local SFTP or FTP service</p></li>
<li><p>Directory - Folder in which they will connect via SFTP or FTP</p></li>
<li><p>Port - SFTP / FTP - port</p></li>
</ul>

<h2>Syslog</h2>
[[File:Syslog-service1.png|alt=|Syslog]]
<ul>
<li><p>127.0.0.1 - your local IP or your IP address to listen all by UDP</p></li>
<li><p>514 - UDP port to listen to messages</p></li>
</ul>

<h2>HotSpot</h2>
[[File:Hotspot-service1.png|alt=|Hotspot]]
<ul>
<li><p>IP Address Syslog for Hotspot gateway - your local IP or your IP address to listen all by UDP</p></li>
<li><p>Port Syslog for Hotspot Gateway - UDP port to listen to messages. <b style="color:red;">Warning:</b> The port must be different from the port for syslog </p></li>
<li><p>Spam SMS tries - counts of fail tries to use SMS authentication. After threshold, mac address will add to black list. </p></li>
</ul>

<h2>Options</h2>
[[File:options.png|Options]]
<ul>
<li><p>Number of device threads - How many threads to use for polling devices</p></li>
<li><p>Number of IP scanner threads - How many threads to use to search for devices</p></li>
<li><p>Web server port - port on which the web server will be launched</p></li>
<li><p>* debug - additional logs for services</p></li>
<li><p>Device service timer (min) - how often to automatically poll devices</p></li>
<li><p>Double click on device - choose what will happen when you double-click or when you click on enter</p></li>
<li><p>SSH/Telnet - which application will open when you click on the button [[File:ssh.png|Start ssh]]</p></li>
<li><p>Text Backup alert - Adds a warning with the given text to the message body</p></li>
<li><p>Size logs/tmp - shows folder size</p></li>
<li><p>Clear logs/tmp - clears all contents of folders</p></li>
</ul>

<h3>Users and permissions</h3>
<p>When you click on the [[File:add.png|Add User]] button, you can add a user with defined access rights to the application.</p>
[[File:adduser2.jpg|Users and permissions]]

<h1>'''Install and Start services'''</h1>
<ul>
<li><p>To install the service, you must click on the install button next to the name of the service.</p></li>
<li><p>To start the service, you must click on the start button next to the name of the service.</p></li>
</ul>
[[File:Services.png|Services]]

<h1>'''How to Upgrade MupsBox'''</h1>
<ul>
<li><p>The first step is to stop all services.</p></li>
<li><p>Next, you need to uninstall all services.</p></li>
<li><p>After downloading the archive of the new version of the program.</p></li>
<li><p>Unpack the contents of the archive into the folder where MupsBox software is installed.</p></li>
<li><p>After starting the program, the system will offer you to update the database. Click Update.</p></li>
</ul>
[[File:Upgrade_db2.png|Upgrade DB]]
<ul>
<li><p>After updating the database, install and start the services.</p></li>
</ul>
<h1>'''Activation'''</h1>
<p>Activation shows what level of license is installed in your copy of the MupsBOX program.
To activate your license level, you need to fill your real email address, select the license level of the module you want to activate and click Save Level. After that, you need to generate your License ID by clicking the Get License ID button, you will receive a unique identifier that you need to send to email '''support@mupssoft.com''', our specialists will generate a key that will send you back to email. The resulting key must be placed in the License key field, click the Save button and restart the program.</p>
[[File:activation.png|Activation]]

<div id="BackToTop" class="noprint" style="background-color:#DDEFDD; position:fixed;
bottom:32px; left:2%; z-index:9999; padding:0; margin:0;"><span style="color:blue;
font-size:8pt; font-face:verdana,sans-serif; border:0.2em outset #ceebf7;
padding:0.1em; font-weight:bolder; -moz-border-radius:8px; ">
[[#top| Back to the Top]]</span></div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>

File:Hotspot-service1.png

2021-06-13T12:35:02Z

Sergey:

Hotspot service

File:Syslog-service1.png

2021-06-13T12:29:47Z

Sergey:

Syslog service

Install and Basic Configuration

2021-06-13T12:21:46Z

Sergey:

<h1>'''How to install and Upgrade MupsBox'''</h1>
<p>Starting with version 1.4, the program is shipped with the installer, which simplifies the process of installing and updating the program. When you start the installer, you are prompted to select the installation path. By default destination location is Letter of installed operation system and application name. For example: C:\MupsBox.</p>

[[File:Install selectdir.png|Install selectdir]]
<br>Type Installation page provides chose options between:

<li>Server - default installation application with database on current machine.<br>
</li>
<li>Client - Installation only application without database. There is need put IP address and folder path information for connect to database on remote host.
</li>

[[File:Installation - Type installation.png]]

<p>On select components page can be chosen custom next options:

* Main Files - the core of application.
* Firebird SQL Server - Database, that keep information data of application. During update process installer will be compare current database SQL server and new one.
* Web components - Not necessary components for new web features.</p>

[[File:Installation - select components.png]]

<p>During first installation, if Firebird SQL served was not installed and select component was checked, application provide page for fill SYSDBA password for new instance.</p>

[[File:Installation - SYSDBA password.png]]

Select Start Menu folder:

[[File:Installation - select start menu option.png]]

Create desktop shortcut

[[File:Installation - create shortcut.png]]

After progress installation, installer show

[[File:Installation - Complete.png]]

<h2>'''Using Firebird 3.x'''</h2>
There is a Firebird database used to store data like connection data to devices, temporary data, statistical data, etc. MupsBox uses version 3.x. Firebird can be installed using application installer or manually. When you run manual installation, select a language, accept the terms of the agreement, select the installation folder, select which components to install (you can leave the default), create shortcuts in the menu, select additional tasks ( can be left by default).<br>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Warning:</b> Firebird 2.5 database support terminated. Firebird 4.0 database support not optimized. Please use only 3.0 version.</p></div>
<h2>The location of the program on the server.</h2>
<p>You need to place the executable program files in the same folder with the following files</p>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">
[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Attention:</b> If your antivirus warns that one of our services is Trojan or Malware, send these files to the antivirus vendor so that they add their signatures to the exceptions. We do not have Trojans and other filth.</p><p style="margin-top:10px; margin-left: 56px;"></p></div>There is some of main files of application:<ul>
<li>MupsBox.exe - is the main application, a device management GUI application.<br>
</li>
<li>MBTrafficser.exe - is a service for regularly receiving Traffic Accounting data.<br></li>
<li>MBBackupService.exe - is a service for running backup tasks.<br></li>
<li>MBFtpService.exe - is a service for running an ftp server on your PC.<br></li>
<li>MBSyslogService.exe - is a data collection service for the Syslog module.<br></li>
<li>MBPoolingService.exe - A service that polls devices for a given timer.<br></li>
<li>Config.ini - application configuration file.<br></li>
<li>MBDB.FDB - application database file.<br></li>
<li>Fbclient.dll - is an application and database interaction library.<br></li>
<li>deftitle.rtf - File for editing the report title<br></li>
<li>defbottom.rtf - File for editing report style<br></li>
<li>ssleay32.dll and libeay32.dll - SSL libraries</li>
<li>libssh2.dll and libcrypto-1_1-x64.dll - library for the client part of sftp</li>
<li>msvcp110.dll, vcruntime140.dll, msvcr110.dll, msvcr100.dll - supporting libraries</li>
</ul></p>

<h1>'''First start'''</h1>
<p>When you first start MupsBox.exe, you should create a new database or open an existing database.</p>
[[File:Create-DB2.png|alt=|DataBase Settings]]
<p>If you are installing the program for the first time, then click Create. If you already have a database, click Open.</p>
<p>After clicking on the selected button, a window will appear, where you need to select the path and name to save or open your database.</p>
[[File:Select-path1.png|alt=|Select Path]]
<p>After you have chosen a place to create or open your database and give it a name, click the Save or Open button. And you will see that the database was created (opened) as in the image below.</p>
[[File:DB-created1.png|alt=|DB Created]]

<h1>'''Before install services'''</h1>
<p>It's necessary to configure settings for services Syslog, FTP and also configure notifications.</p><p>The application provide different type of notification: via mail, via sms, via telegram</p>

<h2>Notifications via mail</h2>
[[File:Notification1.png|alt=|Notifications]]
<ul>
<li><p>Mail server - your mail server</p></li>
<li><p>SSL options - choose appropriate method of security: SSLv2, SSLv23, SSLv3, TLSv1, TLSv1.1, TLSv.1.2 or without SSL option.</p></li>
<li><p>Mail port - port without SSL</p></li>
<li><p>Mail user - username to logon to mail server</p></li>
<li><p>Mail password - password for your username</p></li>
<li><p>Mail From - Custom MAIL FROM</p></li>
<li><p>Mail global recipient - mail to send all notifications(can be redefined in jobs)</p></li>
<li><p>Check - MupsBox will send a test email</p></li>
<li><p>Save - save your settings for notifications</p></li>
</ul>

<h2>Notifications via telegram</h2>

[[File:Notification telegram.png|alt=|Notifications]]
<ul>
<li><p>Key bot - link on telegram channel</p></li>
<li><p>Client id - Id that new massages should be send.</p></li>
<li><p>use proxy - use proxy setting for send messages</p></li>
<li><p>Proxy server - proxy server for send telegram messages</p></li>
<li><p>Proxy port - port of proxy server for send telegram messages</p></li>
<li><p>User - user on proxy server for send telegram messages</p></li>
<li><p>Password - password on proxy server for send telegram messages</p></li>
<li><p>Test string - Send a test telegram string</p></li>
</ul>

<h2>Local FTP/SFTP</h2>
[[File:SFP-service1.png|alt=|FTP Service]]
<br>
[[File:FTP-service1.png|alt=|SFTP Service]]

By default, please use SFTP service for your goals.
<ul>
<li><p>User - username to connect to the local SFTP or FTP service</p></li>
<li><p>Password - Password to connect to the local SFTP or FTP service</p></li>
<li><p>Directory - Folder in which they will connect via SFTP or FTP</p></li>
<li><p>Port - SFTP / FTP - port</p></li>
</ul>

<h2>Syslog</h2>
[[File:syslog-service.png|Syslog]]
<ul>
<li><p>127.0.0.1 - your local IP or your IP address to listen all by UDP</p></li>
<li><p>514 - UDP port to listen to messages</p></li>
</ul>

<h2>HotSpot</h2>
[[File:hotspot-service.png|Hotspot]]
<ul>
<li><p>IP AddressSyslog for Hotspot gateway - your local IP or your IP address to listen all by UDP</p></li>
<li><p>Port Syslog for Hotspot Gateway - UDP port to listen to messages. <b style="color:red;">Warning:</b> The port must be different from the port for syslog </p></li>
</ul>

<h2>Options</h2>
[[File:options.png|Options]]
<ul>
<li><p>Number of device threads - How many threads to use for polling devices</p></li>
<li><p>Number of IP scanner threads - How many threads to use to search for devices</p></li>
<li><p>Web server port - port on which the web server will be launched</p></li>
<li><p>* debug - additional logs for services</p></li>
<li><p>Device service timer (min) - how often to automatically poll devices</p></li>
<li><p>Double click on device - choose what will happen when you double-click or when you click on enter</p></li>
<li><p>SSH/Telnet - which application will open when you click on the button [[File:ssh.png|Start ssh]]</p></li>
<li><p>Text Backup alert - Adds a warning with the given text to the message body</p></li>
<li><p>Size logs/tmp - shows folder size</p></li>
<li><p>Clear logs/tmp - clears all contents of folders</p></li>
</ul>

<h3>Users and permissions</h3>
<p>When you click on the [[File:add.png|Add User]] button, you can add a user with defined access rights to the application.</p>
[[File:adduser2.jpg|Users and permissions]]

<h1>'''Install and Start services'''</h1>
<ul>
<li><p>To install the service, you must click on the install button next to the name of the service.</p></li>
<li><p>To start the service, you must click on the start button next to the name of the service.</p></li>
</ul>
[[File:Services.png|Services]]

<h1>'''How to Upgrade MupsBox'''</h1>
<ul>
<li><p>The first step is to stop all services.</p></li>
<li><p>Next, you need to uninstall all services.</p></li>
<li><p>After downloading the archive of the new version of the program.</p></li>
<li><p>Unpack the contents of the archive into the folder where MupsBox software is installed.</p></li>
<li><p>After starting the program, the system will offer you to update the database. Click Update.</p></li>
</ul>
[[File:Upgrade_db2.png|Upgrade DB]]
<ul>
<li><p>After updating the database, install and start the services.</p></li>
</ul>
<h1>'''Activation'''</h1>
<p>Activation shows what level of license is installed in your copy of the MupsBOX program.
To activate your license level, you need to fill your real email address, select the license level of the module you want to activate and click Save Level. After that, you need to generate your License ID by clicking the Get License ID button, you will receive a unique identifier that you need to send to email '''support@mupssoft.com''', our specialists will generate a key that will send you back to email. The resulting key must be placed in the License key field, click the Save button and restart the program.</p>
[[File:activation.png|Activation]]

<div id="BackToTop" class="noprint" style="background-color:#DDEFDD; position:fixed;
bottom:32px; left:2%; z-index:9999; padding:0; margin:0;"><span style="color:blue;
font-size:8pt; font-face:verdana,sans-serif; border:0.2em outset #ceebf7;
padding:0.1em; font-weight:bolder; -moz-border-radius:8px; ">
[[#top| Back to the Top]]</span></div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>

File:FTP-service1.png

2021-06-13T12:20:10Z

Sergey:

FTP service

File:SFP-service1.png

2021-06-13T12:15:43Z

Sergey:

SFP service

Install and Basic Configuration

2021-06-13T12:07:47Z

Sergey:

<h1>'''How to install and Upgrade MupsBox'''</h1>
<p>Starting with version 1.4, the program is shipped with the installer, which simplifies the process of installing and updating the program. When you start the installer, you are prompted to select the installation path. By default destination location is Letter of installed operation system and application name. For example: C:\MupsBox.</p>

[[File:Install selectdir.png|Install selectdir]]
<br>Type Installation page provides chose options between:

<li>Server - default installation application with database on current machine.<br>
</li>
<li>Client - Installation only application without database. There is need put IP address and folder path information for connect to database on remote host.
</li>

[[File:Installation - Type installation.png]]

<p>On select components page can be chosen custom next options:

* Main Files - the core of application.
* Firebird SQL Server - Database, that keep information data of application. During update process installer will be compare current database SQL server and new one.
* Web components - Not necessary components for new web features.</p>

[[File:Installation - select components.png]]

<p>During first installation, if Firebird SQL served was not installed and select component was checked, application provide page for fill SYSDBA password for new instance.</p>

[[File:Installation - SYSDBA password.png]]

Select Start Menu folder:

[[File:Installation - select start menu option.png]]

Create desktop shortcut

[[File:Installation - create shortcut.png]]

After progress installation, installer show

[[File:Installation - Complete.png]]

<h2>'''Using Firebird 3.x'''</h2>
There is a Firebird database used to store data like connection data to devices, temporary data, statistical data, etc. MupsBox uses version 3.x. Firebird can be installed using application installer or manually. When you run manual installation, select a language, accept the terms of the agreement, select the installation folder, select which components to install (you can leave the default), create shortcuts in the menu, select additional tasks ( can be left by default).<br>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Warning:</b> Firebird 2.5 database support terminated. Firebird 4.0 database support not optimized. Please use only 3.0 version.</p></div>
<h2>The location of the program on the server.</h2>
<p>You need to place the executable program files in the same folder with the following files</p>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">
[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Attention:</b> If your antivirus warns that one of our services is Trojan or Malware, send these files to the antivirus vendor so that they add their signatures to the exceptions. We do not have Trojans and other filth.</p><p style="margin-top:10px; margin-left: 56px;"></p></div>There is some of main files of application:<ul>
<li>MupsBox.exe - is the main application, a device management GUI application.<br>
</li>
<li>MBTrafficser.exe - is a service for regularly receiving Traffic Accounting data.<br></li>
<li>MBBackupService.exe - is a service for running backup tasks.<br></li>
<li>MBFtpService.exe - is a service for running an ftp server on your PC.<br></li>
<li>MBSyslogService.exe - is a data collection service for the Syslog module.<br></li>
<li>MBPoolingService.exe - A service that polls devices for a given timer.<br></li>
<li>Config.ini - application configuration file.<br></li>
<li>MBDB.FDB - application database file.<br></li>
<li>Fbclient.dll - is an application and database interaction library.<br></li>
<li>deftitle.rtf - File for editing the report title<br></li>
<li>defbottom.rtf - File for editing report style<br></li>
<li>ssleay32.dll and libeay32.dll - SSL libraries</li>
<li>libssh2.dll and libcrypto-1_1-x64.dll - library for the client part of sftp</li>
<li>msvcp110.dll, vcruntime140.dll, msvcr110.dll, msvcr100.dll - supporting libraries</li>
</ul></p>

<h1>'''First start'''</h1>
<p>When you first start MupsBox.exe, you should create a new database or open an existing database.</p>
[[File:Create-DB2.png|alt=|DataBase Settings]]
<p>If you are installing the program for the first time, then click Create. If you already have a database, click Open.</p>
<p>After clicking on the selected button, a window will appear, where you need to select the path and name to save or open your database.</p>
[[File:Select-path1.png|alt=|Select Path]]
<p>After you have chosen a place to create or open your database and give it a name, click the Save or Open button. And you will see that the database was created (opened) as in the image below.</p>
[[File:DB-created1.png|alt=|DB Created]]

<h1>'''Before install services'''</h1>
<p>It's necessary to configure settings for services Syslog, FTP and also configure notifications.</p><p>The application provide different type of notification: via mail, via sms, via telegram</p>

<h2>Notifications via mail</h2>
[[File:Notification1.png|alt=|Notifications]]
<ul>
<li><p>Mail server - your mail server</p></li>
<li><p>SSL options - choose appropriate method of security: SSLv2, SSLv23, SSLv3, TLSv1, TLSv1.1, TLSv.1.2 or without SSL option.</p></li>
<li><p>Mail port - port without SSL</p></li>
<li><p>Mail user - username to logon to mail server</p></li>
<li><p>Mail password - password for your username</p></li>
<li><p>Mail From - Custom MAIL FROM</p></li>
<li><p>Mail global recipient - mail to send all notifications(can be redefined in jobs)</p></li>
<li><p>Check - MupsBox will send a test email</p></li>
<li><p>Save - save your settings for notifications</p></li>
</ul>

<h2>Notifications via telegram</h2>

[[File:Notification telegram.png|alt=|Notifications]]
<ul>
<li><p>Key bot - link on telegram channel</p></li>
<li><p>Client id - Id that new massages should be send.</p></li>
<li><p>use proxy - use proxy setting for send messages</p></li>
<li><p>Proxy server - proxy server for send telegram messages</p></li>
<li><p>Proxy port - port of proxy server for send telegram messages</p></li>
<li><p>User - user on proxy server for send telegram messages</p></li>
<li><p>Password - password on proxy server for send telegram messages</p></li>
<li><p>Test string - Send a test telegram string</p></li>
</ul>

<h2>Local FTP/SFTP</h2>
[[File:ftp-service.png|FTP Service]]
<br>
[[File:sftp-service.png|SFTP Service]]
<ul>
<li><p>User - username to connect to the local FTP service</p></li>
<li><p>Password - Password to connect to the local FTP service</p></li>
<li><p>Directory - Folder in which they will connect via FTP</p></li>
<li><p>Port - FTP - port</p></li>
</ul>

<h2>Syslog</h2>
[[File:syslog-service.png|Syslog]]
<ul>
<li><p>127.0.0.1 - your local IP or your IP address to listen all by UDP</p></li>
<li><p>514 - UDP port to listen to messages</p></li>
</ul>

<h2>HotSpot</h2>
[[File:hotspot-service.png|Hotspot]]
<ul>
<li><p>IP AddressSyslog for Hotspot gateway - your local IP or your IP address to listen all by UDP</p></li>
<li><p>Port Syslog for Hotspot Gateway - UDP port to listen to messages. <b style="color:red;">Warning:</b> The port must be different from the port for syslog </p></li>
</ul>

<h2>Options</h2>
[[File:options.png|Options]]
<ul>
<li><p>Number of device threads - How many threads to use for polling devices</p></li>
<li><p>Number of IP scanner threads - How many threads to use to search for devices</p></li>
<li><p>Web server port - port on which the web server will be launched</p></li>
<li><p>* debug - additional logs for services</p></li>
<li><p>Device service timer (min) - how often to automatically poll devices</p></li>
<li><p>Double click on device - choose what will happen when you double-click or when you click on enter</p></li>
<li><p>SSH/Telnet - which application will open when you click on the button [[File:ssh.png|Start ssh]]</p></li>
<li><p>Text Backup alert - Adds a warning with the given text to the message body</p></li>
<li><p>Size logs/tmp - shows folder size</p></li>
<li><p>Clear logs/tmp - clears all contents of folders</p></li>
</ul>

<h3>Users and permissions</h3>
<p>When you click on the [[File:add.png|Add User]] button, you can add a user with defined access rights to the application.</p>
[[File:adduser2.jpg|Users and permissions]]

<h1>'''Install and Start services'''</h1>
<ul>
<li><p>To install the service, you must click on the install button next to the name of the service.</p></li>
<li><p>To start the service, you must click on the start button next to the name of the service.</p></li>
</ul>
[[File:Services.png|Services]]

<h1>'''How to Upgrade MupsBox'''</h1>
<ul>
<li><p>The first step is to stop all services.</p></li>
<li><p>Next, you need to uninstall all services.</p></li>
<li><p>After downloading the archive of the new version of the program.</p></li>
<li><p>Unpack the contents of the archive into the folder where MupsBox software is installed.</p></li>
<li><p>After starting the program, the system will offer you to update the database. Click Update.</p></li>
</ul>
[[File:Upgrade_db2.png|Upgrade DB]]
<ul>
<li><p>After updating the database, install and start the services.</p></li>
</ul>
<h1>'''Activation'''</h1>
<p>Activation shows what level of license is installed in your copy of the MupsBOX program.
To activate your license level, you need to fill your real email address, select the license level of the module you want to activate and click Save Level. After that, you need to generate your License ID by clicking the Get License ID button, you will receive a unique identifier that you need to send to email '''support@mupssoft.com''', our specialists will generate a key that will send you back to email. The resulting key must be placed in the License key field, click the Save button and restart the program.</p>
[[File:activation.png|Activation]]

<div id="BackToTop" class="noprint" style="background-color:#DDEFDD; position:fixed;
bottom:32px; left:2%; z-index:9999; padding:0; margin:0;"><span style="color:blue;
font-size:8pt; font-face:verdana,sans-serif; border:0.2em outset #ceebf7;
padding:0.1em; font-weight:bolder; -moz-border-radius:8px; ">
[[#top| Back to the Top]]</span></div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>

File:Notification telegram.png

2021-06-13T11:58:55Z

Sergey:

Notification via telegram

Install and Basic Configuration

2021-06-13T11:24:45Z

Sergey:

<h1>'''How to install and Upgrade MupsBox'''</h1>
<p>Starting with version 1.4, the program is shipped with the installer, which simplifies the process of installing and updating the program. When you start the installer, you are prompted to select the installation path. By default destination location is Letter of installed operation system and application name. For example: C:\MupsBox.</p>

[[File:Install selectdir.png|Install selectdir]]
<br>Type Installation page provides chose options between:

<li>Server - default installation application with database on current machine.<br>
</li>
<li>Client - Installation only application without database. There is need put IP address and folder path information for connect to database on remote host.
</li>

[[File:Installation - Type installation.png]]

<p>On select components page can be chosen custom next options:

* Main Files - the core of application.
* Firebird SQL Server - Database, that keep information data of application. During update process installer will be compare current database SQL server and new one.
* Web components - Not necessary components for new web features.</p>

[[File:Installation - select components.png]]

<p>During first installation, if Firebird SQL served was not installed and select component was checked, application provide page for fill SYSDBA password for new instance.</p>

[[File:Installation - SYSDBA password.png]]

Select Start Menu folder:

[[File:Installation - select start menu option.png]]

Create desktop shortcut

[[File:Installation - create shortcut.png]]

After progress installation, installer show

[[File:Installation - Complete.png]]

<h2>'''Using Firebird 3.x'''</h2>
There is a Firebird database used to store data like connection data to devices, temporary data, statistical data, etc. MupsBox uses version 3.x. Firebird can be installed using application installer or manually. When you run manual installation, select a language, accept the terms of the agreement, select the installation folder, select which components to install (you can leave the default), create shortcuts in the menu, select additional tasks ( can be left by default).<br>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Warning:</b> Firebird 2.5 database support terminated. Firebird 4.0 database support not optimized. Please use only 3.0 version.</p></div>
<h2>The location of the program on the server.</h2>
<p>You need to place the executable program files in the same folder with the following files</p>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">
[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Attention:</b> If your antivirus warns that one of our services is Trojan or Malware, send these files to the antivirus vendor so that they add their signatures to the exceptions. We do not have Trojans and other filth.</p><p style="margin-top:10px; margin-left: 56px;"></p></div>There is some of main files of application:<ul>
<li>MupsBox.exe - is the main application, a device management GUI application.<br>
</li>
<li>MBTrafficser.exe - is a service for regularly receiving Traffic Accounting data.<br></li>
<li>MBBackupService.exe - is a service for running backup tasks.<br></li>
<li>MBFtpService.exe - is a service for running an ftp server on your PC.<br></li>
<li>MBSyslogService.exe - is a data collection service for the Syslog module.<br></li>
<li>MBPoolingService.exe - A service that polls devices for a given timer.<br></li>
<li>Config.ini - application configuration file.<br></li>
<li>MBDB.FDB - application database file.<br></li>
<li>Fbclient.dll - is an application and database interaction library.<br></li>
<li>deftitle.rtf - File for editing the report title<br></li>
<li>defbottom.rtf - File for editing report style<br></li>
<li>ssleay32.dll and libeay32.dll - SSL libraries</li>
<li>libssh2.dll and libcrypto-1_1-x64.dll - library for the client part of sftp</li>
<li>msvcp110.dll, vcruntime140.dll, msvcr110.dll, msvcr100.dll - supporting libraries</li>
</ul></p>

<h1>'''First start'''</h1>
<p>When you first start MupsBox.exe, you should create a new database or open an existing database.</p>
[[File:Create-DB2.png|alt=|DataBase Settings]]
<p>If you are installing the program for the first time, then click Create. If you already have a database, click Open.</p>
<p>After clicking on the selected button, a window will appear, where you need to select the path and name to save or open your database.</p>
[[File:Select-path1.png|alt=|Select Path]]
<p>After you have chosen a place to create or open your database and give it a name, click the Save or Open button. And you will see that the database was created (opened) as in the image below.</p>
[[File:DB-created1.png|alt=|DB Created]]

<h1>'''Before install services'''</h1>
<p>It's necessary to configure settings for services Syslog, FTP and also configure notifications.</p><p>The application provide different type of notification: via mail, via sms, via telegram</p>

<h2>Notifications via mail</h2>
[[File:Notification1.png|alt=|Notifications]]
<ul>
<li><p>Mail server - your mail server</p></li>
<li><p>SSL options - choose appropriate method of security: SSLv2, SSLv23, SSLv3, TLSv1, TLSv1.1, TLSv.1.2 or without SSL option.</p></li>
<li><p>Mail port - port without SSL</p></li>
<li><p>Mail user - username to logon to mail server</p></li>
<li><p>Mail password - password for your username</p></li>
<li><p>Mail From - Custom MAIL FROM</p></li>
<li><p>Mail global recipient - mail to send all notifications(can be redefined in jobs)</p></li>
<li><p>Check - MupsBox will send a test email</p></li>
<li><p>Save - save your settings for notifications</p></li>
</ul>

<h2>Notifications via sms</h2>

[[File:Notification1.png|alt=|Notifications]]
<ul>
<li><p>Mail server - your mail server</p></li>
<li><p>SSL options - choose appropriate method of security: SSLv2, SSLv23, SSLv3, TLSv1, TLSv1.1, TLSv.1.2 or without SSL option.</p></li>
<li><p>Mail port - port without SSL</p></li>
<li><p>Mail user - username to logon to mail server</p></li>
<li><p>Mail password - password for your username</p></li>
<li><p>Mail From - Custom MAIL FROM</p></li>
<li><p>Mail global recipient - mail to send all notifications(can be redefined in jobs)</p></li>
<li><p>Check - MupsBox will send a test email</p></li>
<li><p>Save - save your settings for notifications</p></li>
</ul>

<h2>Local FTP/SFTP</h2>
[[File:ftp-service.png|FTP Service]]
<br>
[[File:sftp-service.png|SFTP Service]]
<ul>
<li><p>User - username to connect to the local FTP service</p></li>
<li><p>Password - Password to connect to the local FTP service</p></li>
<li><p>Directory - Folder in which they will connect via FTP</p></li>
<li><p>Port - FTP - port</p></li>
</ul>

<h2>Syslog</h2>
[[File:syslog-service.png|Syslog]]
<ul>
<li><p>127.0.0.1 - your local IP or your IP address to listen all by UDP</p></li>
<li><p>514 - UDP port to listen to messages</p></li>
</ul>

<h2>HotSpot</h2>
[[File:hotspot-service.png|Hotspot]]
<ul>
<li><p>IP AddressSyslog for Hotspot gateway - your local IP or your IP address to listen all by UDP</p></li>
<li><p>Port Syslog for Hotspot Gateway - UDP port to listen to messages. <b style="color:red;">Warning:</b> The port must be different from the port for syslog </p></li>
</ul>

<h2>Options</h2>
[[File:options.png|Options]]
<ul>
<li><p>Number of device threads - How many threads to use for polling devices</p></li>
<li><p>Number of IP scanner threads - How many threads to use to search for devices</p></li>
<li><p>Web server port - port on which the web server will be launched</p></li>
<li><p>* debug - additional logs for services</p></li>
<li><p>Device service timer (min) - how often to automatically poll devices</p></li>
<li><p>Double click on device - choose what will happen when you double-click or when you click on enter</p></li>
<li><p>SSH/Telnet - which application will open when you click on the button [[File:ssh.png|Start ssh]]</p></li>
<li><p>Text Backup alert - Adds a warning with the given text to the message body</p></li>
<li><p>Size logs/tmp - shows folder size</p></li>
<li><p>Clear logs/tmp - clears all contents of folders</p></li>
</ul>

<h3>Users and permissions</h3>
<p>When you click on the [[File:add.png|Add User]] button, you can add a user with defined access rights to the application.</p>
[[File:adduser2.jpg|Users and permissions]]

<h1>'''Install and Start services'''</h1>
<ul>
<li><p>To install the service, you must click on the install button next to the name of the service.</p></li>
<li><p>To start the service, you must click on the start button next to the name of the service.</p></li>
</ul>
[[File:Services.png|Services]]

<h1>'''How to Upgrade MupsBox'''</h1>
<ul>
<li><p>The first step is to stop all services.</p></li>
<li><p>Next, you need to uninstall all services.</p></li>
<li><p>After downloading the archive of the new version of the program.</p></li>
<li><p>Unpack the contents of the archive into the folder where MupsBox software is installed.</p></li>
<li><p>After starting the program, the system will offer you to update the database. Click Update.</p></li>
</ul>
[[File:Upgrade_db2.png|Upgrade DB]]
<ul>
<li><p>After updating the database, install and start the services.</p></li>
</ul>
<h1>'''Activation'''</h1>
<p>Activation shows what level of license is installed in your copy of the MupsBOX program.
To activate your license level, you need to fill your real email address, select the license level of the module you want to activate and click Save Level. After that, you need to generate your License ID by clicking the Get License ID button, you will receive a unique identifier that you need to send to email '''support@mupssoft.com''', our specialists will generate a key that will send you back to email. The resulting key must be placed in the License key field, click the Save button and restart the program.</p>
[[File:activation.png|Activation]]

<div id="BackToTop" class="noprint" style="background-color:#DDEFDD; position:fixed;
bottom:32px; left:2%; z-index:9999; padding:0; margin:0;"><span style="color:blue;
font-size:8pt; font-face:verdana,sans-serif; border:0.2em outset #ceebf7;
padding:0.1em; font-weight:bolder; -moz-border-radius:8px; ">
[[#top| Back to the Top]]</span></div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>

Install and Basic Configuration

2021-06-13T11:20:25Z

Sergey:

<h1>'''How to install and Upgrade MupsBox'''</h1>
<p>Starting with version 1.4, the program is shipped with the installer, which simplifies the process of installing and updating the program. When you start the installer, you are prompted to select the installation path. By default destination location is Letter of installed operation system and application name. For example: C:\MupsBox.</p>

[[File:Install selectdir.png|Install selectdir]]
<br>Type Installation page provides chose options between:

<li>Server - default installation application with database on current machine.<br>
</li>
<li>Client - Installation only application without database. There is need put IP address and folder path information for connect to database on remote host.
</li>

[[File:Installation - Type installation.png]]

<p>On select components page can be chosen custom next options:

* Main Files - the core of application.
* Firebird SQL Server - Database, that keep information data of application. During update process installer will be compare current database SQL server and new one.
* Web components - Not necessary components for new web features.</p>

[[File:Installation - select components.png]]

<p>During first installation, if Firebird SQL served was not installed and select component was checked, application provide page for fill SYSDBA password for new instance.</p>

[[File:Installation - SYSDBA password.png]]

Select Start Menu folder:

[[File:Installation - select start menu option.png]]

Create desktop shortcut

[[File:Installation - create shortcut.png]]

After progress installation, installer show

[[File:Installation - Complete.png]]

<h2>'''Using Firebird 3.x'''</h2>
There is a Firebird database used to store data like connection data to devices, temporary data, statistical data, etc. MupsBox uses version 3.x. Firebird can be installed using application installer or manually. When you run manual installation, select a language, accept the terms of the agreement, select the installation folder, select which components to install (you can leave the default), create shortcuts in the menu, select additional tasks ( can be left by default).<br>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Warning:</b> Firebird 2.5 database support terminated. Firebird 4.0 database support not optimized. Please use only 3.0 version.</p></div>
<h2>The location of the program on the server.</h2>
<p>You need to place the executable program files in the same folder with the following files</p>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">
[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Attention:</b> If your antivirus warns that one of our services is Trojan or Malware, send these files to the antivirus vendor so that they add their signatures to the exceptions. We do not have Trojans and other filth.</p><p style="margin-top:10px; margin-left: 56px;"></p></div>There is some of main files of application:<ul>
<li>MupsBox.exe - is the main application, a device management GUI application.<br>
</li>
<li>MBTrafficser.exe - is a service for regularly receiving Traffic Accounting data.<br></li>
<li>MBBackupService.exe - is a service for running backup tasks.<br></li>
<li>MBFtpService.exe - is a service for running an ftp server on your PC.<br></li>
<li>MBSyslogService.exe - is a data collection service for the Syslog module.<br></li>
<li>MBPoolingService.exe - A service that polls devices for a given timer.<br></li>
<li>Config.ini - application configuration file.<br></li>
<li>MBDB.FDB - application database file.<br></li>
<li>Fbclient.dll - is an application and database interaction library.<br></li>
<li>deftitle.rtf - File for editing the report title<br></li>
<li>defbottom.rtf - File for editing report style<br></li>
<li>ssleay32.dll and libeay32.dll - SSL libraries</li>
<li>libssh2.dll and libcrypto-1_1-x64.dll - library for the client part of sftp</li>
<li>msvcp110.dll, vcruntime140.dll, msvcr110.dll, msvcr100.dll - supporting libraries</li>
</ul></p>

<h1>'''First start'''</h1>
<p>When you first start MupsBox.exe, you should create a new database or open an existing database.</p>
[[File:Create-DB2.png|alt=|DataBase Settings]]
<p>If you are installing the program for the first time, then click Create. If you already have a database, click Open.</p>
<p>After clicking on the selected button, a window will appear, where you need to select the path and name to save or open your database.</p>
[[File:Select-path1.png|alt=|Select Path]]
<p>After you have chosen a place to create or open your database and give it a name, click the Save or Open button. And you will see that the database was created (opened) as in the image below.</p>
[[File:DB-created1.png|alt=|DB Created]]

<h1>'''Before install services'''</h1>
<p>It's necessary to configure settings for services Syslog, FTP and also configure notifications.</p><p>The application provide different type of notification: via mail, via sms, via telegram</p>

<h2>Notifications via mail</h2>
[[File:Notification1.png|alt=|Notifications]]
<ul>
<li><p>Mail server - your mail server</p></li>
<li><p>SSL options - choose appropriate method of security: SSLv2, SSLv23, SSLv3, TLSv1, TLSv1.1, TLSv.1.2 or without SSL option.</p></li>
<li><p>Mail port - port without SSL</p></li>
<li><p>Mail user - username to logon to mail server</p></li>
<li><p>Mail password - password for your username</p></li>
<li><p>Mail From - Custom MAIL FROM</p></li>
<li><p>Mail global recipient - mail to send all notifications(can be redefined in jobs)</p></li>
<li><p>Check - MupsBox will send a test email</p></li>
<li><p>Save - save your settings for notifications</p></li>
</ul>

<h2>Local FTP/SFTP</h2>
[[File:ftp-service.png|FTP Service]]
<br>
[[File:sftp-service.png|SFTP Service]]
<ul>
<li><p>User - username to connect to the local FTP service</p></li>
<li><p>Password - Password to connect to the local FTP service</p></li>
<li><p>Directory - Folder in which they will connect via FTP</p></li>
<li><p>Port - FTP - port</p></li>
</ul>

<h2>Syslog</h2>
[[File:syslog-service.png|Syslog]]
<ul>
<li><p>127.0.0.1 - your local IP or your IP address to listen all by UDP</p></li>
<li><p>514 - UDP port to listen to messages</p></li>
</ul>

<h2>HotSpot</h2>
[[File:hotspot-service.png|Hotspot]]
<ul>
<li><p>IP AddressSyslog for Hotspot gateway - your local IP or your IP address to listen all by UDP</p></li>
<li><p>Port Syslog for Hotspot Gateway - UDP port to listen to messages. <b style="color:red;">Warning:</b> The port must be different from the port for syslog </p></li>
</ul>

<h2>Options</h2>
[[File:options.png|Options]]
<ul>
<li><p>Number of device threads - How many threads to use for polling devices</p></li>
<li><p>Number of IP scanner threads - How many threads to use to search for devices</p></li>
<li><p>Web server port - port on which the web server will be launched</p></li>
<li><p>* debug - additional logs for services</p></li>
<li><p>Device service timer (min) - how often to automatically poll devices</p></li>
<li><p>Double click on device - choose what will happen when you double-click or when you click on enter</p></li>
<li><p>SSH/Telnet - which application will open when you click on the button [[File:ssh.png|Start ssh]]</p></li>
<li><p>Text Backup alert - Adds a warning with the given text to the message body</p></li>
<li><p>Size logs/tmp - shows folder size</p></li>
<li><p>Clear logs/tmp - clears all contents of folders</p></li>
</ul>

<h3>Users and permissions</h3>
<p>When you click on the [[File:add.png|Add User]] button, you can add a user with defined access rights to the application.</p>
[[File:adduser2.jpg|Users and permissions]]

<h1>'''Install and Start services'''</h1>
<ul>
<li><p>To install the service, you must click on the install button next to the name of the service.</p></li>
<li><p>To start the service, you must click on the start button next to the name of the service.</p></li>
</ul>
[[File:Services.png|Services]]

<h1>'''How to Upgrade MupsBox'''</h1>
<ul>
<li><p>The first step is to stop all services.</p></li>
<li><p>Next, you need to uninstall all services.</p></li>
<li><p>After downloading the archive of the new version of the program.</p></li>
<li><p>Unpack the contents of the archive into the folder where MupsBox software is installed.</p></li>
<li><p>After starting the program, the system will offer you to update the database. Click Update.</p></li>
</ul>
[[File:Upgrade_db2.png|Upgrade DB]]
<ul>
<li><p>After updating the database, install and start the services.</p></li>
</ul>
<h1>'''Activation'''</h1>
<p>Activation shows what level of license is installed in your copy of the MupsBOX program.
To activate your license level, you need to fill your real email address, select the license level of the module you want to activate and click Save Level. After that, you need to generate your License ID by clicking the Get License ID button, you will receive a unique identifier that you need to send to email '''support@mupssoft.com''', our specialists will generate a key that will send you back to email. The resulting key must be placed in the License key field, click the Save button and restart the program.</p>
[[File:activation.png|Activation]]

<div id="BackToTop" class="noprint" style="background-color:#DDEFDD; position:fixed;
bottom:32px; left:2%; z-index:9999; padding:0; margin:0;"><span style="color:blue;
font-size:8pt; font-face:verdana,sans-serif; border:0.2em outset #ceebf7;
padding:0.1em; font-weight:bolder; -moz-border-radius:8px; ">
[[#top| Back to the Top]]</span></div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>

File:Notification1.png

2021-06-13T11:20:12Z

Sergey:

Notification by mail

File:Select-path1.png

2021-06-13T11:11:08Z

Sergey:

Select path

File:Create-DB2.png

2021-06-13T11:10:10Z

Sergey:

Clear DB

File:DB-created1.png

2021-06-13T10:55:17Z

Sergey:

Database was created

File:Create-DB1.png

2021-06-13T10:51:44Z

Sergey:

Create new database

File:Create-DB.png

2021-06-13T10:35:17Z

Sergey:

Install and Basic Configuration

2021-06-06T14:00:53Z

Sergey: Installation

<h1>'''How to install and Upgrade MupsBox'''</h1>
<p>Starting with version 1.4, the program is shipped with the installer, which simplifies the process of installing and updating the program. When you start the installer, you are prompted to select the installation path. By default destination location is Letter of installed operation system and application name. For example: C:\MupsBox.</p>

[[File:Install selectdir.png|Install selectdir]]
<br>Type Installation page provides chose options between:

<li>Server - default installation application with database on current machine.<br>
</li>
<li>Client - Installation only application without database. There is need put IP address and folder path information for connect to database on remote host.
</li>

[[File:Installation - Type installation.png]]

<p>On select components page can be chosen custom next options:

* Main Files - the core of application.
* Firebird SQL Server - Database, that keep information data of application. During update process installer will be compare current database SQL server and new one.
* Web components - Not necessary components for new web features.</p>

[[File:Installation - select components.png]]

<p>During first installation, if Firebird SQL served was not installed and select component was checked, application provide page for fill SYSDBA password for new instance.</p>

[[File:Installation - SYSDBA password.png]]

Select Start Menu folder:

[[File:Installation - select start menu option.png]]

Create desktop shortcut

[[File:Installation - create shortcut.png]]

After progress installation, installer show

[[File:Installation - Complete.png]]

<h2>'''Using Firebird 3.x'''</h2>
There is a Firebird database used to store data like connection data to devices, temporary data, statistical data, etc. MupsBox uses version 3.x. Firebird can be installed using application installer or manually. When you run manual installation, select a language, accept the terms of the agreement, select the installation folder, select which components to install (you can leave the default), create shortcuts in the menu, select additional tasks ( can be left by default).<br>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Warning:</b> Firebird 2.5 database support terminated. Firebird 4.0 database support not optimized. Please use only 3.0 version.</p></div>
<br />
<p>It's necessary to enable api or api-ssl port for communication between MUPSBOX application and RouterOS device. Use command on ROS: IP → Services </p>

[[File:api-enable.png|API]]

<p>ip service disable www,www-ssl,ftp,ssh,telnet<br>
ip service set api-ssl disabled=no address=1.1.1.1<br>
1.1.1.1 - ip address of the PC where MUPSBOX is installed<br></p>

<h2>The location of the program on the server.</h2>
<p>You need to place the executable program files in the same folder with the following files</p>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">
[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Attention:</b> If your antivirus warns that one of our services is Trojan or Malware, send these files to the antivirus vendor so that they add their signatures to the exceptions. We do not have Trojans and other filth.</p><p style="margin-top:10px; margin-left: 56px;"></p></div>There is some of main files of application:<ul>
<li>MupsBox.exe - is the main application, a device management GUI application.<br>
</li>
<li>MBTrafficser.exe - is a service for regularly receiving Traffic Accounting data.<br></li>
<li>MBBackupService.exe - is a service for running backup tasks.<br></li>
<li>MBFtpService.exe - is a service for running an ftp server on your PC.<br></li>
<li>MBSyslogService.exe - is a data collection service for the Syslog module.<br></li>
<li>MBPoolingService.exe - A service that polls devices for a given timer.<br></li>
<li>Config.ini - application configuration file.<br></li>
<li>MBDB.FDB - application database file.<br></li>
<li>Fbclient.dll - is an application and database interaction library.<br></li>
<li>deftitle.rtf - File for editing the report title<br></li>
<li>defbottom.rtf - File for editing report style<br></li>
<li>ssleay32.dll and libeay32.dll - SSL libraries</li>
<li>libssh2.dll and libcrypto-1_1-x64.dll - library for the client part of sftp</li>
<li>msvcp110.dll, vcruntime140.dll, msvcr110.dll, msvcr100.dll - supporting libraries</li>
</ul></p>

<h1>'''First start'''</h1>
<p>When you first start MupsBox.exe, you should create a new database or open an existing database.</p>
[[File:Create-DB.png|DataBase Settings]]
<p>If you are installing the program for the first time, then click Create. If you already have a database, click Open.</p>
<p>After clicking on the selected button, a window will appear, where you need to select the path and name to save or open your database.</p>
[[File:select-path.png|Select Path]]
<p>After you have chosen a place to create or open your database and give it a name, click the Save or Open button. And you will see that the database was created (opened) as in the image below.</p>
[[File:DB-created2.png|DB Created]]

<h1>'''Before install services'''</h1>
<p>It's necessary to configure settings for services Syslog, FTP and also configure notifications.</p>

<h2>Notifications</h2>
[[File:notifications.png|Notifications]]
<ul>
<li><p>Mail server - your mail server</p></li>
<li><p>Mail port - port without SSL</p></li>
<li><p>Mail user - username to logon to mail server</p></li>
<li><p>Mail password - password for your username</p></li>
<li><p>Mail From - Custom MAIL FROM</p></li>
<li><p>Mail global recipient - mail to send all notifications(can be redefined in jobs)</p></li>
<li><p>SSL port - port with SSL</p></li>
<li><p>Save - save your settings for notifications</p></li>
<li><p>Check - MupsBox will send a test email</p></li>
</ul>

<h2>Local FTP/SFTP</h2>
[[File:ftp-service.png|FTP Service]]
<br>
[[File:sftp-service.png|SFTP Service]]
<ul>
<li><p>User - username to connect to the local FTP service</p></li>
<li><p>Password - Password to connect to the local FTP service</p></li>
<li><p>Directory - Folder in which they will connect via FTP</p></li>
<li><p>Port - FTP - port</p></li>
</ul>

<h2>Syslog</h2>
[[File:syslog-service.png|Syslog]]
<ul>
<li><p>127.0.0.1 - your local IP or your IP address to listen all by UDP</p></li>
<li><p>514 - UDP port to listen to messages</p></li>
</ul>

<h2>HotSpot</h2>
[[File:hotspot-service.png|Hotspot]]
<ul>
<li><p>IP AddressSyslog for Hotspot gateway - your local IP or your IP address to listen all by UDP</p></li>
<li><p>Port Syslog for Hotspot Gateway - UDP port to listen to messages. <b style="color:red;">Warning:</b> The port must be different from the port for syslog </p></li>
</ul>

<h2>Options</h2>
[[File:options.png|Options]]
<ul>
<li><p>Number of device threads - How many threads to use for polling devices</p></li>
<li><p>Number of IP scaner threads - How many threads to use to search for devices</p></li>
<li><p>Web server port - port on which the web server will be launched</p></li>
<li><p>* debug - additional logs for services</p></li>
<li><p>Device service timer (min) - how often to automatically poll devices</p></li>
<li><p>Double click on device - choose what will happen when you double-click or when you click on enter</p></li>
<li><p>SSH/Telnet - which application will open when you click on the button [[File:ssh.png|Start ssh]]</p></li>
<li><p>Text Backup allert - Adds a warning with the given text to the message body</p></li>
<li><p>Size logs/tmp - shows folder size</p></li>
<li><p>Clear logs/tmp - clears all contents of folders</p></li>
</ul>

<h3>Users and permisions</h3>
<p>When you click on the [[File:add.png|Add User]] button, you can add a user with defined access rights to the application.</p>
[[File:adduser.jpg|Users and permisions]]

<h1>'''Install and Start services'''</h1>
<ul>
<li><p>To install the service, you must click on the install button next to the name of the service.</p></li>
<li><p>To start the service, you must click on the start button next to the name of the service.</p></li>
</ul>
[[File:Services.png|Services]]

<h1>'''How to Upgrade MupsBox'''</h1>
<ul>
<li><p>The first step is to stop all services.</p></li>
<li><p>Next, you need to uninstall all services.</p></li>
<li><p>After downloading the archive of the new version of the program.</p></li>
<li><p>Unpack the contents of the archive into the folder where MupsBox software is installed.</p></li>
<li><p>After starting the program, the system will offer you to update the database. Click Update.</p></li>
</ul>
[[File:Upgrade_db2.png|Upgrade DB]]
<ul>
<li><p>After updating the database, install and start the services.</p></li>
</ul>
<h1>'''Activation'''</h1>
<p>Activation shows what level of license is installed in your copy of the MupsBOX program.
To activate your license level, you need to fill your real email address, select the license level of the module you want to activate and click Save Level. After that, you need to generate your License ID by clicking the Get License ID button, you will receive a unique identifier that you need to send to email '''support@mupssoft.com''', our specialists will generate a key that will send you back to email. The resulting key must be placed in the License key field, click the Save button and restart the program.</p>
[[File:activation.png|Activation]]

<div id="BackToTop" class="noprint" style="background-color:#DDEFDD; position:fixed;
bottom:32px; left:2%; z-index:9999; padding:0; margin:0;"><span style="color:blue;
font-size:8pt; font-face:verdana,sans-serif; border:0.2em outset #ceebf7;
padding:0.1em; font-weight:bolder; -moz-border-radius:8px; ">
[[#top| Back to the Top]]</span></div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>

File:Installation - Complete.png

2021-06-06T13:58:21Z

Sergey:

Installation - Complete

File:Installation - create shortcut.png

2021-06-06T13:56:19Z

Sergey:

Installation - create shortcut

File:Installation - select start menu option.png

2021-06-06T13:39:46Z

Sergey:

Installation - select start menu option

Install and Basic Configuration

2021-06-06T13:26:54Z

Sergey:

<h1>'''How to install and Upgrade MupsBox'''</h1>
<p>Starting with version 1.4, the program is shipped with the installer, which simplifies the process of installing and updating the program. When you start the installer, you are prompted to select the installation path. By default destination location is Letter of installed operation system and application name. For example: C:\MupsBox.</p>

[[File:Install selectdir.png|Install selectdir]]
<br>Type Installation page provides chose options between:

<li>Server - default installation application with database on current machine.<br>
</li>
<li>Client - Installation only application without database. There is need put IP address and folder path information for connect to database on remote host.
</li>

[[File:Installation - Type installation.png]]

<p>On select components page can be chosen custom next options:

* Main Files - the core of application.
* Firebird SQL Server - Database, that keep information data of application. During update process installer will be compare current database SQL server and new one.
* Web components - Not necessary components for new web features.</p>

[[File:Installation - select components.png]]

<p>During first installation, if Firebird SQL served was not installed and select component was checked, application provide page for fill SYSDBA password for new instance.</p>

[[File:Installation - SYSDBA password.png]] <h2>'''Using Firebird 3.x'''</h2>
There is a Firebird database used to store data like connection data to devices, temporary data, statistical data, etc. MupsBox uses version 3.x. Firebird can be installed using application installer or manually. When you run manual installation, select a language, accept the terms of the agreement, select the installation folder, select which components to install (you can leave the default), create shortcuts in the menu, select additional tasks ( can be left by default).<br>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Warning:</b> Firebird 2.5 database support terminated. Firebird 4.0 database support not optimized. Please use only 3.0 version.</p></div>
<br />
<p>It's necessary to enable api or api-ssl port for communication between MUPSBOX application and RouterOS device. Use command on ROS: IP → Services </p>

[[File:api-enable.png|API]]

<p>ip service disable www,www-ssl,ftp,ssh,telnet<br>
ip service set api-ssl disabled=no address=1.1.1.1<br>
1.1.1.1 - ip address of the PC where MUPSBOX is installed<br></p>

<h2>The location of the program on the server.</h2>
<p>You need to place the executable program files in the same folder with the following files</p>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">
[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Attention:</b> If your antivirus warns that one of our services is Trojan or Malware, send these files to the antivirus vendor so that they add their signatures to the exceptions. We do not have Trojans and other filth.</p></div>
<p><ul>
<li>MupsBox.exe - is the main application, a device management GUI application.<br></li>
<li>MBTrafficser.exe - is a service for regularly receiving Traffic Accounting data.<br></li>
<li>MBBackupService.exe - is a service for running backup tasks.<br></li>
<li>MBFtpService.exe - is a service for running an ftp server on your PC.<br></li>
<li>MBSyslogService.exe - is a data collection service for the Syslog module.<br></li>
<li>MBPoolingService.exe - A service that polls devices for a given timer.<br></li>
<li>Config.ini - application configuration file.<br></li>
<li>MBDB.FDB - application database file.<br></li>
<li>Fbclient.dll - is an application and database interaction library.<br></li>
<li>deftitle.rtf - File for editing the report title<br></li>
<li>defbottom.rtf - File for editing report style<br></li>
<li>ssleay32.dll and libeay32.dll - SSL libraries</li>
<li>libssh2.dll and libcrypto-1_1-x64.dll - library for the client part of sftp</li>
<li>msvcp110.dll, vcruntime140.dll, msvcr110.dll, msvcr100.dll - supporting libraries</li>
</ul></p>

<h1>'''First start'''</h1>
<p>When you first start MupsBox.exe, you should create a new database or open an existing database.</p>
[[File:Create-DB.png|DataBase Settings]]
<p>If you are installing the program for the first time, then click Create. If you already have a database, click Open.</p>
<p>After clicking on the selected button, a window will appear, where you need to select the path and name to save or open your database.</p>
[[File:select-path.png|Select Path]]
<p>After you have chosen a place to create or open your database and give it a name, click the Save or Open button. And you will see that the database was created (opened) as in the image below.</p>
[[File:DB-created2.png|DB Created]]

<h1>'''Before install services'''</h1>
<p>It's necessary to configure settings for services Syslog, FTP and also configure notifications.</p>

<h2>Notifications</h2>
[[File:notifications.png|Notifications]]
<ul>
<li><p>Mail server - your mail server</p></li>
<li><p>Mail port - port without SSL</p></li>
<li><p>Mail user - username to logon to mail server</p></li>
<li><p>Mail password - password for your username</p></li>
<li><p>Mail From - Custom MAIL FROM</p></li>
<li><p>Mail global recipient - mail to send all notifications(can be redefined in jobs)</p></li>
<li><p>SSL port - port with SSL</p></li>
<li><p>Save - save your settings for notifications</p></li>
<li><p>Check - MupsBox will send a test email</p></li>
</ul>

<h2>Local FTP/SFTP</h2>
[[File:ftp-service.png|FTP Service]]
<br>
[[File:sftp-service.png|SFTP Service]]
<ul>
<li><p>User - username to connect to the local FTP service</p></li>
<li><p>Password - Password to connect to the local FTP service</p></li>
<li><p>Directory - Folder in which they will connect via FTP</p></li>
<li><p>Port - FTP - port</p></li>
</ul>

<h2>Syslog</h2>
[[File:syslog-service.png|Syslog]]
<ul>
<li><p>127.0.0.1 - your local IP or your IP address to listen all by UDP</p></li>
<li><p>514 - UDP port to listen to messages</p></li>
</ul>

<h2>HotSpot</h2>
[[File:hotspot-service.png|Hotspot]]
<ul>
<li><p>IP AddressSyslog for Hotspot gateway - your local IP or your IP address to listen all by UDP</p></li>
<li><p>Port Syslog for Hotspot Gateway - UDP port to listen to messages. <b style="color:red;">Warning:</b> The port must be different from the port for syslog </p></li>
</ul>

<h2>Options</h2>
[[File:options.png|Options]]
<ul>
<li><p>Number of device threads - How many threads to use for polling devices</p></li>
<li><p>Number of IP scaner threads - How many threads to use to search for devices</p></li>
<li><p>Web server port - port on which the web server will be launched</p></li>
<li><p>* debug - additional logs for services</p></li>
<li><p>Device service timer (min) - how often to automatically poll devices</p></li>
<li><p>Double click on device - choose what will happen when you double-click or when you click on enter</p></li>
<li><p>SSH/Telnet - which application will open when you click on the button [[File:ssh.png|Start ssh]]</p></li>
<li><p>Text Backup allert - Adds a warning with the given text to the message body</p></li>
<li><p>Size logs/tmp - shows folder size</p></li>
<li><p>Clear logs/tmp - clears all contents of folders</p></li>
</ul>

<h3>Users and permisions</h3>
<p>When you click on the [[File:add.png|Add User]] button, you can add a user with defined access rights to the application.</p>
[[File:adduser.jpg|Users and permisions]]

<h1>'''Install and Start services'''</h1>
<ul>
<li><p>To install the service, you must click on the install button next to the name of the service.</p></li>
<li><p>To start the service, you must click on the start button next to the name of the service.</p></li>
</ul>
[[File:Services.png|Services]]

<h1>'''How to Upgrade MupsBox'''</h1>
<ul>
<li><p>The first step is to stop all services.</p></li>
<li><p>Next, you need to uninstall all services.</p></li>
<li><p>After downloading the archive of the new version of the program.</p></li>
<li><p>Unpack the contents of the archive into the folder where MupsBox software is installed.</p></li>
<li><p>After starting the program, the system will offer you to update the database. Click Update.</p></li>
</ul>
[[File:Upgrade_db2.png|Upgrade DB]]
<ul>
<li><p>After updating the database, install and start the services.</p></li>
</ul>
<h1>'''Activation'''</h1>
<p>Activation shows what level of license is installed in your copy of the MupsBOX program.
To activate your license level, you need to fill your real email address, select the license level of the module you want to activate and click Save Level. After that, you need to generate your License ID by clicking the Get License ID button, you will receive a unique identifier that you need to send to email '''support@mupssoft.com''', our specialists will generate a key that will send you back to email. The resulting key must be placed in the License key field, click the Save button and restart the program.</p>
[[File:activation.png|Activation]]

<div id="BackToTop" class="noprint" style="background-color:#DDEFDD; position:fixed;
bottom:32px; left:2%; z-index:9999; padding:0; margin:0;"><span style="color:blue;
font-size:8pt; font-face:verdana,sans-serif; border:0.2em outset #ceebf7;
padding:0.1em; font-weight:bolder; -moz-border-radius:8px; ">
[[#top| Back to the Top]]</span></div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>

Install and Basic Configuration

2021-06-06T13:25:23Z

Sergey:

<h1>'''How to install and Upgrade MupsBox'''</h1>
<p>Starting with version 1.4, the program is shipped with the installer, which simplifies the process of installing and updating the program. When you start the installer, you are prompted to select the installation path. By default destination location is Letter of installed operation system and application name. For example: C:\MupsBox.</p>

[[File:Install selectdir.png|Install selectdir]]
<br>Type Installation page provides chose options between:

<li>Server - default installation application with database on current machine.<br>
</li>
<li>Client - Installation only application without database. There is need put IP address and folder path information for connect to database on remote host.
</li>

[[File:Installation - Type installation.png]]

On select components page can be chosen custom next options:

* Main Files - the core of application.
* Firebird SQL Server - Database, that keep information data of application. During update process installer will be compare current database SQL server and new one.
* Web components - Not necessary components for new web features.

[[File:Installation - select components.png]]

During first installation, if Firebird SQL served was not installed and select component was checked, application provide page for fill SYSDBA password for new instance.

[[File:Installation - SYSDBA password.png]] <h2>'''Using Firebird 3.x'''</h2>
There is a Firebird database used to store data like connection data to devices, temporary data, statistical data, etc. MupsBox uses version 3.x. Firebird can be installed using application installer or manually. When you run manual installation, select a language, accept the terms of the agreement, select the installation folder, select which components to install (you can leave the default), create shortcuts in the menu, select additional tasks ( can be left by default).<br>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Warning:</b> Firebird 2.5 database support terminated. Firebird 4.0 database support not optimized. Please use only 3.0 version.</p></div>
<br />
<p>It's necessary to enable api or api-ssl port for communication between MUPSBOX application and RouterOS device. Use command on ROS: IP → Services </p>

[[File:api-enable.png|API]]

<p>ip service disable www,www-ssl,ftp,ssh,telnet<br>
ip service set api-ssl disabled=no address=1.1.1.1<br>
1.1.1.1 - ip address of the PC where MUPSBOX is installed<br></p>

<h2>The location of the program on the server.</h2>
<p>You need to place the executable program files in the same folder with the following files</p>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">
[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Attention:</b> If your antivirus warns that one of our services is Trojan or Malware, send these files to the antivirus vendor so that they add their signatures to the exceptions. We do not have Trojans and other filth.</p></div>
<p><ul>
<li>MupsBox.exe - is the main application, a device management GUI application.<br></li>
<li>MBTrafficser.exe - is a service for regularly receiving Traffic Accounting data.<br></li>
<li>MBBackupService.exe - is a service for running backup tasks.<br></li>
<li>MBFtpService.exe - is a service for running an ftp server on your PC.<br></li>
<li>MBSyslogService.exe - is a data collection service for the Syslog module.<br></li>
<li>MBPoolingService.exe - A service that polls devices for a given timer.<br></li>
<li>Config.ini - application configuration file.<br></li>
<li>MBDB.FDB - application database file.<br></li>
<li>Fbclient.dll - is an application and database interaction library.<br></li>
<li>deftitle.rtf - File for editing the report title<br></li>
<li>defbottom.rtf - File for editing report style<br></li>
<li>ssleay32.dll and libeay32.dll - SSL libraries</li>
<li>libssh2.dll and libcrypto-1_1-x64.dll - library for the client part of sftp</li>
<li>msvcp110.dll, vcruntime140.dll, msvcr110.dll, msvcr100.dll - supporting libraries</li>
</ul></p>

<h1>'''First start'''</h1>
<p>When you first start MupsBox.exe, you should create a new database or open an existing database.</p>
[[File:Create-DB.png|DataBase Settings]]
<p>If you are installing the program for the first time, then click Create. If you already have a database, click Open.</p>
<p>After clicking on the selected button, a window will appear, where you need to select the path and name to save or open your database.</p>
[[File:select-path.png|Select Path]]
<p>After you have chosen a place to create or open your database and give it a name, click the Save or Open button. And you will see that the database was created (opened) as in the image below.</p>
[[File:DB-created2.png|DB Created]]

<h1>'''Before install services'''</h1>
<p>It's necessary to configure settings for services Syslog, FTP and also configure notifications.</p>

<h2>Notifications</h2>
[[File:notifications.png|Notifications]]
<ul>
<li><p>Mail server - your mail server</p></li>
<li><p>Mail port - port without SSL</p></li>
<li><p>Mail user - username to logon to mail server</p></li>
<li><p>Mail password - password for your username</p></li>
<li><p>Mail From - Custom MAIL FROM</p></li>
<li><p>Mail global recipient - mail to send all notifications(can be redefined in jobs)</p></li>
<li><p>SSL port - port with SSL</p></li>
<li><p>Save - save your settings for notifications</p></li>
<li><p>Check - MupsBox will send a test email</p></li>
</ul>

<h2>Local FTP/SFTP</h2>
[[File:ftp-service.png|FTP Service]]
<br>
[[File:sftp-service.png|SFTP Service]]
<ul>
<li><p>User - username to connect to the local FTP service</p></li>
<li><p>Password - Password to connect to the local FTP service</p></li>
<li><p>Directory - Folder in which they will connect via FTP</p></li>
<li><p>Port - FTP - port</p></li>
</ul>

<h2>Syslog</h2>
[[File:syslog-service.png|Syslog]]
<ul>
<li><p>127.0.0.1 - your local IP or your IP address to listen all by UDP</p></li>
<li><p>514 - UDP port to listen to messages</p></li>
</ul>

<h2>HotSpot</h2>
[[File:hotspot-service.png|Hotspot]]
<ul>
<li><p>IP AddressSyslog for Hotspot gateway - your local IP or your IP address to listen all by UDP</p></li>
<li><p>Port Syslog for Hotspot Gateway - UDP port to listen to messages. <b style="color:red;">Warning:</b> The port must be different from the port for syslog </p></li>
</ul>

<h2>Options</h2>
[[File:options.png|Options]]
<ul>
<li><p>Number of device threads - How many threads to use for polling devices</p></li>
<li><p>Number of IP scaner threads - How many threads to use to search for devices</p></li>
<li><p>Web server port - port on which the web server will be launched</p></li>
<li><p>* debug - additional logs for services</p></li>
<li><p>Device service timer (min) - how often to automatically poll devices</p></li>
<li><p>Double click on device - choose what will happen when you double-click or when you click on enter</p></li>
<li><p>SSH/Telnet - which application will open when you click on the button [[File:ssh.png|Start ssh]]</p></li>
<li><p>Text Backup allert - Adds a warning with the given text to the message body</p></li>
<li><p>Size logs/tmp - shows folder size</p></li>
<li><p>Clear logs/tmp - clears all contents of folders</p></li>
</ul>

<h3>Users and permisions</h3>
<p>When you click on the [[File:add.png|Add User]] button, you can add a user with defined access rights to the application.</p>
[[File:adduser.jpg|Users and permisions]]

<h1>'''Install and Start services'''</h1>
<ul>
<li><p>To install the service, you must click on the install button next to the name of the service.</p></li>
<li><p>To start the service, you must click on the start button next to the name of the service.</p></li>
</ul>
[[File:Services.png|Services]]

<h1>'''How to Upgrade MupsBox'''</h1>
<ul>
<li><p>The first step is to stop all services.</p></li>
<li><p>Next, you need to uninstall all services.</p></li>
<li><p>After downloading the archive of the new version of the program.</p></li>
<li><p>Unpack the contents of the archive into the folder where MupsBox software is installed.</p></li>
<li><p>After starting the program, the system will offer you to update the database. Click Update.</p></li>
</ul>
[[File:Upgrade_db2.png|Upgrade DB]]
<ul>
<li><p>After updating the database, install and start the services.</p></li>
</ul>
<h1>'''Activation'''</h1>
<p>Activation shows what level of license is installed in your copy of the MupsBOX program.
To activate your license level, you need to fill your real email address, select the license level of the module you want to activate and click Save Level. After that, you need to generate your License ID by clicking the Get License ID button, you will receive a unique identifier that you need to send to email '''support@mupssoft.com''', our specialists will generate a key that will send you back to email. The resulting key must be placed in the License key field, click the Save button and restart the program.</p>
[[File:activation.png|Activation]]

<div id="BackToTop" class="noprint" style="background-color:#DDEFDD; position:fixed;
bottom:32px; left:2%; z-index:9999; padding:0; margin:0;"><span style="color:blue;
font-size:8pt; font-face:verdana,sans-serif; border:0.2em outset #ceebf7;
padding:0.1em; font-weight:bolder; -moz-border-radius:8px; ">
[[#top| Back to the Top]]</span></div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>

Install and Basic Configuration

2021-06-06T13:24:48Z

Sergey:

<h1>'''How to install and Upgrade MupsBox'''</h1>
<p>Starting with version 1.4, the program is shipped with the installer, which simplifies the process of installing and updating the program. When you start the installer, you are prompted to select the installation path. By default destination location is Letter of installed operation system and application name. For example: C:\MupsBox.</p>

[[File:Install selectdir.png|Install selectdir]]
<br>Type Installation page provides chose options between:

<li>Server - default installation application with database on current machine.<br>
</li>
<li>Client - Installation only application without database. There is need put IP address and folder path information for connect to database on remote host.
</li>

[[File:Installation - Type installation.png]]

On select components page can be chosen custom next options:

* Main Files - the core of application.
* Firebird SQL Server - Database, that keep information data of application. During update process installer will be compare current database SQL server and new one.
* Web components - Not necessary components for new web features.

[[File:Installation - select components.png]]

During first installation, if Firebird SQL served was not installed and select component was checked, application provide page for fill SYSDBA password for new instance.

[[File:Installation - SYSDBA password.png]] <h2>'''Using Firebird 3.x'''</h2>
There is a Firebird database used to store data like connection data to devices, temporary data, statistical data, etc. MupsBox uses version 3.x. Firebird can be installed using application installer or manually. When you run manual installation, select a language, accept the terms of the agreement, select the installation folder, select which components to install (you can leave the default), create shortcuts in the menu, select additional tasks ( can be left by default).<br>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Warning:</b> Firebird 2.5 database support terminated. Firebird 4.0 database support not optimized. Please use only 3.0 version.</p></div>
<br />
<p>It's necessary to enable api or api-ssl port for communication between MUPSBOX application and RouterOS device. Use command on ROS: IP → Services </p>

[[File:api-enable.png|API]]

<p>ip service disable www,www-ssl,ftp,ssh,telnet<br>
ip service set api-ssl disabled=no address=1.1.1.1<br>
1.1.1.1 - ip address of the PC where MUPSBOX is installed<br></p>

<h2>The location of the program on the server.</h2>
<p>You need to place the executable program files in the same folder with the following files</p>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">
[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Attention:</b> If your antivirus warns that one of our services is Trojan or Malware, send these files to the antivirus vendor so that they add their signatures to the exceptions. We do not have Trojans and other filth.</p></div>
<p><ul>
<li>MupsBox.exe - is the main application, a device management GUI application.<br></li>
<li>MBTrafficser.exe - is a service for regularly receiving Traffic Accounting data.<br></li>
<li>MBBackupService.exe - is a service for running backup tasks.<br></li>
<li>MBFtpService.exe - is a service for running an ftp server on your PC.<br></li>
<li>MBSyslogService.exe - is a data collection service for the Syslog module.<br></li>
<li>MBPoolingService.exe - A service that polls devices for a given timer.<br></li>
<li>Config.ini - application configuration file.<br></li>
<li>MBDB.FDB - application database file.<br></li>
<li>Fbclient.dll - is an application and database interaction library.<br></li>
<li>deftitle.rtf - File for editing the report title<br></li>
<li>defbottom.rtf - File for editing report style<br></li>
<li>ssleay32.dll and libeay32.dll - SSL libraries</li>
<li>libssh2.dll and libcrypto-1_1-x64.dll - library for the client part of sftp</li>
<li>msvcp110.dll, vcruntime140.dll, msvcr110.dll, msvcr100.dll - supporting libraries</li>
</ul></p>

<h1>'''First start'''</h1>
<p>When you first start MupsBox.exe, you should create a new database or open an existing database.</p>
[[File:Create-DB.png|DataBase Settings]]
<p>If you are installing the program for the first time, then click Create. If you already have a database, click Open.</p>
<p>After clicking on the selected button, a window will appear, where you need to select the path and name to save or open your database.</p>
[[File:select-path.png|Select Path]]
<p>After you have chosen a place to create or open your database and give it a name, click the Save or Open button. And you will see that the database was created (opened) as in the image below.</p>
[[File:DB-created2.png|DB Created]]

<h1>'''Before install services'''</h1>
<p>It's necessary to configure settings for services Syslog, FTP and also configure notifications.</p>

<h2>Notifications</h2>
[[File:notifications.png|Notifications]]
<ul>
<li><p>Mail server - your mail server</p></li>
<li><p>Mail port - port without SSL</p></li>
<li><p>Mail user - username to logon to mail server</p></li>
<li><p>Mail password - password for your username</p></li>
<li><p>Mail From - Custom MAIL FROM</p></li>
<li><p>Mail global recipient - mail to send all notifications(can be redefined in jobs)</p></li>
<li><p>SSL port - port with SSL</p></li>
<li><p>Save - save your settings for notifications</p></li>
<li><p>Check - MupsBox will send a test email</p></li>
</ul>

<h2>Local FTP/SFTP</h2>
[[File:ftp-service.png|FTP Service]]
<br>
[[File:sftp-service.png|SFTP Service]]
<ul>
<li><p>User - username to connect to the local FTP service</p></li>
<li><p>Password - Password to connect to the local FTP service</p></li>
<li><p>Directory - Folder in which they will connect via FTP</p></li>
<li><p>Port - FTP - port</p></li>
</ul>

<h2>Syslog</h2>
[[File:syslog-service.png|Syslog]]
<ul>
<li><p>127.0.0.1 - your local IP or your IP address to listen all by UDP</p></li>
<li><p>514 - UDP port to listen to messages</p></li>
</ul>

<h2>HotSpot</h2>
[[File:hotspot-service.png|Hotspot]]
<ul>
<li><p>IP AddressSyslog for Hotspot gateway - your local IP or your IP address to listen all by UDP</p></li>
<li><p>Port Syslog for Hotspot Gateway - UDP port to listen to messages. <b style="color:red;">Warning:</b> The port must be different from the port for syslog </p></li>
</ul>

<h2>Options</h2>
[[File:options.png|Options]]
<ul>
<li><p>Number of device threads - How many threads to use for polling devices</p></li>
<li><p>Number of IP scaner threads - How many threads to use to search for devices</p></li>
<li><p>Web server port - port on which the web server will be launched</p></li>
<li><p>* debug - additional logs for services</p></li>
<li><p>Device service timer (min) - how often to automatically poll devices</p></li>
<li><p>Double click on device - choose what will happen when you double-click or when you click on enter</p></li>
<li><p>SSH/Telnet - which application will open when you click on the button [[File:ssh.png|Start ssh]]</p></li>
<li><p>Text Backup allert - Adds a warning with the given text to the message body</p></li>
<li><p>Size logs/tmp - shows folder size</p></li>
<li><p>Clear logs/tmp - clears all contents of folders</p></li>
</ul>

<h3>Users and permisions</h3>
<p>When you click on the [[File:add.png|Add User]] button, you can add a user with defined access rights to the application.</p>
[[File:adduser.jpg|Users and permisions]]

<h1>'''Install and Start services'''</h1>
<ul>
<li><p>To install the service, you must click on the install button next to the name of the service.</p></li>
<li><p>To start the service, you must click on the start button next to the name of the service.</p></li>
</ul>
[[File:Services.png|Services]]

<h1>'''How to Upgrade MupsBox'''</h1>
<ul>
<li><p>The first step is to stop all services.</p></li>
<li><p>Next, you need to uninstall all services.</p></li>
<li><p>After downloading the archive of the new version of the program.</p></li>
<li><p>Unpack the contents of the archive into the folder where MupsBox software is installed.</p></li>
<li><p>After starting the program, the system will offer you to update the database. Click Update.</p></li>
</ul>
[[File:Upgrade_db2.png|Upgrade DB]]
<ul>
<li><p>After updating the database, install and start the services.</p></li>
</ul>
<h1>'''Activation'''</h1>
<p>Activation shows what level of license is installed in your copy of the MupsBOX program.
To activate your license level, you need to fill your real email address, select the license level of the module you want to activate and click Save Level. After that, you need to generate your License ID by clicking the Get License ID button, you will receive a unique identifier that you need to send to email '''support@mupssoft.com''', our specialists will generate a key that will send you back to email. The resulting key must be placed in the License key field, click the Save button and restart the program.</p>
[[File:activation.png|Activation]]

<div id="BackToTop" class="noprint" style="background-color:#DDEFDD; position:fixed;
bottom:32px; left:2%; z-index:9999; padding:0; margin:0;"><span style="color:blue;
font-size:8pt; font-face:verdana,sans-serif; border:0.2em outset #ceebf7;
padding:0.1em; font-weight:bolder; -moz-border-radius:8px; ">
[[#top| Back to the Top]]</span></div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>

File:Installation - SYSDBA password.png

2021-06-06T13:24:30Z

Sergey:

Installation - SYSDBA password

Install and Basic Configuration

2021-06-06T13:14:41Z

Sergey:

<h1>'''How to install and Upgrade MupsBox'''</h1>
<p>Starting with version 1.4, the program is shipped with the installer, which simplifies the process of installing and updating the program. When you start the installer, you are prompted to select the installation path. By default destination location is Letter of installed operation system and application name. For example: C:\MupsBox.</p>

[[File:Install selectdir.png|Install selectdir]]
<br>Type Installation page provides chose options between:

<li>Server - default installation application with database on current machine.<br>
</li>
<li>Client - Installation only application without database. There is need put IP address and folder path information for connect to database on remote host.
</li>

[[File:Installation - Type installation.png]]

On select components page can be chosen custom next options:

* Main Files - the core of application.
* Firebird SQL Server - Database, that keep information data of application. During update process installer will be compare current database SQL server and new one.
* Web components - Not necessary components for new web features.

[[File:Installation - select components.png]]

During first installation <h2>'''Using Firebird 3.x'''</h2>
There is a Firebird database used to store data like connection data to devices, temporary data, statistical data, etc. MupsBox uses version 3.x. Firebird can be installed using application installer or manually. When you run manual installation, select a language, accept the terms of the agreement, select the installation folder, select which components to install (you can leave the default), create shortcuts in the menu, select additional tasks ( can be left by default).<br>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Warning:</b> Firebird 2.5 database support terminated. Firebird 4.0 database support not optimized. Please use only 3.0 version.</p></div>
<br />
<p>It's necessary to enable api or api-ssl port for communication between MUPSBOX application and RouterOS device. Use command on ROS: IP → Services </p>

[[File:api-enable.png|API]]

<p>ip service disable www,www-ssl,ftp,ssh,telnet<br>
ip service set api-ssl disabled=no address=1.1.1.1<br>
1.1.1.1 - ip address of the PC where MUPSBOX is installed<br></p>

<h2>The location of the program on the server.</h2>
<p>You need to place the executable program files in the same folder with the following files</p>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">
[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Attention:</b> If your antivirus warns that one of our services is Trojan or Malware, send these files to the antivirus vendor so that they add their signatures to the exceptions. We do not have Trojans and other filth.</p></div>
<p><ul>
<li>MupsBox.exe - is the main application, a device management GUI application.<br></li>
<li>MBTrafficser.exe - is a service for regularly receiving Traffic Accounting data.<br></li>
<li>MBBackupService.exe - is a service for running backup tasks.<br></li>
<li>MBFtpService.exe - is a service for running an ftp server on your PC.<br></li>
<li>MBSyslogService.exe - is a data collection service for the Syslog module.<br></li>
<li>MBPoolingService.exe - A service that polls devices for a given timer.<br></li>
<li>Config.ini - application configuration file.<br></li>
<li>MBDB.FDB - application database file.<br></li>
<li>Fbclient.dll - is an application and database interaction library.<br></li>
<li>deftitle.rtf - File for editing the report title<br></li>
<li>defbottom.rtf - File for editing report style<br></li>
<li>ssleay32.dll and libeay32.dll - SSL libraries</li>
<li>libssh2.dll and libcrypto-1_1-x64.dll - library for the client part of sftp</li>
<li>msvcp110.dll, vcruntime140.dll, msvcr110.dll, msvcr100.dll - supporting libraries</li>
</ul></p>

<h1>'''First start'''</h1>
<p>When you first start MupsBox.exe, you should create a new database or open an existing database.</p>
[[File:Create-DB.png|DataBase Settings]]
<p>If you are installing the program for the first time, then click Create. If you already have a database, click Open.</p>
<p>After clicking on the selected button, a window will appear, where you need to select the path and name to save or open your database.</p>
[[File:select-path.png|Select Path]]
<p>After you have chosen a place to create or open your database and give it a name, click the Save or Open button. And you will see that the database was created (opened) as in the image below.</p>
[[File:DB-created2.png|DB Created]]

<h1>'''Before install services'''</h1>
<p>It's necessary to configure settings for services Syslog, FTP and also configure notifications.</p>

<h2>Notifications</h2>
[[File:notifications.png|Notifications]]
<ul>
<li><p>Mail server - your mail server</p></li>
<li><p>Mail port - port without SSL</p></li>
<li><p>Mail user - username to logon to mail server</p></li>
<li><p>Mail password - password for your username</p></li>
<li><p>Mail From - Custom MAIL FROM</p></li>
<li><p>Mail global recipient - mail to send all notifications(can be redefined in jobs)</p></li>
<li><p>SSL port - port with SSL</p></li>
<li><p>Save - save your settings for notifications</p></li>
<li><p>Check - MupsBox will send a test email</p></li>
</ul>

<h2>Local FTP/SFTP</h2>
[[File:ftp-service.png|FTP Service]]
<br>
[[File:sftp-service.png|SFTP Service]]
<ul>
<li><p>User - username to connect to the local FTP service</p></li>
<li><p>Password - Password to connect to the local FTP service</p></li>
<li><p>Directory - Folder in which they will connect via FTP</p></li>
<li><p>Port - FTP - port</p></li>
</ul>

<h2>Syslog</h2>
[[File:syslog-service.png|Syslog]]
<ul>
<li><p>127.0.0.1 - your local IP or your IP address to listen all by UDP</p></li>
<li><p>514 - UDP port to listen to messages</p></li>
</ul>

<h2>HotSpot</h2>
[[File:hotspot-service.png|Hotspot]]
<ul>
<li><p>IP AddressSyslog for Hotspot gateway - your local IP or your IP address to listen all by UDP</p></li>
<li><p>Port Syslog for Hotspot Gateway - UDP port to listen to messages. <b style="color:red;">Warning:</b> The port must be different from the port for syslog </p></li>
</ul>

<h2>Options</h2>
[[File:options.png|Options]]
<ul>
<li><p>Number of device threads - How many threads to use for polling devices</p></li>
<li><p>Number of IP scaner threads - How many threads to use to search for devices</p></li>
<li><p>Web server port - port on which the web server will be launched</p></li>
<li><p>* debug - additional logs for services</p></li>
<li><p>Device service timer (min) - how often to automatically poll devices</p></li>
<li><p>Double click on device - choose what will happen when you double-click or when you click on enter</p></li>
<li><p>SSH/Telnet - which application will open when you click on the button [[File:ssh.png|Start ssh]]</p></li>
<li><p>Text Backup allert - Adds a warning with the given text to the message body</p></li>
<li><p>Size logs/tmp - shows folder size</p></li>
<li><p>Clear logs/tmp - clears all contents of folders</p></li>
</ul>

<h3>Users and permisions</h3>
<p>When you click on the [[File:add.png|Add User]] button, you can add a user with defined access rights to the application.</p>
[[File:adduser.jpg|Users and permisions]]

<h1>'''Install and Start services'''</h1>
<ul>
<li><p>To install the service, you must click on the install button next to the name of the service.</p></li>
<li><p>To start the service, you must click on the start button next to the name of the service.</p></li>
</ul>
[[File:Services.png|Services]]

<h1>'''How to Upgrade MupsBox'''</h1>
<ul>
<li><p>The first step is to stop all services.</p></li>
<li><p>Next, you need to uninstall all services.</p></li>
<li><p>After downloading the archive of the new version of the program.</p></li>
<li><p>Unpack the contents of the archive into the folder where MupsBox software is installed.</p></li>
<li><p>After starting the program, the system will offer you to update the database. Click Update.</p></li>
</ul>
[[File:Upgrade_db2.png|Upgrade DB]]
<ul>
<li><p>After updating the database, install and start the services.</p></li>
</ul>
<h1>'''Activation'''</h1>
<p>Activation shows what level of license is installed in your copy of the MupsBOX program.
To activate your license level, you need to fill your real email address, select the license level of the module you want to activate and click Save Level. After that, you need to generate your License ID by clicking the Get License ID button, you will receive a unique identifier that you need to send to email '''support@mupssoft.com''', our specialists will generate a key that will send you back to email. The resulting key must be placed in the License key field, click the Save button and restart the program.</p>
[[File:activation.png|Activation]]

<div id="BackToTop" class="noprint" style="background-color:#DDEFDD; position:fixed;
bottom:32px; left:2%; z-index:9999; padding:0; margin:0;"><span style="color:blue;
font-size:8pt; font-face:verdana,sans-serif; border:0.2em outset #ceebf7;
padding:0.1em; font-weight:bolder; -moz-border-radius:8px; ">
[[#top| Back to the Top]]</span></div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>

Install and Basic Configuration

2021-06-06T12:56:33Z

Sergey: Installation- select components

<h1>'''How to install and Upgrade MupsBox'''</h1>
<p>Starting with version 1.4, the program is shipped with the installer, which simplifies the process of installing and updating the program. When you start the installer, you are prompted to select the installation path. By default destination location is Letter of installed operation system and application name. For example: C:\MupsBox.</p>

[[File:Install selectdir.png|Install selectdir]]
<br>Type Installation page provides chose options between:

<li>Server - default installation application with database on current machine.<br>
</li>
<li>Client - Installation only application without database. There is need put IP address and folder path information for connect to database on remote host.
</li>

[[File:Installation - Type installation.png]]

On select components page can be chosen custom next options:

* Main Files - the core of application.
* Firebird SQL Server - Database, that keep information data of application. During update process installer will be compare current database SQL server and new one.
* Web components - Not necessary components for new web features.

[[File:Installation - select components.png]]<h2>'''Install Firebird 3.x'''</h2>
There is a Firebird database used to store data like connection data to devices, temporary data, statistical data, etc. MupsBox uses version 3.x. Download the https://firebirdsql.org/en/server-packages/. When you start the installation, select a language, accept the terms of the agreement, select the installation folder, select which components to install (you can leave the default), create shortcuts in the menu, select additional tasks ( can be left by default).<br>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Warning:</b> Firebird 2.5 database support terminated.</p></div>
<br />
<p>It's necessary to enable api or api-ssl port for communication between MUPSBOX application and RouterOS device. Use command on ROS: IP → Services </p>

[[File:api-enable.png|API]]

<p>ip service disable www,www-ssl,ftp,ssh,telnet<br>
ip service set api-ssl disabled=no address=1.1.1.1<br>
1.1.1.1 - ip address of the PC where MUPSBOX is installed<br></p>

<h2>The location of the program on the server.</h2>
<p>You need to place the executable program files in the same folder with the following files</p>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">
[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Attention:</b> If your antivirus warns that one of our services is Trojan or Malware, send these files to the antivirus vendor so that they add their signatures to the exceptions. We do not have Trojans and other filth.</p></div>
<p><ul>
<li>MupsBox.exe - is the main application, a device management GUI application.<br></li>
<li>MBTrafficser.exe - is a service for regularly receiving Traffic Accounting data.<br></li>
<li>MBBackupService.exe - is a service for running backup tasks.<br></li>
<li>MBFtpService.exe - is a service for running an ftp server on your PC.<br></li>
<li>MBSyslogService.exe - is a data collection service for the Syslog module.<br></li>
<li>MBPoolingService.exe - A service that polls devices for a given timer.<br></li>
<li>Config.ini - application configuration file.<br></li>
<li>MBDB.FDB - application database file.<br></li>
<li>Fbclient.dll - is an application and database interaction library.<br></li>
<li>deftitle.rtf - File for editing the report title<br></li>
<li>defbottom.rtf - File for editing report style<br></li>
<li>ssleay32.dll and libeay32.dll - SSL libraries</li>
<li>libssh2.dll and libcrypto-1_1-x64.dll - library for the client part of sftp</li>
<li>msvcp110.dll, vcruntime140.dll, msvcr110.dll, msvcr100.dll - supporting libraries</li>
</ul></p>

<h1>'''First start'''</h1>
<p>When you first start MupsBox.exe, you should create a new database or open an existing database.</p>
[[File:Create-DB.png|DataBase Settings]]
<p>If you are installing the program for the first time, then click Create. If you already have a database, click Open.</p>
<p>After clicking on the selected button, a window will appear, where you need to select the path and name to save or open your database.</p>
[[File:select-path.png|Select Path]]
<p>After you have chosen a place to create or open your database and give it a name, click the Save or Open button. And you will see that the database was created (opened) as in the image below.</p>
[[File:DB-created2.png|DB Created]]

<h1>'''Before install services'''</h1>
<p>It's necessary to configure settings for services Syslog, FTP and also configure notifications.</p>

<h2>Notifications</h2>
[[File:notifications.png|Notifications]]
<ul>
<li><p>Mail server - your mail server</p></li>
<li><p>Mail port - port without SSL</p></li>
<li><p>Mail user - username to logon to mail server</p></li>
<li><p>Mail password - password for your username</p></li>
<li><p>Mail From - Custom MAIL FROM</p></li>
<li><p>Mail global recipient - mail to send all notifications(can be redefined in jobs)</p></li>
<li><p>SSL port - port with SSL</p></li>
<li><p>Save - save your settings for notifications</p></li>
<li><p>Check - MupsBox will send a test email</p></li>
</ul>

<h2>Local FTP/SFTP</h2>
[[File:ftp-service.png|FTP Service]]
<br>
[[File:sftp-service.png|SFTP Service]]
<ul>
<li><p>User - username to connect to the local FTP service</p></li>
<li><p>Password - Password to connect to the local FTP service</p></li>
<li><p>Directory - Folder in which they will connect via FTP</p></li>
<li><p>Port - FTP - port</p></li>
</ul>

<h2>Syslog</h2>
[[File:syslog-service.png|Syslog]]
<ul>
<li><p>127.0.0.1 - your local IP or your IP address to listen all by UDP</p></li>
<li><p>514 - UDP port to listen to messages</p></li>
</ul>

<h2>HotSpot</h2>
[[File:hotspot-service.png|Hotspot]]
<ul>
<li><p>IP AddressSyslog for Hotspot gateway - your local IP or your IP address to listen all by UDP</p></li>
<li><p>Port Syslog for Hotspot Gateway - UDP port to listen to messages. <b style="color:red;">Warning:</b> The port must be different from the port for syslog </p></li>
</ul>

<h2>Options</h2>
[[File:options.png|Options]]
<ul>
<li><p>Number of device threads - How many threads to use for polling devices</p></li>
<li><p>Number of IP scaner threads - How many threads to use to search for devices</p></li>
<li><p>Web server port - port on which the web server will be launched</p></li>
<li><p>* debug - additional logs for services</p></li>
<li><p>Device service timer (min) - how often to automatically poll devices</p></li>
<li><p>Double click on device - choose what will happen when you double-click or when you click on enter</p></li>
<li><p>SSH/Telnet - which application will open when you click on the button [[File:ssh.png|Start ssh]]</p></li>
<li><p>Text Backup allert - Adds a warning with the given text to the message body</p></li>
<li><p>Size logs/tmp - shows folder size</p></li>
<li><p>Clear logs/tmp - clears all contents of folders</p></li>
</ul>

<h3>Users and permisions</h3>
<p>When you click on the [[File:add.png|Add User]] button, you can add a user with defined access rights to the application.</p>
[[File:adduser.jpg|Users and permisions]]

<h1>'''Install and Start services'''</h1>
<ul>
<li><p>To install the service, you must click on the install button next to the name of the service.</p></li>
<li><p>To start the service, you must click on the start button next to the name of the service.</p></li>
</ul>
[[File:Services.png|Services]]

<h1>'''How to Upgrade MupsBox'''</h1>
<ul>
<li><p>The first step is to stop all services.</p></li>
<li><p>Next, you need to uninstall all services.</p></li>
<li><p>After downloading the archive of the new version of the program.</p></li>
<li><p>Unpack the contents of the archive into the folder where MupsBox software is installed.</p></li>
<li><p>After starting the program, the system will offer you to update the database. Click Update.</p></li>
</ul>
[[File:Upgrade_db2.png|Upgrade DB]]
<ul>
<li><p>After updating the database, install and start the services.</p></li>
</ul>
<h1>'''Activation'''</h1>
<p>Activation shows what level of license is installed in your copy of the MupsBOX program.
To activate your license level, you need to fill your real email address, select the license level of the module you want to activate and click Save Level. After that, you need to generate your License ID by clicking the Get License ID button, you will receive a unique identifier that you need to send to email '''support@mupssoft.com''', our specialists will generate a key that will send you back to email. The resulting key must be placed in the License key field, click the Save button and restart the program.</p>
[[File:activation.png|Activation]]

<div id="BackToTop" class="noprint" style="background-color:#DDEFDD; position:fixed;
bottom:32px; left:2%; z-index:9999; padding:0; margin:0;"><span style="color:blue;
font-size:8pt; font-face:verdana,sans-serif; border:0.2em outset #ceebf7;
padding:0.1em; font-weight:bolder; -moz-border-radius:8px; ">
[[#top| Back to the Top]]</span></div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>

File:Installation - select components.png

2021-06-06T12:50:38Z

Sergey:

Installation - select components

Install and Basic Configuration

2021-06-06T12:48:07Z

Sergey:

<h1>'''How to install and Upgrade MupsBox'''</h1>
<p>Starting with version 1.4, the program is shipped with the installer, which simplifies the process of installing and updating the program. When you start the installer, you are prompted to select the installation path. By default destination location is Letter of installed operation system and application name. For example: C:\MupsBox.</p>

[[File:Install selectdir.png|Install selectdir]]
<br>Type Installation page provides chose options between:

<li>Server - default installation application with database on current machine.<br>
</li>
<li>Client - Installation only application without database. There is need put IP address and folder path information for connect to database on remote host.
</li>

[[File:Installation - Type installation.png]]<h2>'''Install Firebird 3.x'''</h2>
There is a Firebird database used to store data like connection data to devices, temporary data, statistical data, etc. MupsBox uses version 3.x. Download the https://firebirdsql.org/en/server-packages/. When you start the installation, select a language, accept the terms of the agreement, select the installation folder, select which components to install (you can leave the default), create shortcuts in the menu, select additional tasks ( can be left by default).<br>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Warning:</b> Firebird 2.5 database support terminated.</p></div>
<br />
<p>It's necessary to enable api or api-ssl port for communication between MUPSBOX application and RouterOS device. Use command on ROS: IP → Services </p>

[[File:api-enable.png|API]]

<p>ip service disable www,www-ssl,ftp,ssh,telnet<br>
ip service set api-ssl disabled=no address=1.1.1.1<br>
1.1.1.1 - ip address of the PC where MUPSBOX is installed<br></p>

<h2>The location of the program on the server.</h2>
<p>You need to place the executable program files in the same folder with the following files</p>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">
[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Attention:</b> If your antivirus warns that one of our services is Trojan or Malware, send these files to the antivirus vendor so that they add their signatures to the exceptions. We do not have Trojans and other filth.</p></div>
<p><ul>
<li>MupsBox.exe - is the main application, a device management GUI application.<br></li>
<li>MBTrafficser.exe - is a service for regularly receiving Traffic Accounting data.<br></li>
<li>MBBackupService.exe - is a service for running backup tasks.<br></li>
<li>MBFtpService.exe - is a service for running an ftp server on your PC.<br></li>
<li>MBSyslogService.exe - is a data collection service for the Syslog module.<br></li>
<li>MBPoolingService.exe - A service that polls devices for a given timer.<br></li>
<li>Config.ini - application configuration file.<br></li>
<li>MBDB.FDB - application database file.<br></li>
<li>Fbclient.dll - is an application and database interaction library.<br></li>
<li>deftitle.rtf - File for editing the report title<br></li>
<li>defbottom.rtf - File for editing report style<br></li>
<li>ssleay32.dll and libeay32.dll - SSL libraries</li>
<li>libssh2.dll and libcrypto-1_1-x64.dll - library for the client part of sftp</li>
<li>msvcp110.dll, vcruntime140.dll, msvcr110.dll, msvcr100.dll - supporting libraries</li>
</ul></p>

<h1>'''First start'''</h1>
<p>When you first start MupsBox.exe, you should create a new database or open an existing database.</p>
[[File:Create-DB.png|DataBase Settings]]
<p>If you are installing the program for the first time, then click Create. If you already have a database, click Open.</p>
<p>After clicking on the selected button, a window will appear, where you need to select the path and name to save or open your database.</p>
[[File:select-path.png|Select Path]]
<p>After you have chosen a place to create or open your database and give it a name, click the Save or Open button. And you will see that the database was created (opened) as in the image below.</p>
[[File:DB-created2.png|DB Created]]

<h1>'''Before install services'''</h1>
<p>It's necessary to configure settings for services Syslog, FTP and also configure notifications.</p>

<h2>Notifications</h2>
[[File:notifications.png|Notifications]]
<ul>
<li><p>Mail server - your mail server</p></li>
<li><p>Mail port - port without SSL</p></li>
<li><p>Mail user - username to logon to mail server</p></li>
<li><p>Mail password - password for your username</p></li>
<li><p>Mail From - Custom MAIL FROM</p></li>
<li><p>Mail global recipient - mail to send all notifications(can be redefined in jobs)</p></li>
<li><p>SSL port - port with SSL</p></li>
<li><p>Save - save your settings for notifications</p></li>
<li><p>Check - MupsBox will send a test email</p></li>
</ul>

<h2>Local FTP/SFTP</h2>
[[File:ftp-service.png|FTP Service]]
<br>
[[File:sftp-service.png|SFTP Service]]
<ul>
<li><p>User - username to connect to the local FTP service</p></li>
<li><p>Password - Password to connect to the local FTP service</p></li>
<li><p>Directory - Folder in which they will connect via FTP</p></li>
<li><p>Port - FTP - port</p></li>
</ul>

<h2>Syslog</h2>
[[File:syslog-service.png|Syslog]]
<ul>
<li><p>127.0.0.1 - your local IP or your IP address to listen all by UDP</p></li>
<li><p>514 - UDP port to listen to messages</p></li>
</ul>

<h2>HotSpot</h2>
[[File:hotspot-service.png|Hotspot]]
<ul>
<li><p>IP AddressSyslog for Hotspot gateway - your local IP or your IP address to listen all by UDP</p></li>
<li><p>Port Syslog for Hotspot Gateway - UDP port to listen to messages. <b style="color:red;">Warning:</b> The port must be different from the port for syslog </p></li>
</ul>

<h2>Options</h2>
[[File:options.png|Options]]
<ul>
<li><p>Number of device threads - How many threads to use for polling devices</p></li>
<li><p>Number of IP scaner threads - How many threads to use to search for devices</p></li>
<li><p>Web server port - port on which the web server will be launched</p></li>
<li><p>* debug - additional logs for services</p></li>
<li><p>Device service timer (min) - how often to automatically poll devices</p></li>
<li><p>Double click on device - choose what will happen when you double-click or when you click on enter</p></li>
<li><p>SSH/Telnet - which application will open when you click on the button [[File:ssh.png|Start ssh]]</p></li>
<li><p>Text Backup allert - Adds a warning with the given text to the message body</p></li>
<li><p>Size logs/tmp - shows folder size</p></li>
<li><p>Clear logs/tmp - clears all contents of folders</p></li>
</ul>

<h3>Users and permisions</h3>
<p>When you click on the [[File:add.png|Add User]] button, you can add a user with defined access rights to the application.</p>
[[File:adduser.jpg|Users and permisions]]

<h1>'''Install and Start services'''</h1>
<ul>
<li><p>To install the service, you must click on the install button next to the name of the service.</p></li>
<li><p>To start the service, you must click on the start button next to the name of the service.</p></li>
</ul>
[[File:Services.png|Services]]

<h1>'''How to Upgrade MupsBox'''</h1>
<ul>
<li><p>The first step is to stop all services.</p></li>
<li><p>Next, you need to uninstall all services.</p></li>
<li><p>After downloading the archive of the new version of the program.</p></li>
<li><p>Unpack the contents of the archive into the folder where MupsBox software is installed.</p></li>
<li><p>After starting the program, the system will offer you to update the database. Click Update.</p></li>
</ul>
[[File:Upgrade_db2.png|Upgrade DB]]
<ul>
<li><p>After updating the database, install and start the services.</p></li>
</ul>
<h1>'''Activation'''</h1>
<p>Activation shows what level of license is installed in your copy of the MupsBOX program.
To activate your license level, you need to fill your real email address, select the license level of the module you want to activate and click Save Level. After that, you need to generate your License ID by clicking the Get License ID button, you will receive a unique identifier that you need to send to email '''support@mupssoft.com''', our specialists will generate a key that will send you back to email. The resulting key must be placed in the License key field, click the Save button and restart the program.</p>
[[File:activation.png|Activation]]

<div id="BackToTop" class="noprint" style="background-color:#DDEFDD; position:fixed;
bottom:32px; left:2%; z-index:9999; padding:0; margin:0;"><span style="color:blue;
font-size:8pt; font-face:verdana,sans-serif; border:0.2em outset #ceebf7;
padding:0.1em; font-weight:bolder; -moz-border-radius:8px; ">
[[#top| Back to the Top]]</span></div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>

File:Installation - Type installation.png

2021-06-06T12:38:02Z

Sergey:

Installation - Type installation

Install and Basic Configuration

2021-06-06T12:25:53Z

Sergey:

Install and Basic Configuration

2021-06-06T12:21:43Z

Sergey:

<h1>'''How to install and Upgrade MupsBox'''</h1>
<p>Starting with version 1.4, the program is shipped with the installer, which simplifies the process of installing and updating the program.</p>

[[File:Install selectdir.png|Install selectdir]]
<br>
<h2>'''Install Firebird 3.x'''</h2>
There is a Firebird database used to store data like connection data to devices, temporary data, statistical data, etc. MupsBox uses version 3.x. Download the https://firebirdsql.org/en/server-packages/. When you start the installation, select a language, accept the terms of the agreement, select the installation folder, select which components to install (you can leave the default), create shortcuts in the menu, select additional tasks ( can be left by default).<br>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Warning:</b> Firebird 2.5 database support terminated.</p></div>
<br />
<p>It's necessary to enable api or api-ssl port for communication between MUPSBOX application and RouterOS device. Use command on ROS: IP → Services </p>

[[File:api-enable.png|API]]

<p>ip service disable www,www-ssl,ftp,ssh,telnet<br>
ip service set api-ssl disabled=no address=1.1.1.1<br>
1.1.1.1 - ip address of the PC where MUPSBOX is installed<br></p>

<h2>The location of the program on the server.</h2>
<p>You need to place the executable program files in the same folder with the following files</p>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">
[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Attention:</b> If your antivirus warns that one of our services is Trojan or Malware, send these files to the antivirus vendor so that they add their signatures to the exceptions. We do not have Trojans and other filth.</p></div>
<p><ul>
<li>MupsBox.exe - is the main application, a device management GUI application.<br></li>
<li>MBTrafficser.exe - is a service for regularly receiving Traffic Accounting data.<br></li>
<li>MBBackupService.exe - is a service for running backup tasks.<br></li>
<li>MBFtpService.exe - is a service for running an ftp server on your PC.<br></li>
<li>MBSyslogService.exe - is a data collection service for the Syslog module.<br></li>
<li>MBPoolingService.exe - A service that polls devices for a given timer.<br></li>
<li>Config.ini - application configuration file.<br></li>
<li>MBDB.FDB - application database file.<br></li>
<li>Fbclient.dll - is an application and database interaction library.<br></li>
<li>deftitle.rtf - File for editing the report title<br></li>
<li>defbottom.rtf - File for editing report style<br></li>
<li>ssleay32.dll and libeay32.dll - SSL libraries</li>
<li>libssh2.dll and libcrypto-1_1-x64.dll - library for the client part of sftp</li>
<li>msvcp110.dll, vcruntime140.dll, msvcr110.dll, msvcr100.dll - supporting libraries</li>
</ul></p>

<h1>'''First start'''</h1>
<p>When you first start MupsBox.exe, you should create a new database or open an existing database.</p>
[[File:Create-DB.png|DataBase Settings]]
<p>If you are installing the program for the first time, then click Create. If you already have a database, click Open.</p>
<p>After clicking on the selected button, a window will appear, where you need to select the path and name to save or open your database.</p>
[[File:select-path.png|Select Path]]
<p>After you have chosen a place to create or open your database and give it a name, click the Save or Open button. And you will see that the database was created (opened) as in the image below.</p>
[[File:DB-created2.png|DB Created]]

<h1>'''Before install services'''</h1>
<p>It's necessary to configure settings for services Syslog, FTP and also configure notifications.</p>

<h2>Notifications</h2>
[[File:notifications.png|Notifications]]
<ul>
<li><p>Mail server - your mail server</p></li>
<li><p>Mail port - port without SSL</p></li>
<li><p>Mail user - username to logon to mail server</p></li>
<li><p>Mail password - password for your username</p></li>
<li><p>Mail From - Custom MAIL FROM</p></li>
<li><p>Mail global recipient - mail to send all notifications(can be redefined in jobs)</p></li>
<li><p>SSL port - port with SSL</p></li>
<li><p>Save - save your settings for notifications</p></li>
<li><p>Check - MupsBox will send a test email</p></li>
</ul>

<h2>Local FTP/SFTP</h2>
[[File:ftp-service.png|FTP Service]]
<br>
[[File:sftp-service.png|SFTP Service]]
<ul>
<li><p>User - username to connect to the local FTP service</p></li>
<li><p>Password - Password to connect to the local FTP service</p></li>
<li><p>Directory - Folder in which they will connect via FTP</p></li>
<li><p>Port - FTP - port</p></li>
</ul>

<h2>Syslog</h2>
[[File:syslog-service.png|Syslog]]
<ul>
<li><p>127.0.0.1 - your local IP or your IP address to listen all by UDP</p></li>
<li><p>514 - UDP port to listen to messages</p></li>
</ul>

<h2>HotSpot</h2>
[[File:hotspot-service.png|Hotspot]]
<ul>
<li><p>IP AddressSyslog for Hotspot gateway - your local IP or your IP address to listen all by UDP</p></li>
<li><p>Port Syslog for Hotspot Gateway - UDP port to listen to messages. <b style="color:red;">Warning:</b> The port must be different from the port for syslog </p></li>
</ul>

<h2>Options</h2>
[[File:options.png|Options]]
<ul>
<li><p>Number of device threads - How many threads to use for polling devices</p></li>
<li><p>Number of IP scaner threads - How many threads to use to search for devices</p></li>
<li><p>Web server port - port on which the web server will be launched</p></li>
<li><p>* debug - additional logs for services</p></li>
<li><p>Device service timer (min) - how often to automatically poll devices</p></li>
<li><p>Double click on device - choose what will happen when you double-click or when you click on enter</p></li>
<li><p>SSH/Telnet - which application will open when you click on the button [[File:ssh.png|Start ssh]]</p></li>
<li><p>Text Backup allert - Adds a warning with the given text to the message body</p></li>
<li><p>Size logs/tmp - shows folder size</p></li>
<li><p>Clear logs/tmp - clears all contents of folders</p></li>
</ul>

<h3>Users and permisions</h3>
<p>When you click on the [[File:add.png|Add User]] button, you can add a user with defined access rights to the application.</p>
[[File:adduser.jpg|Users and permisions]]

<h1>'''Install and Start services'''</h1>
<ul>
<li><p>To install the service, you must click on the install button next to the name of the service.</p></li>
<li><p>To start the service, you must click on the start button next to the name of the service.</p></li>
</ul>
[[File:Services.png|Services]]

<h1>'''How to Upgrade MupsBox'''</h1>
<ul>
<li><p>The first step is to stop all services.</p></li>
<li><p>Next, you need to uninstall all services.</p></li>
<li><p>After downloading the archive of the new version of the program.</p></li>
<li><p>Unpack the contents of the archive into the folder where MupsBox software is installed.</p></li>
<li><p>After starting the program, the system will offer you to update the database. Click Update.</p></li>
</ul>
[[File:Upgrade_db2.png|Upgrade DB]]
<ul>
<li><p>After updating the database, install and start the services.</p></li>
</ul>
<h1>'''Activation'''</h1>
<p>Activation shows what level of license is installed in your copy of the MupsBOX program.
To activate your license level, you need to fill your real email address, select the license level of the module you want to activate and click Save Level. After that, you need to generate your License ID by clicking the Get License ID button, you will receive a unique identifier that you need to send to email '''support@mupssoft.com''', our specialists will generate a key that will send you back to email. The resulting key must be placed in the License key field, click the Save button and restart the program.</p>
[[File:activation.png|Activation]]

<div id="BackToTop" class="noprint" style="background-color:#DDEFDD; position:fixed;
bottom:32px; left:2%; z-index:9999; padding:0; margin:0;"><span style="color:blue;
font-size:8pt; font-face:verdana,sans-serif; border:0.2em outset #ceebf7;
padding:0.1em; font-weight:bolder; -moz-border-radius:8px; ">
[[#top| Back to the Top]]</span></div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>

Install and Basic Configuration

2021-06-06T11:49:16Z

Sergey:

<h1>'''How to install and Upgrade MupsBox'''</h1>
<p>Starting with version 1.4, the program is shipped with the installer, which simplifies the process of installing and updating the program.</p>

[[File:Install selectdir.png|thumb]]
<br>
<h2>'''Install Firebird 3.x'''</h2>
There is a Firebird database used to store data like connection data to devices, temporary data, statistical data, etc. MupsBox uses version 3.x. Download the https://firebirdsql.org/en/server-packages/. When you start the installation, select a language, accept the terms of the agreement, select the installation folder, select which components to install (you can leave the default), create shortcuts in the menu, select additional tasks ( can be left by default).<br>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Warning:</b> Firebird 2.5 database support terminated.</p></div>
<br />
<p>It's necessary to enable api or api-ssl port for communication between MUPSBOX application and RouterOS device. Use command on ROS: IP → Services </p>

[[File:api-enable.png|API]]

<p>ip service disable www,www-ssl,ftp,ssh,telnet<br>
ip service set api-ssl disabled=no address=1.1.1.1<br>
1.1.1.1 - ip address of the PC where MUPSBOX is installed<br></p>

<h2>The location of the program on the server.</h2>
<p>You need to place the executable program files in the same folder with the following files</p>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">
[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Attention:</b> If your antivirus warns that one of our services is Trojan or Malware, send these files to the antivirus vendor so that they add their signatures to the exceptions. We do not have Trojans and other filth.</p></div>
<p><ul>
<li>MupsBox.exe - is the main application, a device management GUI application.<br></li>
<li>MBTrafficser.exe - is a service for regularly receiving Traffic Accounting data.<br></li>
<li>MBBackupService.exe - is a service for running backup tasks.<br></li>
<li>MBFtpService.exe - is a service for running an ftp server on your PC.<br></li>
<li>MBSyslogService.exe - is a data collection service for the Syslog module.<br></li>
<li>MBPoolingService.exe - A service that polls devices for a given timer.<br></li>
<li>Config.ini - application configuration file.<br></li>
<li>MBDB.FDB - application database file.<br></li>
<li>Fbclient.dll - is an application and database interaction library.<br></li>
<li>deftitle.rtf - File for editing the report title<br></li>
<li>defbottom.rtf - File for editing report style<br></li>
<li>ssleay32.dll and libeay32.dll - SSL libraries</li>
<li>libssh2.dll and libcrypto-1_1-x64.dll - library for the client part of sftp</li>
<li>msvcp110.dll, vcruntime140.dll, msvcr110.dll, msvcr100.dll - supporting libraries</li>
</ul></p>

<h1>'''First start'''</h1>
<p>When you first start MupsBox.exe, you should create a new database or open an existing database.</p>
[[File:Create-DB.png|DataBase Settings]]
<p>If you are installing the program for the first time, then click Create. If you already have a database, click Open.</p>
<p>After clicking on the selected button, a window will appear, where you need to select the path and name to save or open your database.</p>
[[File:select-path.png|Select Path]]
<p>After you have chosen a place to create or open your database and give it a name, click the Save or Open button. And you will see that the database was created (opened) as in the image below.</p>
[[File:DB-created2.png|DB Created]]

<h1>'''Before install services'''</h1>
<p>It's necessary to configure settings for services Syslog, FTP and also configure notifications.</p>

<h2>Notifications</h2>
[[File:notifications.png|Notifications]]
<ul>
<li><p>Mail server - your mail server</p></li>
<li><p>Mail port - port without SSL</p></li>
<li><p>Mail user - username to logon to mail server</p></li>
<li><p>Mail password - password for your username</p></li>
<li><p>Mail From - Custom MAIL FROM</p></li>
<li><p>Mail global recipient - mail to send all notifications(can be redefined in jobs)</p></li>
<li><p>SSL port - port with SSL</p></li>
<li><p>Save - save your settings for notifications</p></li>
<li><p>Check - MupsBox will send a test email</p></li>
</ul>

<h2>Local FTP/SFTP</h2>
[[File:ftp-service.png|FTP Service]]
<br>
[[File:sftp-service.png|SFTP Service]]
<ul>
<li><p>User - username to connect to the local FTP service</p></li>
<li><p>Password - Password to connect to the local FTP service</p></li>
<li><p>Directory - Folder in which they will connect via FTP</p></li>
<li><p>Port - FTP - port</p></li>
</ul>

<h2>Syslog</h2>
[[File:syslog-service.png|Syslog]]
<ul>
<li><p>127.0.0.1 - your local IP or your IP address to listen all by UDP</p></li>
<li><p>514 - UDP port to listen to messages</p></li>
</ul>

<h2>HotSpot</h2>
[[File:hotspot-service.png|Hotspot]]
<ul>
<li><p>IP AddressSyslog for Hotspot gateway - your local IP or your IP address to listen all by UDP</p></li>
<li><p>Port Syslog for Hotspot Gateway - UDP port to listen to messages. <b style="color:red;">Warning:</b> The port must be different from the port for syslog </p></li>
</ul>

<h2>Options</h2>
[[File:options.png|Options]]
<ul>
<li><p>Number of device threads - How many threads to use for polling devices</p></li>
<li><p>Number of IP scaner threads - How many threads to use to search for devices</p></li>
<li><p>Web server port - port on which the web server will be launched</p></li>
<li><p>* debug - additional logs for services</p></li>
<li><p>Device service timer (min) - how often to automatically poll devices</p></li>
<li><p>Double click on device - choose what will happen when you double-click or when you click on enter</p></li>
<li><p>SSH/Telnet - which application will open when you click on the button [[File:ssh.png|Start ssh]]</p></li>
<li><p>Text Backup allert - Adds a warning with the given text to the message body</p></li>
<li><p>Size logs/tmp - shows folder size</p></li>
<li><p>Clear logs/tmp - clears all contents of folders</p></li>
</ul>

<h3>Users and permisions</h3>
<p>When you click on the [[File:add.png|Add User]] button, you can add a user with defined access rights to the application.</p>
[[File:adduser.jpg|Users and permisions]]

<h1>'''Install and Start services'''</h1>
<ul>
<li><p>To install the service, you must click on the install button next to the name of the service.</p></li>
<li><p>To start the service, you must click on the start button next to the name of the service.</p></li>
</ul>
[[File:Services.png|Services]]

<h1>'''How to Upgrade MupsBox'''</h1>
<ul>
<li><p>The first step is to stop all services.</p></li>
<li><p>Next, you need to uninstall all services.</p></li>
<li><p>After downloading the archive of the new version of the program.</p></li>
<li><p>Unpack the contents of the archive into the folder where MupsBox software is installed.</p></li>
<li><p>After starting the program, the system will offer you to update the database. Click Update.</p></li>
</ul>
[[File:Upgrade_db2.png|Upgrade DB]]
<ul>
<li><p>After updating the database, install and start the services.</p></li>
</ul>
<h1>'''Activation'''</h1>
<p>Activation shows what level of license is installed in your copy of the MupsBOX program.
To activate your license level, you need to fill your real email address, select the license level of the module you want to activate and click Save Level. After that, you need to generate your License ID by clicking the Get License ID button, you will receive a unique identifier that you need to send to email '''support@mupssoft.com''', our specialists will generate a key that will send you back to email. The resulting key must be placed in the License key field, click the Save button and restart the program.</p>
[[File:activation.png|Activation]]

<div id="BackToTop" class="noprint" style="background-color:#DDEFDD; position:fixed;
bottom:32px; left:2%; z-index:9999; padding:0; margin:0;"><span style="color:blue;
font-size:8pt; font-face:verdana,sans-serif; border:0.2em outset #ceebf7;
padding:0.1em; font-weight:bolder; -moz-border-radius:8px; ">
[[#top| Back to the Top]]</span></div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>

Install and Basic Configuration

2021-06-06T11:48:27Z

Sergey:

<h1>'''How to install and Upgrade MupsBox'''</h1>
<p>Starting with version 1.4, the program is shipped with the installer, which simplifies the process of installing and updating the program.</p>
[[File:Install selectdir.png|thumb]]
<br>
<h2>'''Install Firebird 3.x'''</h2>
There is a Firebird database used to store data like connection data to devices, temporary data, statistical data, etc. MupsBox uses version 3.x. Download the https://firebirdsql.org/en/server-packages/. When you start the installation, select a language, accept the terms of the agreement, select the installation folder, select which components to install (you can leave the default), create shortcuts in the menu, select additional tasks ( can be left by default).<br>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Warning:</b> Firebird 2.5 database support terminated.</p></div>
<br />
<p>It's necessary to enable api or api-ssl port for communication between MUPSBOX application and RouterOS device. Use command on ROS: IP → Services </p>

[[File:api-enable.png|API]]

<p>ip service disable www,www-ssl,ftp,ssh,telnet<br>
ip service set api-ssl disabled=no address=1.1.1.1<br>
1.1.1.1 - ip address of the PC where MUPSBOX is installed<br></p>

<h2>The location of the program on the server.</h2>
<p>You need to place the executable program files in the same folder with the following files</p>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">
[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Attention:</b> If your antivirus warns that one of our services is Trojan or Malware, send these files to the antivirus vendor so that they add their signatures to the exceptions. We do not have Trojans and other filth.</p></div>
<p><ul>
<li>MupsBox.exe - is the main application, a device management GUI application.<br></li>
<li>MBTrafficser.exe - is a service for regularly receiving Traffic Accounting data.<br></li>
<li>MBBackupService.exe - is a service for running backup tasks.<br></li>
<li>MBFtpService.exe - is a service for running an ftp server on your PC.<br></li>
<li>MBSyslogService.exe - is a data collection service for the Syslog module.<br></li>
<li>MBPoolingService.exe - A service that polls devices for a given timer.<br></li>
<li>Config.ini - application configuration file.<br></li>
<li>MBDB.FDB - application database file.<br></li>
<li>Fbclient.dll - is an application and database interaction library.<br></li>
<li>deftitle.rtf - File for editing the report title<br></li>
<li>defbottom.rtf - File for editing report style<br></li>
<li>ssleay32.dll and libeay32.dll - SSL libraries</li>
<li>libssh2.dll and libcrypto-1_1-x64.dll - library for the client part of sftp</li>
<li>msvcp110.dll, vcruntime140.dll, msvcr110.dll, msvcr100.dll - supporting libraries</li>
</ul></p>

<h1>'''First start'''</h1>
<p>When you first start MupsBox.exe, you should create a new database or open an existing database.</p>
[[File:Create-DB.png|DataBase Settings]]
<p>If you are installing the program for the first time, then click Create. If you already have a database, click Open.</p>
<p>After clicking on the selected button, a window will appear, where you need to select the path and name to save or open your database.</p>
[[File:select-path.png|Select Path]]
<p>After you have chosen a place to create or open your database and give it a name, click the Save or Open button. And you will see that the database was created (opened) as in the image below.</p>
[[File:DB-created2.png|DB Created]]

<h1>'''Before install services'''</h1>
<p>It's necessary to configure settings for services Syslog, FTP and also configure notifications.</p>

<h2>Notifications</h2>
[[File:notifications.png|Notifications]]
<ul>
<li><p>Mail server - your mail server</p></li>
<li><p>Mail port - port without SSL</p></li>
<li><p>Mail user - username to logon to mail server</p></li>
<li><p>Mail password - password for your username</p></li>
<li><p>Mail From - Custom MAIL FROM</p></li>
<li><p>Mail global recipient - mail to send all notifications(can be redefined in jobs)</p></li>
<li><p>SSL port - port with SSL</p></li>
<li><p>Save - save your settings for notifications</p></li>
<li><p>Check - MupsBox will send a test email</p></li>
</ul>

<h2>Local FTP/SFTP</h2>
[[File:ftp-service.png|FTP Service]]
<br>
[[File:sftp-service.png|SFTP Service]]
<ul>
<li><p>User - username to connect to the local FTP service</p></li>
<li><p>Password - Password to connect to the local FTP service</p></li>
<li><p>Directory - Folder in which they will connect via FTP</p></li>
<li><p>Port - FTP - port</p></li>
</ul>

<h2>Syslog</h2>
[[File:syslog-service.png|Syslog]]
<ul>
<li><p>127.0.0.1 - your local IP or your IP address to listen all by UDP</p></li>
<li><p>514 - UDP port to listen to messages</p></li>
</ul>

<h2>HotSpot</h2>
[[File:hotspot-service.png|Hotspot]]
<ul>
<li><p>IP AddressSyslog for Hotspot gateway - your local IP or your IP address to listen all by UDP</p></li>
<li><p>Port Syslog for Hotspot Gateway - UDP port to listen to messages. <b style="color:red;">Warning:</b> The port must be different from the port for syslog </p></li>
</ul>

<h2>Options</h2>
[[File:options.png|Options]]
<ul>
<li><p>Number of device threads - How many threads to use for polling devices</p></li>
<li><p>Number of IP scaner threads - How many threads to use to search for devices</p></li>
<li><p>Web server port - port on which the web server will be launched</p></li>
<li><p>* debug - additional logs for services</p></li>
<li><p>Device service timer (min) - how often to automatically poll devices</p></li>
<li><p>Double click on device - choose what will happen when you double-click or when you click on enter</p></li>
<li><p>SSH/Telnet - which application will open when you click on the button [[File:ssh.png|Start ssh]]</p></li>
<li><p>Text Backup allert - Adds a warning with the given text to the message body</p></li>
<li><p>Size logs/tmp - shows folder size</p></li>
<li><p>Clear logs/tmp - clears all contents of folders</p></li>
</ul>

<h3>Users and permisions</h3>
<p>When you click on the [[File:add.png|Add User]] button, you can add a user with defined access rights to the application.</p>
[[File:adduser.jpg|Users and permisions]]

<h1>'''Install and Start services'''</h1>
<ul>
<li><p>To install the service, you must click on the install button next to the name of the service.</p></li>
<li><p>To start the service, you must click on the start button next to the name of the service.</p></li>
</ul>
[[File:Services.png|Services]]

<h1>'''How to Upgrade MupsBox'''</h1>
<ul>
<li><p>The first step is to stop all services.</p></li>
<li><p>Next, you need to uninstall all services.</p></li>
<li><p>After downloading the archive of the new version of the program.</p></li>
<li><p>Unpack the contents of the archive into the folder where MupsBox software is installed.</p></li>
<li><p>After starting the program, the system will offer you to update the database. Click Update.</p></li>
</ul>
[[File:Upgrade_db2.png|Upgrade DB]]
<ul>
<li><p>After updating the database, install and start the services.</p></li>
</ul>
<h1>'''Activation'''</h1>
<p>Activation shows what level of license is installed in your copy of the MupsBOX program.
To activate your license level, you need to fill your real email address, select the license level of the module you want to activate and click Save Level. After that, you need to generate your License ID by clicking the Get License ID button, you will receive a unique identifier that you need to send to email '''support@mupssoft.com''', our specialists will generate a key that will send you back to email. The resulting key must be placed in the License key field, click the Save button and restart the program.</p>
[[File:activation.png|Activation]]

<div id="BackToTop" class="noprint" style="background-color:#DDEFDD; position:fixed;
bottom:32px; left:2%; z-index:9999; padding:0; margin:0;"><span style="color:blue;
font-size:8pt; font-face:verdana,sans-serif; border:0.2em outset #ceebf7;
padding:0.1em; font-weight:bolder; -moz-border-radius:8px; ">
[[#top| Back to the Top]]</span></div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>

Install and Basic Configuration

2021-06-06T11:46:52Z

Sergey:

<h1>'''How to install and Upgrade MupsBox'''</h1>
<p>Starting with version 1.4, the program is shipped with the installer, which simplifies the process of installing and updating the program.</p>
[[File:Install selectdir.png|thumb|alt=|left]]
<br>
<h2>'''Install Firebird 3.x'''</h2>
There is a Firebird database used to store data like connection data to devices, temporary data, statistical data, etc. MupsBox uses version 3.x. Download the https://firebirdsql.org/en/server-packages/. When you start the installation, select a language, accept the terms of the agreement, select the installation folder, select which components to install (you can leave the default), create shortcuts in the menu, select additional tasks ( can be left by default).<br>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Warning:</b> Firebird 2.5 database support terminated.</p></div>
<br />
<p>It's necessary to enable api or api-ssl port for communication between MUPSBOX application and RouterOS device. Use command on ROS: IP → Services </p>

[[File:api-enable.png|API]]

<p>ip service disable www,www-ssl,ftp,ssh,telnet<br>
ip service set api-ssl disabled=no address=1.1.1.1<br>
1.1.1.1 - ip address of the PC where MUPSBOX is installed<br></p>

<h2>The location of the program on the server.</h2>
<p>You need to place the executable program files in the same folder with the following files</p>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">
[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Attention:</b> If your antivirus warns that one of our services is Trojan or Malware, send these files to the antivirus vendor so that they add their signatures to the exceptions. We do not have Trojans and other filth.</p></div>
<p><ul>
<li>MupsBox.exe - is the main application, a device management GUI application.<br></li>
<li>MBTrafficser.exe - is a service for regularly receiving Traffic Accounting data.<br></li>
<li>MBBackupService.exe - is a service for running backup tasks.<br></li>
<li>MBFtpService.exe - is a service for running an ftp server on your PC.<br></li>
<li>MBSyslogService.exe - is a data collection service for the Syslog module.<br></li>
<li>MBPoolingService.exe - A service that polls devices for a given timer.<br></li>
<li>Config.ini - application configuration file.<br></li>
<li>MBDB.FDB - application database file.<br></li>
<li>Fbclient.dll - is an application and database interaction library.<br></li>
<li>deftitle.rtf - File for editing the report title<br></li>
<li>defbottom.rtf - File for editing report style<br></li>
<li>ssleay32.dll and libeay32.dll - SSL libraries</li>
<li>libssh2.dll and libcrypto-1_1-x64.dll - library for the client part of sftp</li>
<li>msvcp110.dll, vcruntime140.dll, msvcr110.dll, msvcr100.dll - supporting libraries</li>
</ul></p>

<h1>'''First start'''</h1>
<p>When you first start MupsBox.exe, you should create a new database or open an existing database.</p>
[[File:Create-DB.png|DataBase Settings]]
<p>If you are installing the program for the first time, then click Create. If you already have a database, click Open.</p>
<p>After clicking on the selected button, a window will appear, where you need to select the path and name to save or open your database.</p>
[[File:select-path.png|Select Path]]
<p>After you have chosen a place to create or open your database and give it a name, click the Save or Open button. And you will see that the database was created (opened) as in the image below.</p>
[[File:DB-created2.png|DB Created]]

<h1>'''Before install services'''</h1>
<p>It's necessary to configure settings for services Syslog, FTP and also configure notifications.</p>

<h2>Notifications</h2>
[[File:notifications.png|Notifications]]
<ul>
<li><p>Mail server - your mail server</p></li>
<li><p>Mail port - port without SSL</p></li>
<li><p>Mail user - username to logon to mail server</p></li>
<li><p>Mail password - password for your username</p></li>
<li><p>Mail From - Custom MAIL FROM</p></li>
<li><p>Mail global recipient - mail to send all notifications(can be redefined in jobs)</p></li>
<li><p>SSL port - port with SSL</p></li>
<li><p>Save - save your settings for notifications</p></li>
<li><p>Check - MupsBox will send a test email</p></li>
</ul>

<h2>Local FTP/SFTP</h2>
[[File:ftp-service.png|FTP Service]]
<br>
[[File:sftp-service.png|SFTP Service]]
<ul>
<li><p>User - username to connect to the local FTP service</p></li>
<li><p>Password - Password to connect to the local FTP service</p></li>
<li><p>Directory - Folder in which they will connect via FTP</p></li>
<li><p>Port - FTP - port</p></li>
</ul>

<h2>Syslog</h2>
[[File:syslog-service.png|Syslog]]
<ul>
<li><p>127.0.0.1 - your local IP or your IP address to listen all by UDP</p></li>
<li><p>514 - UDP port to listen to messages</p></li>
</ul>

<h2>HotSpot</h2>
[[File:hotspot-service.png|Hotspot]]
<ul>
<li><p>IP AddressSyslog for Hotspot gateway - your local IP or your IP address to listen all by UDP</p></li>
<li><p>Port Syslog for Hotspot Gateway - UDP port to listen to messages. <b style="color:red;">Warning:</b> The port must be different from the port for syslog </p></li>
</ul>

<h2>Options</h2>
[[File:options.png|Options]]
<ul>
<li><p>Number of device threads - How many threads to use for polling devices</p></li>
<li><p>Number of IP scaner threads - How many threads to use to search for devices</p></li>
<li><p>Web server port - port on which the web server will be launched</p></li>
<li><p>* debug - additional logs for services</p></li>
<li><p>Device service timer (min) - how often to automatically poll devices</p></li>
<li><p>Double click on device - choose what will happen when you double-click or when you click on enter</p></li>
<li><p>SSH/Telnet - which application will open when you click on the button [[File:ssh.png|Start ssh]]</p></li>
<li><p>Text Backup allert - Adds a warning with the given text to the message body</p></li>
<li><p>Size logs/tmp - shows folder size</p></li>
<li><p>Clear logs/tmp - clears all contents of folders</p></li>
</ul>

<h3>Users and permisions</h3>
<p>When you click on the [[File:add.png|Add User]] button, you can add a user with defined access rights to the application.</p>
[[File:adduser.jpg|Users and permisions]]

<h1>'''Install and Start services'''</h1>
<ul>
<li><p>To install the service, you must click on the install button next to the name of the service.</p></li>
<li><p>To start the service, you must click on the start button next to the name of the service.</p></li>
</ul>
[[File:Services.png|Services]]

<h1>'''How to Upgrade MupsBox'''</h1>
<ul>
<li><p>The first step is to stop all services.</p></li>
<li><p>Next, you need to uninstall all services.</p></li>
<li><p>After downloading the archive of the new version of the program.</p></li>
<li><p>Unpack the contents of the archive into the folder where MupsBox software is installed.</p></li>
<li><p>After starting the program, the system will offer you to update the database. Click Update.</p></li>
</ul>
[[File:Upgrade_db2.png|Upgrade DB]]
<ul>
<li><p>After updating the database, install and start the services.</p></li>
</ul>
<h1>'''Activation'''</h1>
<p>Activation shows what level of license is installed in your copy of the MupsBOX program.
To activate your license level, you need to fill your real email address, select the license level of the module you want to activate and click Save Level. After that, you need to generate your License ID by clicking the Get License ID button, you will receive a unique identifier that you need to send to email '''support@mupssoft.com''', our specialists will generate a key that will send you back to email. The resulting key must be placed in the License key field, click the Save button and restart the program.</p>
[[File:activation.png|Activation]]

<div id="BackToTop" class="noprint" style="background-color:#DDEFDD; position:fixed;
bottom:32px; left:2%; z-index:9999; padding:0; margin:0;"><span style="color:blue;
font-size:8pt; font-face:verdana,sans-serif; border:0.2em outset #ceebf7;
padding:0.1em; font-weight:bolder; -moz-border-radius:8px; ">
[[#top| Back to the Top]]</span></div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>

Install and Basic Configuration

2021-06-06T11:45:43Z

Sergey:

<h1>'''How to install and Upgrade MupsBox'''</h1>
Starting with version 1.4, the program is shipped with the installer, which simplifies the process of installing and updating the program.
[[File:Install selectdir.png|thumb|alt=|left]]
<br>

<h2>'''Install Firebird 3.x'''</h2>
There is a Firebird database used to store data like connection data to devices, temporary data, statistical data, etc. MupsBox uses version 3.x. Download the https://firebirdsql.org/en/server-packages/. When you start the installation, select a language, accept the terms of the agreement, select the installation folder, select which components to install (you can leave the default), create shortcuts in the menu, select additional tasks ( can be left by default).<br>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Warning:</b> Firebird 2.5 database support terminated.</p></div>
<br />
<p>It's necessary to enable api or api-ssl port for communication between MUPSBOX application and RouterOS device. Use command on ROS: IP → Services </p>

[[File:api-enable.png|API]]

<p>ip service disable www,www-ssl,ftp,ssh,telnet<br>
ip service set api-ssl disabled=no address=1.1.1.1<br>
1.1.1.1 - ip address of the PC where MUPSBOX is installed<br></p>

<h2>The location of the program on the server.</h2>
<p>You need to place the executable program files in the same folder with the following files</p>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">
[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Attention:</b> If your antivirus warns that one of our services is Trojan or Malware, send these files to the antivirus vendor so that they add their signatures to the exceptions. We do not have Trojans and other filth.</p></div>
<p><ul>
<li>MupsBox.exe - is the main application, a device management GUI application.<br></li>
<li>MBTrafficser.exe - is a service for regularly receiving Traffic Accounting data.<br></li>
<li>MBBackupService.exe - is a service for running backup tasks.<br></li>
<li>MBFtpService.exe - is a service for running an ftp server on your PC.<br></li>
<li>MBSyslogService.exe - is a data collection service for the Syslog module.<br></li>
<li>MBPoolingService.exe - A service that polls devices for a given timer.<br></li>
<li>Config.ini - application configuration file.<br></li>
<li>MBDB.FDB - application database file.<br></li>
<li>Fbclient.dll - is an application and database interaction library.<br></li>
<li>deftitle.rtf - File for editing the report title<br></li>
<li>defbottom.rtf - File for editing report style<br></li>
<li>ssleay32.dll and libeay32.dll - SSL libraries</li>
<li>libssh2.dll and libcrypto-1_1-x64.dll - library for the client part of sftp</li>
<li>msvcp110.dll, vcruntime140.dll, msvcr110.dll, msvcr100.dll - supporting libraries</li>
</ul></p>

<h1>'''First start'''</h1>
<p>When you first start MupsBox.exe, you should create a new database or open an existing database.</p>
[[File:Create-DB.png|DataBase Settings]]
<p>If you are installing the program for the first time, then click Create. If you already have a database, click Open.</p>
<p>After clicking on the selected button, a window will appear, where you need to select the path and name to save or open your database.</p>
[[File:select-path.png|Select Path]]
<p>After you have chosen a place to create or open your database and give it a name, click the Save or Open button. And you will see that the database was created (opened) as in the image below.</p>
[[File:DB-created2.png|DB Created]]

<h1>'''Before install services'''</h1>
<p>It's necessary to configure settings for services Syslog, FTP and also configure notifications.</p>

<h2>Notifications</h2>
[[File:notifications.png|Notifications]]
<ul>
<li><p>Mail server - your mail server</p></li>
<li><p>Mail port - port without SSL</p></li>
<li><p>Mail user - username to logon to mail server</p></li>
<li><p>Mail password - password for your username</p></li>
<li><p>Mail From - Custom MAIL FROM</p></li>
<li><p>Mail global recipient - mail to send all notifications(can be redefined in jobs)</p></li>
<li><p>SSL port - port with SSL</p></li>
<li><p>Save - save your settings for notifications</p></li>
<li><p>Check - MupsBox will send a test email</p></li>
</ul>

<h2>Local FTP/SFTP</h2>
[[File:ftp-service.png|FTP Service]]
<br>
[[File:sftp-service.png|SFTP Service]]
<ul>
<li><p>User - username to connect to the local FTP service</p></li>
<li><p>Password - Password to connect to the local FTP service</p></li>
<li><p>Directory - Folder in which they will connect via FTP</p></li>
<li><p>Port - FTP - port</p></li>
</ul>

<h2>Syslog</h2>
[[File:syslog-service.png|Syslog]]
<ul>
<li><p>127.0.0.1 - your local IP or your IP address to listen all by UDP</p></li>
<li><p>514 - UDP port to listen to messages</p></li>
</ul>

<h2>HotSpot</h2>
[[File:hotspot-service.png|Hotspot]]
<ul>
<li><p>IP AddressSyslog for Hotspot gateway - your local IP or your IP address to listen all by UDP</p></li>
<li><p>Port Syslog for Hotspot Gateway - UDP port to listen to messages. <b style="color:red;">Warning:</b> The port must be different from the port for syslog </p></li>
</ul>

<h2>Options</h2>
[[File:options.png|Options]]
<ul>
<li><p>Number of device threads - How many threads to use for polling devices</p></li>
<li><p>Number of IP scaner threads - How many threads to use to search for devices</p></li>
<li><p>Web server port - port on which the web server will be launched</p></li>
<li><p>* debug - additional logs for services</p></li>
<li><p>Device service timer (min) - how often to automatically poll devices</p></li>
<li><p>Double click on device - choose what will happen when you double-click or when you click on enter</p></li>
<li><p>SSH/Telnet - which application will open when you click on the button [[File:ssh.png|Start ssh]]</p></li>
<li><p>Text Backup allert - Adds a warning with the given text to the message body</p></li>
<li><p>Size logs/tmp - shows folder size</p></li>
<li><p>Clear logs/tmp - clears all contents of folders</p></li>
</ul>

<h3>Users and permisions</h3>
<p>When you click on the [[File:add.png|Add User]] button, you can add a user with defined access rights to the application.</p>
[[File:adduser.jpg|Users and permisions]]

<h1>'''Install and Start services'''</h1>
<ul>
<li><p>To install the service, you must click on the install button next to the name of the service.</p></li>
<li><p>To start the service, you must click on the start button next to the name of the service.</p></li>
</ul>
[[File:Services.png|Services]]

<h1>'''How to Upgrade MupsBox'''</h1>
<ul>
<li><p>The first step is to stop all services.</p></li>
<li><p>Next, you need to uninstall all services.</p></li>
<li><p>After downloading the archive of the new version of the program.</p></li>
<li><p>Unpack the contents of the archive into the folder where MupsBox software is installed.</p></li>
<li><p>After starting the program, the system will offer you to update the database. Click Update.</p></li>
</ul>
[[File:Upgrade_db2.png|Upgrade DB]]
<ul>
<li><p>After updating the database, install and start the services.</p></li>
</ul>
<h1>'''Activation'''</h1>
<p>Activation shows what level of license is installed in your copy of the MupsBOX program.
To activate your license level, you need to fill your real email address, select the license level of the module you want to activate and click Save Level. After that, you need to generate your License ID by clicking the Get License ID button, you will receive a unique identifier that you need to send to email '''support@mupssoft.com''', our specialists will generate a key that will send you back to email. The resulting key must be placed in the License key field, click the Save button and restart the program.</p>
[[File:activation.png|Activation]]

<div id="BackToTop" class="noprint" style="background-color:#DDEFDD; position:fixed;
bottom:32px; left:2%; z-index:9999; padding:0; margin:0;"><span style="color:blue;
font-size:8pt; font-face:verdana,sans-serif; border:0.2em outset #ceebf7;
padding:0.1em; font-weight:bolder; -moz-border-radius:8px; ">
[[#top| Back to the Top]]</span></div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>

Install and Basic Configuration

2021-06-06T11:45:01Z

Sergey:

<h1>'''How to install and Upgrade MupsBox'''</h1>
Starting with version 1.4, the program is shipped with the installer, which simplifies the process of installing and updating the program.
[[File:Install selectdir.png|thumb|alt=|left]]
<br>
<h2>'''Install Firebird 3.x'''</h2>
There is a Firebird database used to store data like connection data to devices, temporary data, statistical data, etc. MupsBox uses version 3.x. Download the https://firebirdsql.org/en/server-packages/. When you start the installation, select a language, accept the terms of the agreement, select the installation folder, select which components to install (you can leave the default), create shortcuts in the menu, select additional tasks ( can be left by default).<br>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Warning:</b> Firebird 2.5 database support terminated.</p></div>
<br />
<p>It's necessary to enable api or api-ssl port for communication between MUPSBOX application and RouterOS device. Use command on ROS: IP → Services </p>

[[File:api-enable.png|API]]

<p>ip service disable www,www-ssl,ftp,ssh,telnet<br>
ip service set api-ssl disabled=no address=1.1.1.1<br>
1.1.1.1 - ip address of the PC where MUPSBOX is installed<br></p>

<h2>The location of the program on the server.</h2>
<p>You need to place the executable program files in the same folder with the following files</p>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">
[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Attention:</b> If your antivirus warns that one of our services is Trojan or Malware, send these files to the antivirus vendor so that they add their signatures to the exceptions. We do not have Trojans and other filth.</p></div>
<p><ul>
<li>MupsBox.exe - is the main application, a device management GUI application.<br></li>
<li>MBTrafficser.exe - is a service for regularly receiving Traffic Accounting data.<br></li>
<li>MBBackupService.exe - is a service for running backup tasks.<br></li>
<li>MBFtpService.exe - is a service for running an ftp server on your PC.<br></li>
<li>MBSyslogService.exe - is a data collection service for the Syslog module.<br></li>
<li>MBPoolingService.exe - A service that polls devices for a given timer.<br></li>
<li>Config.ini - application configuration file.<br></li>
<li>MBDB.FDB - application database file.<br></li>
<li>Fbclient.dll - is an application and database interaction library.<br></li>
<li>deftitle.rtf - File for editing the report title<br></li>
<li>defbottom.rtf - File for editing report style<br></li>
<li>ssleay32.dll and libeay32.dll - SSL libraries</li>
<li>libssh2.dll and libcrypto-1_1-x64.dll - library for the client part of sftp</li>
<li>msvcp110.dll, vcruntime140.dll, msvcr110.dll, msvcr100.dll - supporting libraries</li>
</ul></p>

<h1>'''First start'''</h1>
<p>When you first start MupsBox.exe, you should create a new database or open an existing database.</p>
[[File:Create-DB.png|DataBase Settings]]
<p>If you are installing the program for the first time, then click Create. If you already have a database, click Open.</p>
<p>After clicking on the selected button, a window will appear, where you need to select the path and name to save or open your database.</p>
[[File:select-path.png|Select Path]]
<p>After you have chosen a place to create or open your database and give it a name, click the Save or Open button. And you will see that the database was created (opened) as in the image below.</p>
[[File:DB-created2.png|DB Created]]

<h1>'''Before install services'''</h1>
<p>It's necessary to configure settings for services Syslog, FTP and also configure notifications.</p>

<h2>Notifications</h2>
[[File:notifications.png|Notifications]]
<ul>
<li><p>Mail server - your mail server</p></li>
<li><p>Mail port - port without SSL</p></li>
<li><p>Mail user - username to logon to mail server</p></li>
<li><p>Mail password - password for your username</p></li>
<li><p>Mail From - Custom MAIL FROM</p></li>
<li><p>Mail global recipient - mail to send all notifications(can be redefined in jobs)</p></li>
<li><p>SSL port - port with SSL</p></li>
<li><p>Save - save your settings for notifications</p></li>
<li><p>Check - MupsBox will send a test email</p></li>
</ul>

<h2>Local FTP/SFTP</h2>
[[File:ftp-service.png|FTP Service]]
<br>
[[File:sftp-service.png|SFTP Service]]
<ul>
<li><p>User - username to connect to the local FTP service</p></li>
<li><p>Password - Password to connect to the local FTP service</p></li>
<li><p>Directory - Folder in which they will connect via FTP</p></li>
<li><p>Port - FTP - port</p></li>
</ul>

<h2>Syslog</h2>
[[File:syslog-service.png|Syslog]]
<ul>
<li><p>127.0.0.1 - your local IP or your IP address to listen all by UDP</p></li>
<li><p>514 - UDP port to listen to messages</p></li>
</ul>

<h2>HotSpot</h2>
[[File:hotspot-service.png|Hotspot]]
<ul>
<li><p>IP AddressSyslog for Hotspot gateway - your local IP or your IP address to listen all by UDP</p></li>
<li><p>Port Syslog for Hotspot Gateway - UDP port to listen to messages. <b style="color:red;">Warning:</b> The port must be different from the port for syslog </p></li>
</ul>

<h2>Options</h2>
[[File:options.png|Options]]
<ul>
<li><p>Number of device threads - How many threads to use for polling devices</p></li>
<li><p>Number of IP scaner threads - How many threads to use to search for devices</p></li>
<li><p>Web server port - port on which the web server will be launched</p></li>
<li><p>* debug - additional logs for services</p></li>
<li><p>Device service timer (min) - how often to automatically poll devices</p></li>
<li><p>Double click on device - choose what will happen when you double-click or when you click on enter</p></li>
<li><p>SSH/Telnet - which application will open when you click on the button [[File:ssh.png|Start ssh]]</p></li>
<li><p>Text Backup allert - Adds a warning with the given text to the message body</p></li>
<li><p>Size logs/tmp - shows folder size</p></li>
<li><p>Clear logs/tmp - clears all contents of folders</p></li>
</ul>

<h3>Users and permisions</h3>
<p>When you click on the [[File:add.png|Add User]] button, you can add a user with defined access rights to the application.</p>
[[File:adduser.jpg|Users and permisions]]

<h1>'''Install and Start services'''</h1>
<ul>
<li><p>To install the service, you must click on the install button next to the name of the service.</p></li>
<li><p>To start the service, you must click on the start button next to the name of the service.</p></li>
</ul>
[[File:Services.png|Services]]

<h1>'''How to Upgrade MupsBox'''</h1>
<ul>
<li><p>The first step is to stop all services.</p></li>
<li><p>Next, you need to uninstall all services.</p></li>
<li><p>After downloading the archive of the new version of the program.</p></li>
<li><p>Unpack the contents of the archive into the folder where MupsBox software is installed.</p></li>
<li><p>After starting the program, the system will offer you to update the database. Click Update.</p></li>
</ul>
[[File:Upgrade_db2.png|Upgrade DB]]
<ul>
<li><p>After updating the database, install and start the services.</p></li>
</ul>
<h1>'''Activation'''</h1>
<p>Activation shows what level of license is installed in your copy of the MupsBOX program.
To activate your license level, you need to fill your real email address, select the license level of the module you want to activate and click Save Level. After that, you need to generate your License ID by clicking the Get License ID button, you will receive a unique identifier that you need to send to email '''support@mupssoft.com''', our specialists will generate a key that will send you back to email. The resulting key must be placed in the License key field, click the Save button and restart the program.</p>
[[File:activation.png|Activation]]

<div id="BackToTop" class="noprint" style="background-color:#DDEFDD; position:fixed;
bottom:32px; left:2%; z-index:9999; padding:0; margin:0;"><span style="color:blue;
font-size:8pt; font-face:verdana,sans-serif; border:0.2em outset #ceebf7;
padding:0.1em; font-weight:bolder; -moz-border-radius:8px; ">
[[#top| Back to the Top]]</span></div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>

Install and Basic Configuration

2021-06-06T11:43:33Z

Sergey:

<h1>'''How to install and Upgrade MupsBox'''</h1>Starting with version 1.4, the program is shipped with the installer, which simplifies the process of installing and updating the program.
[[File:Install selectdir.png|thumb|alt=|left]]
<h2>'''Install Firebird 3.x'''</h2>
There is a Firebird database used to store data like connection data to devices, temporary data, statistical data, etc. MupsBox uses version 3.x. Download the https://firebirdsql.org/en/server-packages/. When you start the installation, select a language, accept the terms of the agreement, select the installation folder, select which components to install (you can leave the default), create shortcuts in the menu, select additional tasks ( can be left by default).<br>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Warning:</b> Firebird 2.5 database support terminated.</p></div>
<br />
<p>It's necessary to enable api or api-ssl port for communication between MUPSBOX application and RouterOS device. Use command on ROS: IP → Services </p>

[[File:api-enable.png|API]]

<p>ip service disable www,www-ssl,ftp,ssh,telnet<br>
ip service set api-ssl disabled=no address=1.1.1.1<br>
1.1.1.1 - ip address of the PC where MUPSBOX is installed<br></p>

<h2>The location of the program on the server.</h2>
<p>You need to place the executable program files in the same folder with the following files</p>
<div id="shbox" style=" border-width:1px; border-color:lightgrey; padding: 2px 5px 2px 10px; min-height:56px; border-style:solid; font-size: 0.9em;">
[[File:Icon-warn.png|left|56px]]
<p style="margin-top:10px; margin-left: 56px;"><b style="color:red;">Attention:</b> If your antivirus warns that one of our services is Trojan or Malware, send these files to the antivirus vendor so that they add their signatures to the exceptions. We do not have Trojans and other filth.</p></div>
<p><ul>
<li>MupsBox.exe - is the main application, a device management GUI application.<br></li>
<li>MBTrafficser.exe - is a service for regularly receiving Traffic Accounting data.<br></li>
<li>MBBackupService.exe - is a service for running backup tasks.<br></li>
<li>MBFtpService.exe - is a service for running an ftp server on your PC.<br></li>
<li>MBSyslogService.exe - is a data collection service for the Syslog module.<br></li>
<li>MBPoolingService.exe - A service that polls devices for a given timer.<br></li>
<li>Config.ini - application configuration file.<br></li>
<li>MBDB.FDB - application database file.<br></li>
<li>Fbclient.dll - is an application and database interaction library.<br></li>
<li>deftitle.rtf - File for editing the report title<br></li>
<li>defbottom.rtf - File for editing report style<br></li>
<li>ssleay32.dll and libeay32.dll - SSL libraries</li>
<li>libssh2.dll and libcrypto-1_1-x64.dll - library for the client part of sftp</li>
<li>msvcp110.dll, vcruntime140.dll, msvcr110.dll, msvcr100.dll - supporting libraries</li>
</ul></p>

<h1>'''First start'''</h1>
<p>When you first start MupsBox.exe, you should create a new database or open an existing database.</p>
[[File:Create-DB.png|DataBase Settings]]
<p>If you are installing the program for the first time, then click Create. If you already have a database, click Open.</p>
<p>After clicking on the selected button, a window will appear, where you need to select the path and name to save or open your database.</p>
[[File:select-path.png|Select Path]]
<p>After you have chosen a place to create or open your database and give it a name, click the Save or Open button. And you will see that the database was created (opened) as in the image below.</p>
[[File:DB-created2.png|DB Created]]

<h1>'''Before install services'''</h1>
<p>It's necessary to configure settings for services Syslog, FTP and also configure notifications.</p>

<h2>Notifications</h2>
[[File:notifications.png|Notifications]]
<ul>
<li><p>Mail server - your mail server</p></li>
<li><p>Mail port - port without SSL</p></li>
<li><p>Mail user - username to logon to mail server</p></li>
<li><p>Mail password - password for your username</p></li>
<li><p>Mail From - Custom MAIL FROM</p></li>
<li><p>Mail global recipient - mail to send all notifications(can be redefined in jobs)</p></li>
<li><p>SSL port - port with SSL</p></li>
<li><p>Save - save your settings for notifications</p></li>
<li><p>Check - MupsBox will send a test email</p></li>
</ul>

<h2>Local FTP/SFTP</h2>
[[File:ftp-service.png|FTP Service]]
<br>
[[File:sftp-service.png|SFTP Service]]
<ul>
<li><p>User - username to connect to the local FTP service</p></li>
<li><p>Password - Password to connect to the local FTP service</p></li>
<li><p>Directory - Folder in which they will connect via FTP</p></li>
<li><p>Port - FTP - port</p></li>
</ul>

<h2>Syslog</h2>
[[File:syslog-service.png|Syslog]]
<ul>
<li><p>127.0.0.1 - your local IP or your IP address to listen all by UDP</p></li>
<li><p>514 - UDP port to listen to messages</p></li>
</ul>

<h2>HotSpot</h2>
[[File:hotspot-service.png|Hotspot]]
<ul>
<li><p>IP AddressSyslog for Hotspot gateway - your local IP or your IP address to listen all by UDP</p></li>
<li><p>Port Syslog for Hotspot Gateway - UDP port to listen to messages. <b style="color:red;">Warning:</b> The port must be different from the port for syslog </p></li>
</ul>

<h2>Options</h2>
[[File:options.png|Options]]
<ul>
<li><p>Number of device threads - How many threads to use for polling devices</p></li>
<li><p>Number of IP scaner threads - How many threads to use to search for devices</p></li>
<li><p>Web server port - port on which the web server will be launched</p></li>
<li><p>* debug - additional logs for services</p></li>
<li><p>Device service timer (min) - how often to automatically poll devices</p></li>
<li><p>Double click on device - choose what will happen when you double-click or when you click on enter</p></li>
<li><p>SSH/Telnet - which application will open when you click on the button [[File:ssh.png|Start ssh]]</p></li>
<li><p>Text Backup allert - Adds a warning with the given text to the message body</p></li>
<li><p>Size logs/tmp - shows folder size</p></li>
<li><p>Clear logs/tmp - clears all contents of folders</p></li>
</ul>

<h3>Users and permisions</h3>
<p>When you click on the [[File:add.png|Add User]] button, you can add a user with defined access rights to the application.</p>
[[File:adduser.jpg|Users and permisions]]

<h1>'''Install and Start services'''</h1>
<ul>
<li><p>To install the service, you must click on the install button next to the name of the service.</p></li>
<li><p>To start the service, you must click on the start button next to the name of the service.</p></li>
</ul>
[[File:Services.png|Services]]

<h1>'''How to Upgrade MupsBox'''</h1>
<ul>
<li><p>The first step is to stop all services.</p></li>
<li><p>Next, you need to uninstall all services.</p></li>
<li><p>After downloading the archive of the new version of the program.</p></li>
<li><p>Unpack the contents of the archive into the folder where MupsBox software is installed.</p></li>
<li><p>After starting the program, the system will offer you to update the database. Click Update.</p></li>
</ul>
[[File:Upgrade_db2.png|Upgrade DB]]
<ul>
<li><p>After updating the database, install and start the services.</p></li>
</ul>
<h1>'''Activation'''</h1>
<p>Activation shows what level of license is installed in your copy of the MupsBOX program.
To activate your license level, you need to fill your real email address, select the license level of the module you want to activate and click Save Level. After that, you need to generate your License ID by clicking the Get License ID button, you will receive a unique identifier that you need to send to email '''support@mupssoft.com''', our specialists will generate a key that will send you back to email. The resulting key must be placed in the License key field, click the Save button and restart the program.</p>
[[File:activation.png|Activation]]

<div id="BackToTop" class="noprint" style="background-color:#DDEFDD; position:fixed;
bottom:32px; left:2%; z-index:9999; padding:0; margin:0;"><span style="color:blue;
font-size:8pt; font-face:verdana,sans-serif; border:0.2em outset #ceebf7;
padding:0.1em; font-weight:bolder; -moz-border-radius:8px; ">
[[#top| Back to the Top]]</span></div><div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>
<div id="turnkey-credit"> <div style="clear: both;"> [https://www.turnkeylinux.org/mediawiki MediaWiki Appliance] - Powered by [https://www.turnkeylinux.org TurnKey Linux] </div> </div>

File:Install selectdir.png

2021-06-06T11:39:52Z

Sergey:

Installation - select directory

HotSpot

2020-09-09T13:52:50Z

Sergey:

<h1>'''Hotspot module'''</h1>
<h2>'''How to'''</h2>
<p>The module is a powerful system MikroTik HotSpot -> user authorization. Ideal for hotels, offices, cafes, and other places where Internet access is required via Web authorization (via HotSpot gateway). The Hotspot module supports various types of authorization - authorization via SMS, creating tickets with different rights and times.
In order for the module to work, it is necessary to make sure that it is [[Install_and_Basic_Configuration#Install_and_Start_services|installed and running in Settings]]:</p>
<p>The interface of the hotspot module provides different tabs for regular tasks with wifi users and configuration hotspot on RouterOS devices. There are Users, Operators, Points, Gateways, Events, and Reports tabs.</p>
<h2>'''Basic HotSpot gateway configuration on Mikrotik RouterOS'''</h2>
<p>This paragraph does not apply to the description of the Hotspot module but contains information on configuring MikroTik ROS as a HotSpot gateway.</p>
<p><ul>
<li>Make sure that your router, which will act as a HotSpot gateway, is configured and has Internet access.<br></li>
<li>In our example, the router is configured and has Internet access. We will configure HotSpot on the "bridgeGuest" Interface.<br>[[File:wifi-inteface-create.png|Add new interface for WIFI]]</li>
<li>The HotSpot package must be installed on your router - this can be seen in the System -> packages tab.<br>[[File:wifi-system-packages.png|Install system packages]]</li>
<li>If the package is missing, download it (hotspot.npk), but always the same version as the system package. You need to install the package to the root (files), after which you need to reboot the router. Check that the package is installed.<br></li>
</ul></p>
<p>To configure HotSpot go to the system - hotspot section</p>
<p><ul>
<li>For quick setup, use the setup button, after a "wizard" will be launched to configure the hotspot. You need to define the interface behind which your hotspot users will be located.<br>[[File:wifi-hotspot-setup.png|Hotpot setup]]</li>
<li>For a more accurate configuration, an IP address must be registered on the HotSpot interface. It is this IP that will be automatically substituted when configuring HotSpot, if there is no IP address on the interface, the "wizard" will come up with it and substitute it.<br>[[File:wifi-hotspot-setup-1.png|Hotpot setup - step 1]]</li>
<li>You will be automatically prompted to create a Pool IP addresses for distribution to clients.<br>[[File:wifi-hotspot-setup-2.png|Hotpot setup - step 2]]</li>
<li>If you do not fill in the DNS Name field, then when users connect to the authorization page, the IP address of the interface will appear. If you specify a name, then it will be displayed.<br>[[File:wifi-hotspot-setup-3.png|Hotpot setup - step 3]]</li>
<li>You are prompted to create your first HotSpot user.<br>[[File:wifi-hotspot-setup-4.png|Hotpot setup - step 4]]</li>
<li>Congratulations! You have HotSpot configured.<br></li>
</ul></p>
<h2>'''Users'''</h2>
<p>When you click on the Users tab, you will see the following window:</p>
[[File:Wifi-users.PNG|Traffic Jobs]]
<p>There are 5 buttons on the Users tab:</p>
<p><ul>
<li>[[File:add.png|Add user]] - Add user on hotspot RouterOS and mupsbox database<br></li>
<li>[[File:remove.png|Delete user from hotspot]] - Delete user account on hotspot RouterOS and the Mupsbox database marks user account as deleted<br></li>
<li>[[File:Enable.png|Enable user]] - Enable user on hotspot RouterOS <br></li>
<li>[[File:Disable.png|Disable user]] - Disable user on hotspot RouterOS <br></li>
<li>[[File:Refresh.png|Refresh]] - Refresh window <br></li>
</ul></p>
<p>There are filtering checkboxes on the Users tab:</p>
<p><ul>
<li>[[File:Wifi-f-sms-users.png| Filtering only wifi SMS users]] - Show wifi user what authorizing via SMS code<br></li>
<li>[[File:Wifi-f-ticket-users.png|Filtering only wifi ticket users]] - Show wifi user what authorizing via ticket<br></li>
<li>[[File:Wifi-f-disabled-users.png|Filtering only disabled wifi users]] - Filtering only disabled wifi users<br></li>
<li>[[File: Wifi-f-removed-users.png|Filtering only removed wifi users]] - Filtering only removed wifi users<br></li>
</ul></p>
<h3>'''Add new wifi user'''</h3>
<p>Wifi operator can manualy add new user on hotspot RouterOS, account information in Mupsbox database, and genarate password by appropriate policy. In order for the program to add new user from your hotspot RouterOS, you must click on the [[File:add.png|Add user]], then the Add new wifi user window will open:</p>
[[File:Wifi-add-wifi-user.png|Add new wifi user]]
<p><ul>
<li>Login - The wifi user will use login for authorization on Hotspot RouterOS<br></li>
<li>Surname - The surname of wifi user. Available for ticket authorization only<br></li>
<li>Name - The name of wifi user. Available for ticket authorization only<br></li>
<li>Patronym - The patronym of wifi user. Available for ticket authorization only<br></li>
<li>Pasport № - The pasport number of wifi user. Available for ticket authorization only<br></li>
</ul></p>
<p>The operator can modify WIFI connection and WIFI passwords policies on user creation step.</p>
<p>The WIFI connection policy:</p>
<p><ul>
<li>Connection days - Number of connection days that wifi user will remain authorized to Hotspot RouterOS<br></li>
<li>Speed - The two-direction bandwidth for wifi users. There are predefined speed: 1M, 5M, 10M, unlim. It's possible use custom speed<br></li>
<li>Traffic - The traffic restriction for wifi users. There are predefined traffic restrictions: unlim, 1Gb, 2Gb, 5Gb, 10Gb. It's possible to use custom traffic restriction<br></li>
<li>Shared users - The number of users or wireless client devices what can work with one wifi user account<br></li>
</ul></p>

<p>The WIFI password policy:</p>
<p><ul>
<li>Password length- Length of a password. By default 4 chars<br></li>
<li>digits (0..9) - Requirement use digits in password<br></li>
<li>low case letters (a..z) - Requirement use low case letters in a password<br></li>
<li>high case letters (A..Z) - Requirement use high case letters in a password<br></li>
<li>simbols (!@#$%^*) - Requirement use symbols "!@#$%^*" in password<br></li>
</ul></p>
<p>When you click on Add User button, you will see the following window:</p>
[[File:Wifi-print-wifi-ticket.png|Print wifi ticket]]
<p>There is ticket can be printed. Print template can by modified by change wifi_ticket.rtf file what located in distributive folder.</p>

<h2>'''Operators'''</h2>
<p>This tab is used to associate Mupsbox users with Point. Point provides information about hotspot RouterOS devices and Gateways information.</p>
[[File:Wifi-operators.png|Wifi operators]]
<h3>'''Modify point for operator'''</h3>
<p>Use double-click on the operator and choose an appropriate point.</p>
[[File:Wifi-set-point.png|Wifi set point]]

<h2>'''Points'''</h2>
<p>This tab is used for configuration points. Point is the association RouterOS device, which works as hotspot and config of authorization wifi users (Gateway information).</p>
[[File:Wifi-points.png|Wifi points]]
<p>There are 5 buttons on the Points tab:</p>
<p><ul>
<li>[[File:add.png|Add hotspot point]] - Add hotspot point<br></li>
<li>[[File:remove.png|Delete hotspot point]] - Delete hotspot point<br></li>
<li>[[File:Enable.png|Enable hotspot point]] - Enable hotspot point<br></li>
<li>[[File:Disable.png|Disable hotspot point]] - Disable hotspot point<br></li>
<li>[[File:Refresh.png|Refresh]] - Refresh window <br></li>
</ul></p>
<p>When you click on Add hotspot point button, you will see the following window:</p>
[[File:Wifi-add-point.png|Wifi add hotspot point]]
<p><ul>
<li>Name - Name of the point<br></li>
<li>Device - RouterOS device what in the list of Device module. RouterOS should be configurated as a hotspot<br></li>
<li>Gateway - Set of authorization information. The gateway should be configurated before point creation<br></li>
</ul></p>

<h2>'''Gateways'''</h2>
<p>This tab is used for configuration gateways. Gateway is a set of information on how wifi users will authentification on hotspot RouterOS.</p>
[[File:Wifi-gateways.png|Wifi gateways]]
<p>There are 2 buttons on the Gateway tab:</p>
<p><ul>
<li>[[File:add.png|Add hotspot point]] - Add gateway<br></li>
<li>[[File:remove.png|Delete hotspot point]] - Delete gateway<br></li>
</ul></p>

<p>When you click on Add Gateway button, you will see the following window:</p>
[[File:Wifi-add-gateway.png|Add wifi gateways]]
<p><ul>
<li>Gateway name - unique Gateway name<br></li>
<li>Message- The Message that wifi user will receive on a mobile device with SMS code. There is a requirement to use #wifipassword# inside text. It's variable will change on generate a password with an appropriate wifi password policy <br></li>
<li>Mode - The Mode provides SMS authentification via the external provider or internal modem connected to RouterOS device<br></li>
<li>External string - The string (web-link)of autentification your on external sms provider. There is a requirement to use #phonenumber# and #smsmessage# inside text. The variable #phonenumber# is number that sms will sent. The variable #smsmessage# is text of Message field, text that will recieved by wifi users<br></li>
<li>RouterOS device - The RouterOS device that listed in Device module. The device will work as sms modem. There SMS model should be integrated or attached to RouterOS device<br></li>
<li>Modem type - If set to class-0, then send class 0 SMS message. It is displayed immedeately and not stored in phone<br></li>
<li>Modem port - The name of port from /port list that GSM modem is attached to<br></li>
<li>Modem channel - Which modem channel to use for sending.<br></li>
</ul></p>
<p>The WIFI connection policy is the same as in creation user process:</p>
<p><ul>
<li>Connection days - Number of connection days that wifi user will remain authorized to Hotspot RouterOS<br></li>
<li>Speed - The two-direction bandwidth for wifi users. There are predefined speed: 1M, 5M, 10M, unlim. It's possible use custom speed<br></li>
<li>Traffic - The traffic restriction for wifi users. There are predefined traffic restrictions: unlim, 1Gb, 2Gb, 5Gb, 10Gb. It's possible to use custom traffic restriction<br></li>
<li>Shared users - The number of users or wireless client devices what can work with one wifi user account<br></li>
</ul></p>
<p>The Gateway provides preflight check options like status, balance, and trying to send test SMS.</p>
<p>The Status string provides check variable options from the SMS provider if it's available.</p>
<p>The Balance string provides check balance options from the SMS provider if it's available.</p>
<p>The Phone number string provides check trying to send test SMS.</p>

<h2>'''Events'''</h2>
<p>The Events tab provides historical information about wifi user, their mobile devices, etc.</p>
[[File:Wifi-events.png|Wifi events]]
<p><ul>
<li>ID - The event ID created by mupsbox<br></li>
<li>Application time - The time that on mupsbox machine<br></li>
<li>Router time - The time that on hotspot RouterOS<br></li>
<li>Action - The description of event<br></li>
<li>User Login - The name of User Login for the current event. The information will write if available for that event<br></li>
<li>User Name - The name of User for the current event. The information will write if available for that event<br></li>
<li>User Surname - The surname of User for the current event. The information will write if available for that event<br></li>
<li>User Mac Address / IP - The Mac Address or IP of a wifi client device. The information will write if available for that event<br></li>
<li>Point - The Point which event is present<br></li>
<li>Gateway - The Gateway which event is present<br></li>
</ul></p>

<h2>'''Reports'''</h2>
<p>The Reports tab provides agrigate or combination information about wifi user, their mobile devices, etc. The information can be exported in Excel format.</p>
[[File:Wifi-reports.png|Wifi reports]]

<p>The first matrix provides information about wifi users with filtering options.</p>
<p>The second matrix provides information about the activity of wifi users with filtering time options.</p>

<div id="BackToTop" class="noprint" style="background-color:#DDEFDD; position:fixed;
bottom:32px; left:2%; z-index:9999; padding:0; margin:0;"><span style="color:blue;
font-size:8pt; font-face:verdana,sans-serif; border:0.2em outset #ceebf7;
padding:0.1em; font-weight:bolder; -moz-border-radius:8px; ">
[[#top| Back to the Top ]]</span></div>

HotSpot

2020-09-09T13:50:50Z

Sergey:

<h1>'''Hotspot module'''</h1>
<h2>'''How to'''</h2>
<p>The module is a powerful system MikroTik HotSpot -> user authorization. Ideal for hotels, offices, cafes, and other places where Internet access is required via Web authorization (via HotSpot gateway). The Hotspot module supports various types of authorization - authorization via SMS, creating tickets with different rights and times.
In order for the module to work, it is necessary to make sure that it is [[Install_and_Basic_Configuration#Install_and_Start_services|installed and running in Settings]]:</p>
<p>The interface of the hotspot module provides different tabs for regular tasks with wifi users and configuration hotspot on RouterOS devices. There are Users, Operators, Points, Gateways, Events, and Reports tabs.</p>
<h2>'''Basic HotSpot gateway configuration on Mikrotik RouterOS'''</h2>
<p>This paragraph does not apply to the description of the Hotspot module but contains information on configuring MikroTik ROS as a HotSpot gateway.</p>
<p><ul>
<li>Make sure that your router, which will act as a HotSpot gateway, is configured and has Internet access.<br></li>
<li>In our example, the router is configured and has Internet access. We will configure HotSpot on the "bridgeGuest" Interface.<br>[[File:wifi-inteface-create.png|Add new interface for WIFI]]</li>
<li>The HotSpot package must be installed on your router - this can be seen in the System -> packages tab.<br>[[File:wifi-system-packages.png|Install system packages]]</li>
<li>If the package is missing, download it (hotspot.npk), but always the same version as the system package. You need to install the package to the root (files), after which you need to reboot the router. Check that the package is installed.<br></li>
</ul></p>
<p>To configure HotSpot go to the system - hotspot section</p>
<p><ul>
<li>For quick setup, use the setup button, after a "wizard" will be launched to configure the hotspot. You need to define the interface behind which your hotspot users will be located.<br>[[File:wifi-hotspot-setup.png|Hotpot setup]]</li>
<li>For a more accurate configuration, an IP address must be registered on the HotSpot interface. It is this IP that will be automatically substituted when configuring HotSpot, if there is no IP address on the interface, the "wizard" will come up with it and substitute it.<br></li>
<li>You will be automatically prompted to create a Pool IP addresses for distribution to clients.<br></li>
<li>If you do not fill in the DNS Name field, then when users connect to the authorization page, the IP address of the interface will appear. If you specify a name, then it will be displayed.<br></li>
<li>You are prompted to create your first HotSpot user.<br></li>
<li>Congratulations! You have HotSpot configured.<br></li>
</ul></p>
<h2>'''Users'''</h2>
<p>When you click on the Users tab, you will see the following window:</p>
[[File:Wifi-users.PNG|Traffic Jobs]]
<p>There are 5 buttons on the Users tab:</p>
<p><ul>
<li>[[File:add.png|Add user]] - Add user on hotspot RouterOS and mupsbox database<br></li>
<li>[[File:remove.png|Delete user from hotspot]] - Delete user account on hotspot RouterOS and the Mupsbox database marks user account as deleted<br></li>
<li>[[File:Enable.png|Enable user]] - Enable user on hotspot RouterOS <br></li>
<li>[[File:Disable.png|Disable user]] - Disable user on hotspot RouterOS <br></li>
<li>[[File:Refresh.png|Refresh]] - Refresh window <br></li>
</ul></p>
<p>There are filtering checkboxes on the Users tab:</p>
<p><ul>
<li>[[File:Wifi-f-sms-users.png| Filtering only wifi SMS users]] - Show wifi user what authorizing via SMS code<br></li>
<li>[[File:Wifi-f-ticket-users.png|Filtering only wifi ticket users]] - Show wifi user what authorizing via ticket<br></li>
<li>[[File:Wifi-f-disabled-users.png|Filtering only disabled wifi users]] - Filtering only disabled wifi users<br></li>
<li>[[File: Wifi-f-removed-users.png|Filtering only removed wifi users]] - Filtering only removed wifi users<br></li>
</ul></p>
<h3>'''Add new wifi user'''</h3>
<p>Wifi operator can manualy add new user on hotspot RouterOS, account information in Mupsbox database, and genarate password by appropriate policy. In order for the program to add new user from your hotspot RouterOS, you must click on the [[File:add.png|Add user]], then the Add new wifi user window will open:</p>
[[File:Wifi-add-wifi-user.png|Add new wifi user]]
<p><ul>
<li>Login - The wifi user will use login for authorization on Hotspot RouterOS<br></li>
<li>Surname - The surname of wifi user. Available for ticket authorization only<br></li>
<li>Name - The name of wifi user. Available for ticket authorization only<br></li>
<li>Patronym - The patronym of wifi user. Available for ticket authorization only<br></li>
<li>Pasport № - The pasport number of wifi user. Available for ticket authorization only<br></li>
</ul></p>
<p>The operator can modify WIFI connection and WIFI passwords policies on user creation step.</p>
<p>The WIFI connection policy:</p>
<p><ul>
<li>Connection days - Number of connection days that wifi user will remain authorized to Hotspot RouterOS<br></li>
<li>Speed - The two-direction bandwidth for wifi users. There are predefined speed: 1M, 5M, 10M, unlim. It's possible use custom speed<br></li>
<li>Traffic - The traffic restriction for wifi users. There are predefined traffic restrictions: unlim, 1Gb, 2Gb, 5Gb, 10Gb. It's possible to use custom traffic restriction<br></li>
<li>Shared users - The number of users or wireless client devices what can work with one wifi user account<br></li>
</ul></p>

<p>The WIFI password policy:</p>
<p><ul>
<li>Password length- Length of a password. By default 4 chars<br></li>
<li>digits (0..9) - Requirement use digits in password<br></li>
<li>low case letters (a..z) - Requirement use low case letters in a password<br></li>
<li>high case letters (A..Z) - Requirement use high case letters in a password<br></li>
<li>simbols (!@#$%^*) - Requirement use symbols "!@#$%^*" in password<br></li>
</ul></p>
<p>When you click on Add User button, you will see the following window:</p>
[[File:Wifi-print-wifi-ticket.png|Print wifi ticket]]
<p>There is ticket can be printed. Print template can by modified by change wifi_ticket.rtf file what located in distributive folder.</p>

<h2>'''Operators'''</h2>
<p>This tab is used to associate Mupsbox users with Point. Point provides information about hotspot RouterOS devices and Gateways information.</p>
[[File:Wifi-operators.png|Wifi operators]]
<h3>'''Modify point for operator'''</h3>
<p>Use double-click on the operator and choose an appropriate point.</p>
[[File:Wifi-set-point.png|Wifi set point]]

<h2>'''Points'''</h2>
<p>This tab is used for configuration points. Point is the association RouterOS device, which works as hotspot and config of authorization wifi users (Gateway information).</p>
[[File:Wifi-points.png|Wifi points]]
<p>There are 5 buttons on the Points tab:</p>
<p><ul>
<li>[[File:add.png|Add hotspot point]] - Add hotspot point<br></li>
<li>[[File:remove.png|Delete hotspot point]] - Delete hotspot point<br></li>
<li>[[File:Enable.png|Enable hotspot point]] - Enable hotspot point<br></li>
<li>[[File:Disable.png|Disable hotspot point]] - Disable hotspot point<br></li>
<li>[[File:Refresh.png|Refresh]] - Refresh window <br></li>
</ul></p>
<p>When you click on Add hotspot point button, you will see the following window:</p>
[[File:Wifi-add-point.png|Wifi add hotspot point]]
<p><ul>
<li>Name - Name of the point<br></li>
<li>Device - RouterOS device what in the list of Device module. RouterOS should be configurated as a hotspot<br></li>
<li>Gateway - Set of authorization information. The gateway should be configurated before point creation<br></li>
</ul></p>

<h2>'''Gateways'''</h2>
<p>This tab is used for configuration gateways. Gateway is a set of information on how wifi users will authentification on hotspot RouterOS.</p>
[[File:Wifi-gateways.png|Wifi gateways]]
<p>There are 2 buttons on the Gateway tab:</p>
<p><ul>
<li>[[File:add.png|Add hotspot point]] - Add gateway<br></li>
<li>[[File:remove.png|Delete hotspot point]] - Delete gateway<br></li>
</ul></p>

<p>When you click on Add Gateway button, you will see the following window:</p>
[[File:Wifi-add-gateway.png|Add wifi gateways]]
<p><ul>
<li>Gateway name - unique Gateway name<br></li>
<li>Message- The Message that wifi user will receive on a mobile device with SMS code. There is a requirement to use #wifipassword# inside text. It's variable will change on generate a password with an appropriate wifi password policy <br></li>
<li>Mode - The Mode provides SMS authentification via the external provider or internal modem connected to RouterOS device<br></li>
<li>External string - The string (web-link)of autentification your on external sms provider. There is a requirement to use #phonenumber# and #smsmessage# inside text. The variable #phonenumber# is number that sms will sent. The variable #smsmessage# is text of Message field, text that will recieved by wifi users<br></li>
<li>RouterOS device - The RouterOS device that listed in Device module. The device will work as sms modem. There SMS model should be integrated or attached to RouterOS device<br></li>
<li>Modem type - If set to class-0, then send class 0 SMS message. It is displayed immedeately and not stored in phone<br></li>
<li>Modem port - The name of port from /port list that GSM modem is attached to<br></li>
<li>Modem channel - Which modem channel to use for sending.<br></li>
</ul></p>
<p>The WIFI connection policy is the same as in creation user process:</p>
<p><ul>
<li>Connection days - Number of connection days that wifi user will remain authorized to Hotspot RouterOS<br></li>
<li>Speed - The two-direction bandwidth for wifi users. There are predefined speed: 1M, 5M, 10M, unlim. It's possible use custom speed<br></li>
<li>Traffic - The traffic restriction for wifi users. There are predefined traffic restrictions: unlim, 1Gb, 2Gb, 5Gb, 10Gb. It's possible to use custom traffic restriction<br></li>
<li>Shared users - The number of users or wireless client devices what can work with one wifi user account<br></li>
</ul></p>
<p>The Gateway provides preflight check options like status, balance, and trying to send test SMS.</p>
<p>The Status string provides check variable options from the SMS provider if it's available.</p>
<p>The Balance string provides check balance options from the SMS provider if it's available.</p>
<p>The Phone number string provides check trying to send test SMS.</p>

<h2>'''Events'''</h2>
<p>The Events tab provides historical information about wifi user, their mobile devices, etc.</p>
[[File:Wifi-events.png|Wifi events]]
<p><ul>
<li>ID - The event ID created by mupsbox<br></li>
<li>Application time - The time that on mupsbox machine<br></li>
<li>Router time - The time that on hotspot RouterOS<br></li>
<li>Action - The description of event<br></li>
<li>User Login - The name of User Login for the current event. The information will write if available for that event<br></li>
<li>User Name - The name of User for the current event. The information will write if available for that event<br></li>
<li>User Surname - The surname of User for the current event. The information will write if available for that event<br></li>
<li>User Mac Address / IP - The Mac Address or IP of a wifi client device. The information will write if available for that event<br></li>
<li>Point - The Point which event is present<br></li>
<li>Gateway - The Gateway which event is present<br></li>
</ul></p>

<h2>'''Reports'''</h2>
<p>The Reports tab provides agrigate or combination information about wifi user, their mobile devices, etc. The information can be exported in Excel format.</p>
[[File:Wifi-reports.png|Wifi reports]]

<p>The first matrix provides information about wifi users with filtering options.</p>
<p>The second matrix provides information about the activity of wifi users with filtering time options.</p>

<div id="BackToTop" class="noprint" style="background-color:#DDEFDD; position:fixed;
bottom:32px; left:2%; z-index:9999; padding:0; margin:0;"><span style="color:blue;
font-size:8pt; font-face:verdana,sans-serif; border:0.2em outset #ceebf7;
padding:0.1em; font-weight:bolder; -moz-border-radius:8px; ">
[[#top| Back to the Top ]]</span></div>

HotSpot

2020-09-09T13:47:32Z

Sergey:

<h1>'''Hotspot module'''</h1>
<h2>'''How to'''</h2>
<p>The module is a powerful system MikroTik HotSpot -> user authorization. Ideal for hotels, offices, cafes, and other places where Internet access is required via Web authorization (via HotSpot gateway). The Hotspot module supports various types of authorization - authorization via SMS, creating tickets with different rights and times.
In order for the module to work, it is necessary to make sure that it is [[Install_and_Basic_Configuration#Install_and_Start_services|installed and running in Settings]]:</p>
<p>The interface of the hotspot module provides different tabs for regular tasks with wifi users and configuration hotspot on RouterOS devices. There are Users, Operators, Points, Gateways, Events, and Reports tabs.</p>
<h2>'''Basic HotSpot gateway configuration on Mikrotik RouterOS'''</h2>
<p>This paragraph does not apply to the description of the Hotspot module but contains information on configuring MikroTik ROS as a HotSpot gateway.</p>
<p><ul>
<li>Make sure that your router, which will act as a HotSpot gateway, is configured and has Internet access.<br></li>
<li>In our example, the router is configured and has Internet access. We will configure HotSpot on the "bridgeGuest" Interface.<br> [[File:wifi-inteface-create.png|Add new interface for WIFI]] </li>
<li>The HotSpot package must be installed on your router - this can be seen in the System -> packages tab.<br></li>
<li>If the package is missing, download it (hotspot.npk), but always the same version as the system package. You need to install the package to the root (files), after which you need to reboot the router. Check that the package is installed.<br></li>
</ul></p>
<p>To configure HotSpot go to the system - hotspot section</p>
<p><ul>
<li>For quick setup, use the setup button, after a "wizard" will be launched to configure the hotspot. You need to define the interface behind which your hotspot users will be located.<br></li>
<li>For a more accurate configuration, an IP address must be registered on the HotSpot interface. It is this IP that will be automatically substituted when configuring HotSpot, if there is no IP address on the interface, the "wizard" will come up with it and substitute it.<br></li>
<li>You will be automatically prompted to create a Pool IP addresses for distribution to clients.<br></li>
<li>If you do not fill in the DNS Name field, then when users connect to the authorization page, the IP address of the interface will appear. If you specify a name, then it will be displayed.<br></li>
<li>You are prompted to create your first HotSpot user.<br></li>
<li>Congratulations! You have HotSpot configured.<br></li>
</ul></p>
<h2>'''Users'''</h2>
<p>When you click on the Users tab, you will see the following window:</p>
[[File:Wifi-users.PNG|Traffic Jobs]]
<p>There are 5 buttons on the Users tab:</p>
<p><ul>
<li>[[File:add.png|Add user]] - Add user on hotspot RouterOS and mupsbox database<br></li>
<li>[[File:remove.png|Delete user from hotspot]] - Delete user account on hotspot RouterOS and the Mupsbox database marks user account as deleted<br></li>
<li>[[File:Enable.png|Enable user]] - Enable user on hotspot RouterOS <br></li>
<li>[[File:Disable.png|Disable user]] - Disable user on hotspot RouterOS <br></li>
<li>[[File:Refresh.png|Refresh]] - Refresh window <br></li>
</ul></p>
<p>There are filtering checkboxes on the Users tab:</p>
<p><ul>
<li>[[File:Wifi-f-sms-users.png| Filtering only wifi SMS users]] - Show wifi user what authorizing via SMS code<br></li>
<li>[[File:Wifi-f-ticket-users.png|Filtering only wifi ticket users]] - Show wifi user what authorizing via ticket<br></li>
<li>[[File:Wifi-f-disabled-users.png|Filtering only disabled wifi users]] - Filtering only disabled wifi users<br></li>
<li>[[File: Wifi-f-removed-users.png|Filtering only removed wifi users]] - Filtering only removed wifi users<br></li>
</ul></p>
<h3>'''Add new wifi user'''</h3>
<p>Wifi operator can manualy add new user on hotspot RouterOS, account information in Mupsbox database, and genarate password by appropriate policy. In order for the program to add new user from your hotspot RouterOS, you must click on the [[File:add.png|Add user]], then the Add new wifi user window will open:</p>
[[File:Wifi-add-wifi-user.png|Add new wifi user]]
<p><ul>
<li>Login - The wifi user will use login for authorization on Hotspot RouterOS<br></li>
<li>Surname - The surname of wifi user. Available for ticket authorization only<br></li>
<li>Name - The name of wifi user. Available for ticket authorization only<br></li>
<li>Patronym - The patronym of wifi user. Available for ticket authorization only<br></li>
<li>Pasport № - The pasport number of wifi user. Available for ticket authorization only<br></li>
</ul></p>
<p>The operator can modify WIFI connection and WIFI passwords policies on user creation step.</p>
<p>The WIFI connection policy:</p>
<p><ul>
<li>Connection days - Number of connection days that wifi user will remain authorized to Hotspot RouterOS<br></li>
<li>Speed - The two-direction bandwidth for wifi users. There are predefined speed: 1M, 5M, 10M, unlim. It's possible use custom speed<br></li>
<li>Traffic - The traffic restriction for wifi users. There are predefined traffic restrictions: unlim, 1Gb, 2Gb, 5Gb, 10Gb. It's possible to use custom traffic restriction<br></li>
<li>Shared users - The number of users or wireless client devices what can work with one wifi user account<br></li>
</ul></p>

<p>The WIFI password policy:</p>
<p><ul>
<li>Password length- Length of a password. By default 4 chars<br></li>
<li>digits (0..9) - Requirement use digits in password<br></li>
<li>low case letters (a..z) - Requirement use low case letters in a password<br></li>
<li>high case letters (A..Z) - Requirement use high case letters in a password<br></li>
<li>simbols (!@#$%^*) - Requirement use symbols "!@#$%^*" in password<br></li>
</ul></p>
<p>When you click on Add User button, you will see the following window:</p>
[[File:Wifi-print-wifi-ticket.png|Print wifi ticket]]
<p>There is ticket can be printed. Print template can by modified by change wifi_ticket.rtf file what located in distributive folder.</p>

<h2>'''Operators'''</h2>
<p>This tab is used to associate Mupsbox users with Point. Point provides information about hotspot RouterOS devices and Gateways information.</p>
[[File:Wifi-operators.png|Wifi operators]]
<h3>'''Modify point for operator'''</h3>
<p>Use double-click on the operator and choose an appropriate point.</p>
[[File:Wifi-set-point.png|Wifi set point]]

<h2>'''Points'''</h2>
<p>This tab is used for configuration points. Point is the association RouterOS device, which works as hotspot and config of authorization wifi users (Gateway information).</p>
[[File:Wifi-points.png|Wifi points]]
<p>There are 5 buttons on the Points tab:</p>
<p><ul>
<li>[[File:add.png|Add hotspot point]] - Add hotspot point<br></li>
<li>[[File:remove.png|Delete hotspot point]] - Delete hotspot point<br></li>
<li>[[File:Enable.png|Enable hotspot point]] - Enable hotspot point<br></li>
<li>[[File:Disable.png|Disable hotspot point]] - Disable hotspot point<br></li>
<li>[[File:Refresh.png|Refresh]] - Refresh window <br></li>
</ul></p>
<p>When you click on Add hotspot point button, you will see the following window:</p>
[[File:Wifi-add-point.png|Wifi add hotspot point]]
<p><ul>
<li>Name - Name of the point<br></li>
<li>Device - RouterOS device what in the list of Device module. RouterOS should be configurated as a hotspot<br></li>
<li>Gateway - Set of authorization information. The gateway should be configurated before point creation<br></li>
</ul></p>

<h2>'''Gateways'''</h2>
<p>This tab is used for configuration gateways. Gateway is a set of information on how wifi users will authentification on hotspot RouterOS.</p>
[[File:Wifi-gateways.png|Wifi gateways]]
<p>There are 2 buttons on the Gateway tab:</p>
<p><ul>
<li>[[File:add.png|Add hotspot point]] - Add gateway<br></li>
<li>[[File:remove.png|Delete hotspot point]] - Delete gateway<br></li>
</ul></p>

<p>When you click on Add Gateway button, you will see the following window:</p>
[[File:Wifi-add-gateway.png|Add wifi gateways]]
<p><ul>
<li>Gateway name - unique Gateway name<br></li>
<li>Message- The Message that wifi user will receive on a mobile device with SMS code. There is a requirement to use #wifipassword# inside text. It's variable will change on generate a password with an appropriate wifi password policy <br></li>
<li>Mode - The Mode provides SMS authentification via the external provider or internal modem connected to RouterOS device<br></li>
<li>External string - The string (web-link)of autentification your on external sms provider. There is a requirement to use #phonenumber# and #smsmessage# inside text. The variable #phonenumber# is number that sms will sent. The variable #smsmessage# is text of Message field, text that will recieved by wifi users<br></li>
<li>RouterOS device - The RouterOS device that listed in Device module. The device will work as sms modem. There SMS model should be integrated or attached to RouterOS device<br></li>
<li>Modem type - If set to class-0, then send class 0 SMS message. It is displayed immedeately and not stored in phone<br></li>
<li>Modem port - The name of port from /port list that GSM modem is attached to<br></li>
<li>Modem channel - Which modem channel to use for sending.<br></li>
</ul></p>
<p>The WIFI connection policy is the same as in creation user process:</p>
<p><ul>
<li>Connection days - Number of connection days that wifi user will remain authorized to Hotspot RouterOS<br></li>
<li>Speed - The two-direction bandwidth for wifi users. There are predefined speed: 1M, 5M, 10M, unlim. It's possible use custom speed<br></li>
<li>Traffic - The traffic restriction for wifi users. There are predefined traffic restrictions: unlim, 1Gb, 2Gb, 5Gb, 10Gb. It's possible to use custom traffic restriction<br></li>
<li>Shared users - The number of users or wireless client devices what can work with one wifi user account<br></li>
</ul></p>
<p>The Gateway provides preflight check options like status, balance, and trying to send test SMS.</p>
<p>The Status string provides check variable options from the SMS provider if it's available.</p>
<p>The Balance string provides check balance options from the SMS provider if it's available.</p>
<p>The Phone number string provides check trying to send test SMS.</p>

<h2>'''Events'''</h2>
<p>The Events tab provides historical information about wifi user, their mobile devices, etc.</p>
[[File:Wifi-events.png|Wifi events]]
<p><ul>
<li>ID - The event ID created by mupsbox<br></li>
<li>Application time - The time that on mupsbox machine<br></li>
<li>Router time - The time that on hotspot RouterOS<br></li>
<li>Action - The description of event<br></li>
<li>User Login - The name of User Login for the current event. The information will write if available for that event<br></li>
<li>User Name - The name of User for the current event. The information will write if available for that event<br></li>
<li>User Surname - The surname of User for the current event. The information will write if available for that event<br></li>
<li>User Mac Address / IP - The Mac Address or IP of a wifi client device. The information will write if available for that event<br></li>
<li>Point - The Point which event is present<br></li>
<li>Gateway - The Gateway which event is present<br></li>
</ul></p>

<h2>'''Reports'''</h2>
<p>The Reports tab provides agrigate or combination information about wifi user, their mobile devices, etc. The information can be exported in Excel format.</p>
[[File:Wifi-reports.png|Wifi reports]]

<p>The first matrix provides information about wifi users with filtering options.</p>
<p>The second matrix provides information about the activity of wifi users with filtering time options.</p>

<div id="BackToTop" class="noprint" style="background-color:#DDEFDD; position:fixed;
bottom:32px; left:2%; z-index:9999; padding:0; margin:0;"><span style="color:blue;
font-size:8pt; font-face:verdana,sans-serif; border:0.2em outset #ceebf7;
padding:0.1em; font-weight:bolder; -moz-border-radius:8px; ">
[[#top| Back to the Top ]]</span></div>

File:Wifi-system-packages.png

2020-09-09T13:44:47Z

Sergey:

File:Wifi-inteface-create.png

2020-09-09T13:44:36Z

Sergey:

File:Wifi-hotspot-setup-4.png

2020-09-09T13:44:25Z

Sergey:

File:Wifi-hotspot-setup-3.png

2020-09-09T13:44:16Z

Sergey: