Skip to content

Latest commit

 

History

History
60 lines (39 loc) · 1.29 KB

File metadata and controls

60 lines (39 loc) · 1.29 KB

MXShell Client Installation

Install

To install the Client on your workstations:

  1. Clone this repository to a permanent location on your workstation; Navigate to the project root directory.

  2. Prepare a Python virtual environment for the Client:

    python3 -m venv venv
    source venv/bin/activate
    pip install -r requirements.txt
  3. Ensure that you have modified the config file to specify the server address.

  4. Dry-run the installation:

    ./client/installer

    Check the output of the dry-run to verify that the installation script is able to detect the correct Python virtual environment.

  5. Run the actual installation:

    ./client/installer install

    The installation script will create a systemd service to run the Client in the background. The service will be started automatically when the workstation boots up.

Maintenance

Check the status of the Client service:

sudo systemctl status MXShellClient

To restart the Client service, run:

sudo systemctl restart MXShellClient

To check the system logs of the Client, run:

sudo journalctl -u MXShellClient

Uninstall

To remove the Client from a workstation, run:

./client/installer uninstall