Skip to main content

Customizing PhariaAssistant

PhariaAssistant can be customized in various ways to suit your specific needs. The customization options are described below.

Configuration Method​

Customizations are now performed by making a PATCH request to the config/customization endpoint. This replaces the previous method of setting Helm values during installation time, which is now deprecated.

The only exception to this is specifying the default route for PhariaAssistant, which can be configured via the value defaultRoute. See the helm chart values for more details.

warning

Existing customizations via Helm values will be applied once during migration, but subsequent modifications to Helm values will not be taken into account. All future customizations must be made through the API endpoint.

API Endpoint​

PATCH /config/customization

The request body should contain a JSON object with the customization parameters you want to update. Only include the fields you want to modify - all fields are optional.

Available Customization Options​

Visual Customization​

Colors​

Customize the color scheme of the application. Omit keys as needed, only include those you wish to customize.

{
  "colors": {
    "brand-bg-brand": "#your-brand-bg-brand-color",
    "core-bg-accent": "#your-core-bg-accent-color",
    "core-bg-secondary": "#your-core-bg-secondary-color",
    "core-content-secondary": "#your-core-content-secondary-color",
    "brand-content-brand": "#your-brand-content-brand-color",
    "core-content-accent": "#your-core-content-accent-color",
    "core-bg-primary": "#your-core-bg-primary-color",
    "core-bg-tertiary": "#your-core-bg-tertiary-color"
  }
}

Fonts​

Configure custom font and font size for the application. Currently supported font families are Roboto and Raleway.

{
  "fonts": {
    "family": "Your Font Family",
    "size": "16px"
  }
}

Support & Contact Information​

Support Email​

Set a support email address for accessibility related user inquiries.

{
  "support_email": "support@yourcompany.com"
}

Support Phone​

Provide a support phone number for accessibility related user inquiries.

{
  "support_phone": "+1-234-567-8900"
}

Legal & Documentation Links​

Provide a link to your custom documentation.

{
  "documentation_link": "https://docs.yourcompany.com"
}

Help Center​

Configure help center visibility and link.

{
  "help_center_link": "https://help.yourcompany.com",
  "help_center_enabled": true
}

Set a link to your legal imprint page.

{
  "imprint_link": "https://yourcompany.com/imprint"
}

Feature Configuration​

Default Applications​

Configure which of your custom applications appear as built-in apps under "Apps built by Aleph Alpha" instead of "Apps built by {Company Name}" on the Apps page. Provide a list of application names that should be categorized as default applications.

{
  "default_applications": ["App Name 1", "App Name 2", "Custom Assistant"]
}

Create Your Own Feature​

Enable or disable the "Create Your Own" feature.

{
  "create_your_own_enabled": true
}

Complete Example​

Here's an example of a complete customization request containing all fields with dummy values:

{
  "colors": {
    "brand-bg-brand": "#your-brand-bg-brand-color",
    "core-bg-accent": "#your-core-bg-accent-color",
    "core-bg-secondary": "#your-core-bg-secondary-color",
    "core-content-secondary": "#your-core-content-secondary-color",
    "brand-content-brand": "#your-brand-content-brand-color",
    "core-content-accent": "#your-core-content-accent-color",
    "core-bg-primary": "#your-core-bg-primary-color",
    "core-bg-tertiary": "#your-core-bg-tertiary-color"
  },
  "fonts": {
    "family": "Roboto",
    "size": "16px"
  },
  "support_email": "support@yourcompany.com",
  "support_phone": "+1-234-567-8900",
  "documentation_link": "https://docs.yourcompany.com",
  "help_center_link": "https://help.yourcompany.com",
  "help_center_enabled": true,
  "imprint_link": "https://yourcompany.com/imprint",
  "default_applications": ["App Name 1", "App Name 2", "Custom Assistant"],
  "create_your_own_enabled": true
}