Typesense

Description

This Ansible role deploys and configures a central Typesense search engine in a Docker container using Docker Compose. It is designed as a central engine: many application roles share one pinned Typesense stack instead of each embedding its own sidecar, keeping the application roles stateless, unpinned and NFS-shareable in swarm.

Overview

Built for environments that demand reliability and ease of management, this role:

Sets up a dedicated Docker network for Typesense.
Deploys a Typesense container with healthchecks and a bootstrap admin API key.
Provisions a per-consumer scoped API key (limited to collections prefixed <entity>_) over the Typesense /keys API, idempotently.

Cosmos

The diagram places Typesense in the Infinito.Nexus cosmos: the components it deploys (capabilities), the central services it consumes (dependencies), and its outward reach (federation and bridged external networks).

flowchart LR
    subgraph deps [Dependencies]
        dep_svc_bkp_volume_2_local["svc-bkp-volume-2-local 💻"]
        dep_svc_net_tor["svc-net-tor 🐳🐝"]
    end
    subgraph role [svc-db-typesense 🐳🐝]
        svc_typesense["typesense"]
        svc_tor["tor"]
        svc_container_backup["container_backup"]
    end
    subgraph dependents [Dependents]
        dpt_web_app_funkwhale["web-app-funkwhale 🐳🐝"]
    end
    dep_svc_bkp_volume_2_local -. "0..1" .-> svc_container_backup
    dep_svc_net_tor -. "0..1" .-> svc_tor
    svc_typesense -. "0..1" .-> dpt_web_app_funkwhale

Solid 1:1 edges are fixed relationships; dashed 0..1 edges are conditional (enabled only in matching deployments); red 0..0 edges are turned off in this role. Node markers show the role's deploy modes (💻 host, 🐳 compose, 🐝 swarm); ❌ marks a service that is explicitly turned off, and ⚙️ an Ansible role dependency declared in meta/main.yml.

Purpose

The purpose of this role is to provide an effortless way to run a shared Typesense engine via Docker while giving each consumer its own isolated, scoped credential. It minimizes manual interventions while keeping engine on-disk state node-local (it cannot live on NFS).

Features

Automated Deployment: Installs Typesense with minimal manual steps.
Per-Consumer Isolation: Issues a scoped API key per consumer, restricted to its own collection namespace.
Enhanced Security: The service is bound to 127.0.0.1:8108, restricting access and enhancing security.
Seamless Docker Integration: Works harmoniously with Docker Compose and other roles in your infrastructure.

Quick Setup

Development

Clone, set up the workstation, and deploy Typesense onto the local stack:

git clone https://github.com/infinito-nexus/core.git
cd core
make onboard
make compose-deploy mode=reinstall apps=svc-db-typesense full_cycle=false

Production

Run the published image to provision the inventory and deploy Typesense to a managed server (the mounted volume persists the inventory):

APP=svc-db-typesense
HOST=<your-server>
DOMAIN=<your-domain>
TLS_MODE=self_signed
SSH_PUBLIC_KEY="<your-ssh-public-key>"

docker run --rm -it \
  -v "$PWD/inventories:/etc/infinito.nexus/inventories" \
  -e APP="$APP" -e HOST="$HOST" -e DOMAIN="$DOMAIN" -e TLS_MODE="$TLS_MODE" -e SSH_PUBLIC_KEY="$SSH_PUBLIC_KEY" \
  ghcr.io/infinito-nexus/core/debian bash -c '
    INVENTORY=/etc/infinito.nexus/inventories/production
    infinito administration inventory provision "$INVENTORY" \
      --inventory-file "$INVENTORY/devices.yml" \
      --host "$HOST" \
      --include "$APP" \
      --vars "{\"TLS_MODE\": \"$TLS_MODE\", \"DOMAIN_PRIMARY\": \"$DOMAIN\", \"users\": {\"administrator\": {\"authorized_keys\": [\"$SSH_PUBLIC_KEY\"]}}}" &&
    infinito administration deploy dedicated "$INVENTORY/devices.yml" \
      --password-file "$INVENTORY/.password" \
      --diff -vv'

Credits

Implemented by Kevin Veen-Birkenbach. Part of the Infinito.Nexus Project and maintained by Kevin Veen-Birkenbach. Licensed under the Infinito.Nexus Community License (Non-Commercial).