Skip to content

Latest commit

 

History

History
106 lines (68 loc) · 4.78 KB

README.md

File metadata and controls

106 lines (68 loc) · 4.78 KB
Raw

Management Presence Server

CodeQL API Tests Build Codecov OSSF-Scorecard Score Discord Docker Pulls

Disclaimer: Production viable releases are tagged and listed under 'Releases'. All other check-ins should be considered 'in-development' and should not be used in production

The Management Presence Server (MPS) enables remote edge management of Intel vPro® Platforms featuring Intel® AMT. MPS uses an Intel vPro® feature, Client Initiated Remote Access (CIRA), to maintain a persistent connection with managed devices. As a cloud-agnostic microservice, MPS provides out-of-band manageability features, such as power control or keyboard, video, and mouse (KVM) control.



For detailed documentation about Getting Started or other features of the Open AMT Cloud Toolkit, see the docs.


Prerequisites

To succesfully deploy MPS, the following software must be installed on your development system:

Deploy the Management Presence Server (MPS) Microservice

To deploy the MPS on a local development system:

  1. Clone the repo and switch to the mps directory.

    git clone https://github.com/open-amt-cloud-toolkit/mps.git && cd mps

  2. Open the .mpsrc file to edit.

  3. Update the following 4 fields. Save and keep track of the values you choose.

    Field Name Required Usage
    common_name Development IP Address MPS Server IP Address for Device Connection and API Use
    web_admin_user Username of your choice For logging into the Sample Web UI
    web_admin_password Strong password of your choice For logging into the Sample Web UI
    jwt_secret A strong secret of your choice Used when generating a JSON Web Token for authentication

    This password must meet standard, strong password requirements:

    • 8 to 32 characters
    • One uppercase, one lowercase, one numerical digit, and one special character.

  1. Save and close the file.

  2. Install the dependencies from the working mps directory.

    npm install

  3. Start the service.

    npm start

  4. The MPS listens on port 4433 by default. Successful installation produces the command line message:

    MPS Microservice running on localhost:3000.
Intel(R) AMT server running on localhost:4433.

Using Kong

If using the Kong* API gateway with MPS, your kong.yaml file must be updated to support JWT Authentication.

The secret provided in kong.yaml must match the jwt_secret from the .mpsrc file.

Example:

jwt_secrets:
  - consumer: admin
    key: 9EmRJTbIiIb4bIeSsmgcWIjrR6HyETqc #sample key
    secret: myStrongSecret

Additional Resources