Skip to content

Getting Started

Installation

Installation Steps

  1. Obtain Required Files:

    • Acquire the jaxon_platform_$version.zip archive from your designated contact at Jaxon.
    • Obtain an IBM Docker registry API key from Jaxon as well.

  2. Setup Environment:

    • Log in to your Ubuntu machine.
    • Create a directory named jaxon in your home directory by executing:
      • mkdir -p $HOME/jaxon
    • Transfer the jaxon_platform_$version.zip file into the newly created $HOME/jaxon directory.

  3. Extract Deployment Files:

    • Navigate to the jaxon directory:
      • cd $HOME/jaxon
    • Extract the contents of the jaxon_platform_$version.zip file:
      • unzip -o jaxon_platform_$version.zip

  4. LLM Configuration:

    • Edit the .llm_env file located in the $HOME/jaxon directory.
      • Add any environment key variables required by your LLM provider. For example, replace <OPENAI_API_KEY> with a valid OpenAI API key.
    • Edit llm_config.yml to expose any LLMs you want available for use.
      • Configure at least one chat model and one embedding model for the platform to function correctly.
      • model_name is exposed to users in the guardrail configuration UI. This is a human-readable label.
      • Specific models and configuration options are available here.
        • The Jaxon platform uses the LiteLLM proxy to decouple the guardrails from any single provider's LLM offerings.

  5. Authenticate Docker:

    • Authenticate against the IBM Docker Container Registry using the previously obtained API key:
      • docker login -u iamapikey -p <apikey> icr.io
    • Replace <apikey> with your IBM Docker registry API key.

  6. Start the platform with Docker:

    • Initiate the platform stack by executing:
      • docker compose up -d
    • This action will pull the required platform containers from the IBM container registry and Docker Hub.

  7. Verify Stack Running:

    • Confirm that the platform containers are up and running by executing the following command:
      • docker ps
    • This command lists the active containers within the platform stack.

Install the Jaxon Platform as a System Service

To automate platform startup, configure it to run as a system service:

  1. Stop the Existing Stack:

    • Navigate to the jaxon directory and execute:
      • docker compose down

  2. Service Configuration:

    • Edit the docker-compose-jaxon.service file in the $HOME/jaxon directory.
    • Replace /path/to/your/jaxon/directory with the exact path, such as /home/my_user/jaxon.

  3. Deploy the Service File:

    • Copy the docker-compose-jaxon.service file to the /etc/systemd/systemdirectory:
      • sudo cp docker-compose-jaxon.service etc/systemd/system

  4. Enable and Start the Service:

    • Activate the service by executing:
      • sudo systemctl enable docker-compose-jaxon.service
    • Start the service:
      • sudo systemctl start docker-compose-jaxon.service

  5. Service Status Verification:

    • Verify the service's status using:
      • sudo systemctl status docker-compose-jaxon.service

    • The output should denote successful execution, analogous to:

      Loaded: loaded (/etc/systemd/system/docker-compose-jaxon.service; enabled; vendor preset: enabled) Active: active (exited) since Mon 2025-03-24 19:45:58 UTC; 1 day 20h ago Process: 326018 ExecStart=/usr/bin/docker compose up -d (code=exited, status=0/SUCCESS) Main PID: 326018 (code=exited, status=0/SUCCESS) CPU: 309ms

By following these steps, the Jaxon platform will be successfully installed and operable on your Ubuntu system. For additional support, consult your system administrator or designated contact. You can also reach out to us at support@jaxon.ai.

Next Steps

  1. Review the Platform Overview
  2. Work through the Tutorials
  3. Implement Guardrails for your own application.