zii/MRCI
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
fabc82a0a2
MRCI/README.md

127 lines
6.7 KiB
Markdown
Raw Normal View History

Initial commit for the MRCI project.
2019-09-06 23:43:07 -04:00
# MRCI #
moved the README file back to the root directory and fixed a few grammar mistakes.
2022-07-10 22:01:14 -04:00
(Modular Remote Command Interpreter) is a command interpreter primarily designed to provide any type of remote service to connected clients. As the name implies, it is expandable via 3rd party modules by adding additional commands that remote clients can run on the host. It has a fully featured user account management system with access control to certain commands for certain users.
Initial commit for the MRCI project.
2019-09-06 23:43:07 -04:00
### Usage ###
```
Major change to the build system and minor changes to SSL handling - mutiple SSL cert files can now be added to the MRCI_PUB_KEY env variable via colon seperated ':' path strings to complete the cert chain if such a thing is required. It is no longer necessary to merge to multiple certs into one to complete a cert chain. - added -load_ssl command line option so cert data can be re-loaded in real time without the need to stop-start the host. - added more detailed error messages to the SSL loading process for easier debugging. - major changes to the build system include the use of python scripts instead of the linux shell script file. - linux_build.sh was removed since it is no longer needed. - the new build process now run 2 python scripts: build.py and then install.py. - the resulting installer if built no longer uses makeself. the installation and/or self extracting process is now handled entirely by python and the install.py script. The main reason for this change is to lay the ground work for multi- platform support. It is still linux only for now but adding windows support will be much easier in the future thanks to python's cross- platform support.
2020-04-21 12:04:36 -04:00
Usage: mrci <argument>
Initial commit for the MRCI project.
2019-09-06 23:43:07 -04:00
<Arguments>
Full documentation update and minor changes -the add_mod command now requires the -mod_path argument as it should. -the session now filter out bad NEW_CMD frames based on bad command names and incorrect frame sizes. -modules running in list mode can now send ERR frames to the session to log error messages to the host database.
2019-11-16 13:08:02 -05:00
Few Updates to SSL Cert Handling - SSL certs are no longer stored in the host database. This was done not only for security reasons but there is simply no need to do such thing anymore. - The host will longer support multiple SSL certs and will instead have just a single cert for all TCP connections. This required a change to the client header format that simply replaced the the common name with padding. The host will also no longer send the HOST_CERT type id during session initialization. HOST_CERT was also removed as a type id. - The cert and privite key are now pointed to files in the local file system by the environment variables: MRCI_PRIV_KEY and MRCI_PUB_KEY. - The host will still create a default self-signed cert if a valid cert and private key is not defined in the above environmental vars. Since the host only support single certs now, the default cert needed to be expanded to include subject alternative names. The host will try to detect it's WAN ip address using ipify.org and then assign SANs for all detected local LAN interfaces. - Since the cert is now handled by environmental vars and nothing related to it stored in the database, all the core commands related to cert management were removed.
2020-04-05 15:51:11 -04:00
-help : display usage information about this application.
-stop : stop the current host instance if one is currently running.
-about : display versioning/warranty information about this application.
-status : display status information about the host instance if it is currently running.
-host : start a new host instance. (this blocks)
Added Windows Build/Install Support - added a -host_trig command line option that creates a new host instance without blocking user input. - the build/install python scripts will no longer internally build platform specific shell scripts; instead, they will now copy the necessary templates from the /templates folder. - modified both build.py and install.py to include windows deployment support so this app can now be built/installed on windows based host. note: i decided to have it "daemonized" as a scheduled task that runs on system start instead of service because it is simply easier to do it this way and will not involve any 3rd party libraries or apps. - added the src/applink.c file to the source code since it is needed for windows openssl support. - changed over all references of "endl" to "Qt::endl" to avoid depreciation errors/warnings.
2020-07-04 11:37:46 -04:00
-host_trig : start a new host instance. (this does not block)
Few Updates to SSL Cert Handling - SSL certs are no longer stored in the host database. This was done not only for security reasons but there is simply no need to do such thing anymore. - The host will longer support multiple SSL certs and will instead have just a single cert for all TCP connections. This required a change to the client header format that simply replaced the the common name with padding. The host will also no longer send the HOST_CERT type id during session initialization. HOST_CERT was also removed as a type id. - The cert and privite key are now pointed to files in the local file system by the environment variables: MRCI_PRIV_KEY and MRCI_PUB_KEY. - The host will still create a default self-signed cert if a valid cert and private key is not defined in the above environmental vars. Since the host only support single certs now, the default cert needed to be expanded to include subject alternative names. The host will try to detect it's WAN ip address using ipify.org and then assign SANs for all detected local LAN interfaces. - Since the cert is now handled by environmental vars and nothing related to it stored in the database, all the core commands related to cert management were removed.
2020-04-05 15:51:11 -04:00
-public_cmds : run the internal module to list it's public commands. for internal use only.
-exempt_cmds : run the internal module to list it's rank exempt commands. for internal use only.
-user_cmds : run the internal module to list it's user commands. for internal use only.
-run_cmd : run an internal module command. for internal use only.
added the -ls_sql_drvs command line arg to README.md
2020-08-09 12:27:00 -04:00
-ls_sql_drvs : list all available SQL drivers that the host currently supports.
Major change to the build system and minor changes to SSL handling - mutiple SSL cert files can now be added to the MRCI_PUB_KEY env variable via colon seperated ':' path strings to complete the cert chain if such a thing is required. It is no longer necessary to merge to multiple certs into one to complete a cert chain. - added -load_ssl command line option so cert data can be re-loaded in real time without the need to stop-start the host. - added more detailed error messages to the SSL loading process for easier debugging. - major changes to the build system include the use of python scripts instead of the linux shell script file. - linux_build.sh was removed since it is no longer needed. - the new build process now run 2 python scripts: build.py and then install.py. - the resulting installer if built no longer uses makeself. the installation and/or self extracting process is now handled entirely by python and the install.py script. The main reason for this change is to lay the ground work for multi- platform support. It is still linux only for now but adding windows support will be much easier in the future thanks to python's cross- platform support.
2020-04-21 12:04:36 -04:00
-load_ssl : re-load the host SSL certificate without stopping the host instance.
Slimmed down and simplified host administering - I decided to remove the entire concept of a root user. Instead, the host initializes as a blank slate and it will be up to the host admin to create a rank 1 user via the new command line option "-add_admin" to do initial setup with. - There is no longer such a concept as a protected user. Meaning even the last rank 1 user in the host database is allowed to delete or modify the rank of their own account. To prevent permanent "admin lock out" in this scenario the "-elevate" command line option was created. - Host settings are no longer stored in the database. Instead, host settings are now stored in a conf.json file in /etc/mrci/conf.json if running on a linux based OS or in %Programdata%\mrci\conf.json if running on Windows. - Email templates are no longer stored in the database. Instead, the templates can be any file formatted in UTF-8 text stored in the host file system. The files they point to can be modified in the conf.json file. - The conf file also replaced all use env variables so MRCI_DB_PATH, MRCI_WORK_DIR, MRCI_PRIV_KEY and MRCI_PUB_KEY are no longer in use. SSL/TLS cert paths can be modified in the conf file. - Removed email template cmds set_email_template and preview_email. - Also removed cmds close_host, host_config and restart_host. The actions these commands could do is best left to the host system command line. - The database class will now explicitly check for write permissions to the database and throw an appropriate error message if the check fails. "DROP TABLE" SQL abilities were added to make this happen. - Removed async cmds exit(3), maxses(5) and restart(11).
2020-11-10 14:47:00 -05:00
-elevate : elevate any user account to rank 1.
Update README.md added res_pw to README file
2021-02-27 11:25:54 -05:00
-res_pw : reset a user account password with a randomized one time password.
Slimmed down and simplified host administering - I decided to remove the entire concept of a root user. Instead, the host initializes as a blank slate and it will be up to the host admin to create a rank 1 user via the new command line option "-add_admin" to do initial setup with. - There is no longer such a concept as a protected user. Meaning even the last rank 1 user in the host database is allowed to delete or modify the rank of their own account. To prevent permanent "admin lock out" in this scenario the "-elevate" command line option was created. - Host settings are no longer stored in the database. Instead, host settings are now stored in a conf.json file in /etc/mrci/conf.json if running on a linux based OS or in %Programdata%\mrci\conf.json if running on Windows. - Email templates are no longer stored in the database. Instead, the templates can be any file formatted in UTF-8 text stored in the host file system. The files they point to can be modified in the conf.json file. - The conf file also replaced all use env variables so MRCI_DB_PATH, MRCI_WORK_DIR, MRCI_PRIV_KEY and MRCI_PUB_KEY are no longer in use. SSL/TLS cert paths can be modified in the conf file. - Removed email template cmds set_email_template and preview_email. - Also removed cmds close_host, host_config and restart_host. The actions these commands could do is best left to the host system command line. - The database class will now explicitly check for write permissions to the database and throw an appropriate error message if the check fails. "DROP TABLE" SQL abilities were added to make this happen. - Removed async cmds exit(3), maxses(5) and restart(11).
2020-11-10 14:47:00 -05:00
-add_admin : create a rank 1 account with a randomized password.
Full documentation update and minor changes -the add_mod command now requires the -mod_path argument as it should. -the session now filter out bad NEW_CMD frames based on bad command names and incorrect frame sizes. -modules running in list mode can now send ERR frames to the session to log error messages to the host database.
2019-11-16 13:08:02 -05:00
Internal module | -public_cmds, -user_cmds, -exempt_cmds, -run_cmd |:
Few Updates to SSL Cert Handling - SSL certs are no longer stored in the host database. This was done not only for security reasons but there is simply no need to do such thing anymore. - The host will longer support multiple SSL certs and will instead have just a single cert for all TCP connections. This required a change to the client header format that simply replaced the the common name with padding. The host will also no longer send the HOST_CERT type id during session initialization. HOST_CERT was also removed as a type id. - The cert and privite key are now pointed to files in the local file system by the environment variables: MRCI_PRIV_KEY and MRCI_PUB_KEY. - The host will still create a default self-signed cert if a valid cert and private key is not defined in the above environmental vars. Since the host only support single certs now, the default cert needed to be expanded to include subject alternative names. The host will try to detect it's WAN ip address using ipify.org and then assign SANs for all detected local LAN interfaces. - Since the cert is now handled by environmental vars and nothing related to it stored in the database, all the core commands related to cert management were removed.
2020-04-05 15:51:11 -04:00
-pipe : the named pipe used to establish a data connection with the session.
-mem_ses : the shared memory key for the session.
-mem_host : the shared memory key for the host main process.
Details:
Update README.md added res_pw to README file
2021-02-27 11:25:54 -05:00
res_pw - this argument takes a single string representing a user name to reset the password. the host
will set a randomized password and display it on the CLI.
example: -res_pw somebody
Slimmed down and simplified host administering - I decided to remove the entire concept of a root user. Instead, the host initializes as a blank slate and it will be up to the host admin to create a rank 1 user via the new command line option "-add_admin" to do initial setup with. - There is no longer such a concept as a protected user. Meaning even the last rank 1 user in the host database is allowed to delete or modify the rank of their own account. To prevent permanent "admin lock out" in this scenario the "-elevate" command line option was created. - Host settings are no longer stored in the database. Instead, host settings are now stored in a conf.json file in /etc/mrci/conf.json if running on a linux based OS or in %Programdata%\mrci\conf.json if running on Windows. - Email templates are no longer stored in the database. Instead, the templates can be any file formatted in UTF-8 text stored in the host file system. The files they point to can be modified in the conf.json file. - The conf file also replaced all use env variables so MRCI_DB_PATH, MRCI_WORK_DIR, MRCI_PRIV_KEY and MRCI_PUB_KEY are no longer in use. SSL/TLS cert paths can be modified in the conf file. - Removed email template cmds set_email_template and preview_email. - Also removed cmds close_host, host_config and restart_host. The actions these commands could do is best left to the host system command line. - The database class will now explicitly check for write permissions to the database and throw an appropriate error message if the check fails. "DROP TABLE" SQL abilities were added to make this happen. - Removed async cmds exit(3), maxses(5) and restart(11).
2020-11-10 14:47:00 -05:00
add_admin - this argument takes a single string representing a user name to create a rank 1 account with.
the host will set a randomized password for it and display it on the CLI. this user will be
required to change the password upon logging in.
example: -add_admin somebody
elevate - this argument takes a single string representing a user name to an account to promote to rank 1.
example: -elevate somebody
Few Updates to SSL Cert Handling - SSL certs are no longer stored in the host database. This was done not only for security reasons but there is simply no need to do such thing anymore. - The host will longer support multiple SSL certs and will instead have just a single cert for all TCP connections. This required a change to the client header format that simply replaced the the common name with padding. The host will also no longer send the HOST_CERT type id during session initialization. HOST_CERT was also removed as a type id. - The cert and privite key are now pointed to files in the local file system by the environment variables: MRCI_PRIV_KEY and MRCI_PUB_KEY. - The host will still create a default self-signed cert if a valid cert and private key is not defined in the above environmental vars. Since the host only support single certs now, the default cert needed to be expanded to include subject alternative names. The host will try to detect it's WAN ip address using ipify.org and then assign SANs for all detected local LAN interfaces. - Since the cert is now handled by environmental vars and nothing related to it stored in the database, all the core commands related to cert management were removed.
2020-04-05 15:51:11 -04:00
run_cmd - this argument is used by the host itself, along side the internal module arguments below to run
moved the README file back to the root directory and fixed a few grammar mistakes.
2022-07-10 22:01:14 -04:00
the internal command names passed by it. this is not meant to be run directly by human input.
Few Updates to SSL Cert Handling - SSL certs are no longer stored in the host database. This was done not only for security reasons but there is simply no need to do such thing anymore. - The host will longer support multiple SSL certs and will instead have just a single cert for all TCP connections. This required a change to the client header format that simply replaced the the common name with padding. The host will also no longer send the HOST_CERT type id during session initialization. HOST_CERT was also removed as a type id. - The cert and privite key are now pointed to files in the local file system by the environment variables: MRCI_PRIV_KEY and MRCI_PUB_KEY. - The host will still create a default self-signed cert if a valid cert and private key is not defined in the above environmental vars. Since the host only support single certs now, the default cert needed to be expanded to include subject alternative names. The host will try to detect it's WAN ip address using ipify.org and then assign SANs for all detected local LAN interfaces. - Since the cert is now handled by environmental vars and nothing related to it stored in the database, all the core commands related to cert management were removed.
2020-04-05 15:51:11 -04:00
the executable will auto close if it fails to connect to the pipe and/or shared memory segments
Initial commit for the MRCI project.
2019-09-06 23:43:07 -04:00
```
moved the README file back to the root directory and fixed a few grammar mistakes.
2022-07-10 22:01:14 -04:00
Slimmed down and simplified host administering - I decided to remove the entire concept of a root user. Instead, the host initializes as a blank slate and it will be up to the host admin to create a rank 1 user via the new command line option "-add_admin" to do initial setup with. - There is no longer such a concept as a protected user. Meaning even the last rank 1 user in the host database is allowed to delete or modify the rank of their own account. To prevent permanent "admin lock out" in this scenario the "-elevate" command line option was created. - Host settings are no longer stored in the database. Instead, host settings are now stored in a conf.json file in /etc/mrci/conf.json if running on a linux based OS or in %Programdata%\mrci\conf.json if running on Windows. - Email templates are no longer stored in the database. Instead, the templates can be any file formatted in UTF-8 text stored in the host file system. The files they point to can be modified in the conf.json file. - The conf file also replaced all use env variables so MRCI_DB_PATH, MRCI_WORK_DIR, MRCI_PRIV_KEY and MRCI_PUB_KEY are no longer in use. SSL/TLS cert paths can be modified in the conf file. - Removed email template cmds set_email_template and preview_email. - Also removed cmds close_host, host_config and restart_host. The actions these commands could do is best left to the host system command line. - The database class will now explicitly check for write permissions to the database and throw an appropriate error message if the check fails. "DROP TABLE" SQL abilities were added to make this happen. - Removed async cmds exit(3), maxses(5) and restart(11).
2020-11-10 14:47:00 -05:00
The host can be managed via a connected client that supports text input/output so the host application is always listening for clients while running entirely in the background. By default the host listen for clients on address 0.0.0.0 and port 35516, effectively making it reachable on any network interface of the host platform via that specific port.
Initial commit for the MRCI project.
2019-09-06 23:43:07 -04:00
### More Than Just a Command Interpreter ###
moved the README file back to the root directory and fixed a few grammar mistakes.
2022-07-10 22:01:14 -04:00
Typical use for a MRCI host is to run commands on a remote host that clients ask it to run, very similar to what you see in remote terminal emulators. It however does have a few features typically not seen in terminals:
Initial commit for the MRCI project.
2019-09-06 23:43:07 -04:00
* Broadcast any type of data to all peers connected to the host.
* Run remote commands on connected peers.
* Host object positioning data for peers (online games do this).
* Send data to/from a peer client directly.
moved the README file back to the root directory and fixed a few grammar mistakes.
2022-07-10 22:01:14 -04:00
* Fully featured user account management system.
Initial commit for the MRCI project.
2019-09-06 23:43:07 -04:00
* Built in permissions and command access management.
* Host limits management (max concurrent users, max failed password attempts, etc...).
* Account recovery emailing in case of forgotten passwords. **
moved the README file back to the root directory and fixed a few grammar mistakes.
2022-07-10 22:01:14 -04:00
* Access to various logs.
Initial commit for the MRCI project.
2019-09-06 23:43:07 -04:00
* Built in host file management (copy, move, delete, etc...).
* Built in file upload/download support.
Because the host is modular, the things you can customize it to do is almost limitless by simply adding more commands.
Moved logging out of the host database and a few bug fixes The host will no longer store logs in the database. Instead, logging is done by syslog if running linux. If running Windows, logs are now stored in a local file in the app config directory. Fixed a bug with -add_admin that would fail to create more than one admin accounts in sequence due to the blank email addresses being blank. It will now create fake email addresses unique to each admin account. Added -res_pw to reset user acccount passwords from the CLI if needed. Logging was also expanded to capture and log all failures reported by all modules stderr output. Updated build.py and install.py for QT6 support and moved the linux .service file from /etc to /lib to conform to systemd standards. Removed the ls_dbg command because in database logging is no longer done.
2021-02-27 11:19:44 -05:00
** The email system of this application depends on external email clients that run on the command line. The default is [mutt](http://www.mutt.org/). If you want emails to work out of the box, consider installing and configuring mutt. It just needs to be configured with a smtp account to send emails with. You don't have to use mutt though, the host does have the option to change the email client to any other application that has a command line interface.
Initial commit for the MRCI project.
2019-09-06 23:43:07 -04:00
### Documentation ###
moved the README file back to the root directory and fixed a few grammar mistakes.
2022-07-10 22:01:14 -04:00
* [1.1 The Protocol](docs/protocol.md)
* [2.1 Modules](docs/modules.md)
* [3.1 Type IDs](docs/type_ids.md)
* [4.1 Host Features](docs/host_features.md)
* [5.1 Async Commands](docs/async.md)
* [6.1 Shared Memory](docs/shared_data.md)
* [7.1 Internal Commands](docs/intern_commands.md)
Initial commit for the MRCI project.
2019-09-06 23:43:07 -04:00
Major change to the build system and minor changes to SSL handling - mutiple SSL cert files can now be added to the MRCI_PUB_KEY env variable via colon seperated ':' path strings to complete the cert chain if such a thing is required. It is no longer necessary to merge to multiple certs into one to complete a cert chain. - added -load_ssl command line option so cert data can be re-loaded in real time without the need to stop-start the host. - added more detailed error messages to the SSL loading process for easier debugging. - major changes to the build system include the use of python scripts instead of the linux shell script file. - linux_build.sh was removed since it is no longer needed. - the new build process now run 2 python scripts: build.py and then install.py. - the resulting installer if built no longer uses makeself. the installation and/or self extracting process is now handled entirely by python and the install.py script. The main reason for this change is to lay the ground work for multi- platform support. It is still linux only for now but adding windows support will be much easier in the future thanks to python's cross- platform support.
2020-04-21 12:04:36 -04:00
### Build Setup ###
Initial commit for the MRCI project.
2019-09-06 23:43:07 -04:00
Major change to the build system and minor changes to SSL handling - mutiple SSL cert files can now be added to the MRCI_PUB_KEY env variable via colon seperated ':' path strings to complete the cert chain if such a thing is required. It is no longer necessary to merge to multiple certs into one to complete a cert chain. - added -load_ssl command line option so cert data can be re-loaded in real time without the need to stop-start the host. - added more detailed error messages to the SSL loading process for easier debugging. - major changes to the build system include the use of python scripts instead of the linux shell script file. - linux_build.sh was removed since it is no longer needed. - the new build process now run 2 python scripts: build.py and then install.py. - the resulting installer if built no longer uses makeself. the installation and/or self extracting process is now handled entirely by python and the install.py script. The main reason for this change is to lay the ground work for multi- platform support. It is still linux only for now but adding windows support will be much easier in the future thanks to python's cross- platform support.
2020-04-21 12:04:36 -04:00
For Linux you need the following packages to successfully build/install:
Initial commit for the MRCI project.
2019-09-06 23:43:07 -04:00
```
qtbase5-dev
libssl-dev
gcc
make
Major change to the build system and minor changes to SSL handling - mutiple SSL cert files can now be added to the MRCI_PUB_KEY env variable via colon seperated ':' path strings to complete the cert chain if such a thing is required. It is no longer necessary to merge to multiple certs into one to complete a cert chain. - added -load_ssl command line option so cert data can be re-loaded in real time without the need to stop-start the host. - added more detailed error messages to the SSL loading process for easier debugging. - major changes to the build system include the use of python scripts instead of the linux shell script file. - linux_build.sh was removed since it is no longer needed. - the new build process now run 2 python scripts: build.py and then install.py. - the resulting installer if built no longer uses makeself. the installation and/or self extracting process is now handled entirely by python and the install.py script. The main reason for this change is to lay the ground work for multi- platform support. It is still linux only for now but adding windows support will be much easier in the future thanks to python's cross- platform support.
2020-04-21 12:04:36 -04:00
python3
Initial commit for the MRCI project.
2019-09-06 23:43:07 -04:00
```
Added Windows Build/Install Support - added a -host_trig command line option that creates a new host instance without blocking user input. - the build/install python scripts will no longer internally build platform specific shell scripts; instead, they will now copy the necessary templates from the /templates folder. - modified both build.py and install.py to include windows deployment support so this app can now be built/installed on windows based host. note: i decided to have it "daemonized" as a scheduled task that runs on system start instead of service because it is simply easier to do it this way and will not involve any 3rd party libraries or apps. - added the src/applink.c file to the source code since it is needed for windows openssl support. - changed over all references of "endl" to "Qt::endl" to avoid depreciation errors/warnings.
2020-07-04 11:37:46 -04:00
For Windows support you need to have the following applications installed:
Major change to the build system and minor changes to SSL handling - mutiple SSL cert files can now be added to the MRCI_PUB_KEY env variable via colon seperated ':' path strings to complete the cert chain if such a thing is required. It is no longer necessary to merge to multiple certs into one to complete a cert chain. - added -load_ssl command line option so cert data can be re-loaded in real time without the need to stop-start the host. - added more detailed error messages to the SSL loading process for easier debugging. - major changes to the build system include the use of python scripts instead of the linux shell script file. - linux_build.sh was removed since it is no longer needed. - the new build process now run 2 python scripts: build.py and then install.py. - the resulting installer if built no longer uses makeself. the installation and/or self extracting process is now handled entirely by python and the install.py script. The main reason for this change is to lay the ground work for multi- platform support. It is still linux only for now but adding windows support will be much easier in the future thanks to python's cross- platform support.
2020-04-21 12:04:36 -04:00
```
OpenSSL
Qt5.12 or newer
Python3
```
Initial commit for the MRCI project.
2019-09-06 23:43:07 -04:00
Major change to the build system and minor changes to SSL handling - mutiple SSL cert files can now be added to the MRCI_PUB_KEY env variable via colon seperated ':' path strings to complete the cert chain if such a thing is required. It is no longer necessary to merge to multiple certs into one to complete a cert chain. - added -load_ssl command line option so cert data can be re-loaded in real time without the need to stop-start the host. - added more detailed error messages to the SSL loading process for easier debugging. - major changes to the build system include the use of python scripts instead of the linux shell script file. - linux_build.sh was removed since it is no longer needed. - the new build process now run 2 python scripts: build.py and then install.py. - the resulting installer if built no longer uses makeself. the installation and/or self extracting process is now handled entirely by python and the install.py script. The main reason for this change is to lay the ground work for multi- platform support. It is still linux only for now but adding windows support will be much easier in the future thanks to python's cross- platform support.
2020-04-21 12:04:36 -04:00
### Build ###
Initial commit for the MRCI project.
2019-09-06 23:43:07 -04:00
Major change to the build system and minor changes to SSL handling - mutiple SSL cert files can now be added to the MRCI_PUB_KEY env variable via colon seperated ':' path strings to complete the cert chain if such a thing is required. It is no longer necessary to merge to multiple certs into one to complete a cert chain. - added -load_ssl command line option so cert data can be re-loaded in real time without the need to stop-start the host. - added more detailed error messages to the SSL loading process for easier debugging. - major changes to the build system include the use of python scripts instead of the linux shell script file. - linux_build.sh was removed since it is no longer needed. - the new build process now run 2 python scripts: build.py and then install.py. - the resulting installer if built no longer uses makeself. the installation and/or self extracting process is now handled entirely by python and the install.py script. The main reason for this change is to lay the ground work for multi- platform support. It is still linux only for now but adding windows support will be much easier in the future thanks to python's cross- platform support.
2020-04-21 12:04:36 -04:00
To build this project from source you just need to run the build.py and then the install.py python scripts. While running the build the script, it will try to find the Qt API installed in your machine according to the PATH env variable. If not found, it will ask you to input where it can find the Qt bin folder where the qmake executable exists or you can bypass all of this by passing the -qt_dir option on it's command line.
Initial commit for the MRCI project.
2019-09-06 23:43:07 -04:00
Major change to the build system and minor changes to SSL handling - mutiple SSL cert files can now be added to the MRCI_PUB_KEY env variable via colon seperated ':' path strings to complete the cert chain if such a thing is required. It is no longer necessary to merge to multiple certs into one to complete a cert chain. - added -load_ssl command line option so cert data can be re-loaded in real time without the need to stop-start the host. - added more detailed error messages to the SSL loading process for easier debugging. - major changes to the build system include the use of python scripts instead of the linux shell script file. - linux_build.sh was removed since it is no longer needed. - the new build process now run 2 python scripts: build.py and then install.py. - the resulting installer if built no longer uses makeself. the installation and/or self extracting process is now handled entirely by python and the install.py script. The main reason for this change is to lay the ground work for multi- platform support. It is still linux only for now but adding windows support will be much easier in the future thanks to python's cross- platform support.
2020-04-21 12:04:36 -04:00
while running the install script, it will ask you to input 1 of 3 options:
***local machine*** - This option will install the built application onto the local machine without creating an installer.
moved the README file back to the root directory and fixed a few grammar mistakes.
2022-07-10 22:01:14 -04:00
***create installer*** - This option creates an installer that can be distributed to other machines for installation. The resulting installer is just a regular .py script file that the target machine can run if it has Python3 installed. Only Python3 needs to be installed and an internet connection is not required.
Major change to the build system and minor changes to SSL handling - mutiple SSL cert files can now be added to the MRCI_PUB_KEY env variable via colon seperated ':' path strings to complete the cert chain if such a thing is required. It is no longer necessary to merge to multiple certs into one to complete a cert chain. - added -load_ssl command line option so cert data can be re-loaded in real time without the need to stop-start the host. - added more detailed error messages to the SSL loading process for easier debugging. - major changes to the build system include the use of python scripts instead of the linux shell script file. - linux_build.sh was removed since it is no longer needed. - the new build process now run 2 python scripts: build.py and then install.py. - the resulting installer if built no longer uses makeself. the installation and/or self extracting process is now handled entirely by python and the install.py script. The main reason for this change is to lay the ground work for multi- platform support. It is still linux only for now but adding windows support will be much easier in the future thanks to python's cross- platform support.
2020-04-21 12:04:36 -04:00
***exit*** - Cancel the installation.
-local or -installer can be passed as command line options for install.py to explicitly select one of the above options without pausing for user input.
Initial commit for the MRCI project.
2019-09-06 23:43:07 -04:00
Major change to the build system and minor changes to SSL handling - mutiple SSL cert files can now be added to the MRCI_PUB_KEY env variable via colon seperated ':' path strings to complete the cert chain if such a thing is required. It is no longer necessary to merge to multiple certs into one to complete a cert chain. - added -load_ssl command line option so cert data can be re-loaded in real time without the need to stop-start the host. - added more detailed error messages to the SSL loading process for easier debugging. - major changes to the build system include the use of python scripts instead of the linux shell script file. - linux_build.sh was removed since it is no longer needed. - the new build process now run 2 python scripts: build.py and then install.py. - the resulting installer if built no longer uses makeself. the installation and/or self extracting process is now handled entirely by python and the install.py script. The main reason for this change is to lay the ground work for multi- platform support. It is still linux only for now but adding windows support will be much easier in the future thanks to python's cross- platform support.
2020-04-21 12:04:36 -04:00
### Services ###
Initial commit for the MRCI project.
2019-09-06 23:43:07 -04:00
Major change to the build system and minor changes to SSL handling - mutiple SSL cert files can now be added to the MRCI_PUB_KEY env variable via colon seperated ':' path strings to complete the cert chain if such a thing is required. It is no longer necessary to merge to multiple certs into one to complete a cert chain. - added -load_ssl command line option so cert data can be re-loaded in real time without the need to stop-start the host. - added more detailed error messages to the SSL loading process for easier debugging. - major changes to the build system include the use of python scripts instead of the linux shell script file. - linux_build.sh was removed since it is no longer needed. - the new build process now run 2 python scripts: build.py and then install.py. - the resulting installer if built no longer uses makeself. the installation and/or self extracting process is now handled entirely by python and the install.py script. The main reason for this change is to lay the ground work for multi- platform support. It is still linux only for now but adding windows support will be much easier in the future thanks to python's cross- platform support.
2020-04-21 12:04:36 -04:00
If a target linux system supports systemd, the application will be installed as a background daemon that can start/stop with the following commands:
Initial commit for the MRCI project.
2019-09-06 23:43:07 -04:00
```
Update README.md the host no longer uses the user specification '@' symbol with systemd so the README file was updated to reflect this change.
2019-12-24 16:04:22 -05:00
sudo systemctl start mrci
sudo systemctl stop mrci
Initial commit for the MRCI project.
2019-09-06 23:43:07 -04:00
```
Added Windows Build/Install Support - added a -host_trig command line option that creates a new host instance without blocking user input. - the build/install python scripts will no longer internally build platform specific shell scripts; instead, they will now copy the necessary templates from the /templates folder. - modified both build.py and install.py to include windows deployment support so this app can now be built/installed on windows based host. note: i decided to have it "daemonized" as a scheduled task that runs on system start instead of service because it is simply easier to do it this way and will not involve any 3rd party libraries or apps. - added the src/applink.c file to the source code since it is needed for windows openssl support. - changed over all references of "endl" to "Qt::endl" to avoid depreciation errors/warnings.
2020-07-04 11:37:46 -04:00
moved the README file back to the root directory and fixed a few grammar mistakes.
2022-07-10 22:01:14 -04:00
In a Windows system, a scheduled task will be created to auto start the application in the background when the system starts.
Reference in New Issue Copy Permalink