Setup

This page covers how to deploy Squirro Neo on an existing Squirro instance. Once deployed, Neo is accessible at https://your-instance.example.com/neo/. The existing Squirro interface continues to run unchanged at https://your-instance.example.com/.

Prerequisites

• A Squirro installation managed by the squirro-ansible role.

• Squirro 3.15.5 or later.

• A configured SSO identity provider.

SSO Configuration

Single sign-on (SSO) is the only supported authentication mode for Neo. The IdP must accept the AssertionConsumerService (ACS) callback URLs that Neo uses. Make sure the following URLs are allowed by the IdP for the Squirro instance hosting Neo, where <instance> is the host name of that instance:

• https://<instance>/nextgen/sso/callback

  The path that the webclient currently emits in its SAML requests. This path is retained as a legacy alias for backward compatibility.

• https://<instance>/neo/sso/callback

  The forward-looking path used by Neo. Allowing both URLs upfront avoids a second IdP change later.

Deploy Neo

Open your existing Ansible playbook and add squirro_webclientnode: True to the vars block:

- name: Quickstart Install Squirro with Neo
  hosts: all
  become: true
  vars:
    squirro_clusternode: True
    squirro_storagenode: True
    squirro_webclientnode: True
    yum_user: ...
    yum_password: ...
    squirro_channel: stable
    squirro_version: latest
    elasticsearch_discovery_type: single-node
  roles:
    - role: squirro-ansible

Then re-run the playbook:

ansible-playbook --connection=local --inventory 127.0.0.1, playbook.yml

Ansible applies only what changed. It does not reinstall the entire stack.

Verify the Setup

After the playbook completes, open a browser and navigate to:

https://your-instance.example.com/neo/

The Neo login screen should appear. The existing Squirro interface at / is not affected.

Introducing Neo to Users

After deploying Neo, you can optionally display an announcement card in the classic Squirro Chat widget sidebar to help users discover the new interface. The card includes a brief description of Neo and an Open Preview button that opens /neo/ in a new browser tab.

Users can dismiss the card by clicking the close button. Once dismissed, the card does not reappear unless the user clears their browser local storage. Clearing the browser cache alone does not reset the dismissal.

The card is turned off by default. A project administrator can turn it on per project by setting frontend.sqgpt.project-neo-banner to true under Setup Space → Settings → Project Configuration.