dbp/relay-nexus-bundle

A template bundle for the Relay API gateway

Maintainers

Details

github.com/digital-blueprint/relay-nexus-bundle

Source

Issues

Installs: 2 219

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 0

Open Issues: 1

Type:symfony-bundle

v0.2.2 2025-05-05 08:04 UTC

Requires

Requires (Dev)

AGPL-3.0-or-later effa57e780b5afea2d9736724a1be1b005047308

This package is auto-updated.

Last update: 2025-05-05 08:05:18 UTC

README

GitHub | Packagist | Frontend Application

The Nexus bundle provides an API for providing a desktop application merging multiple frontend activities.

There is a corresponding frontend application that uses this API at Nexus Frontend Application.

Bundle installation

You can install the bundle directly from packagist.org.

composer require dbp/relay-nexus-bundle

Bundle configuration

Add this file dbp_relay_nexus.yaml to your config/packages/ directory, e.g.:

dbp_relay_nexus:
    topics:
        - "https://server01.org/app/app.topic.metadata.json"
        - "https://server02.org/app/app.topic.metadata.json"
        - "https://server03.org/app/app.topic.metadata.json"
    typesense:
        host: "%env(NEXUS_TYPESENSE_HOST)%"
        prot: "%env(NEXUS_TYPESENSE_PROT)%"
        port: "%env(NEXUS_TYPESENSE_PORT)%"
        api_key: "%env(NEXUS_TYPESENSE_API_KEY)%"
    frontend:
        alias: "nexus--current"
        api_key: "nexus:search-key"
    authorization:
        policies:
            ROLE_USER: 'user.get("ROLE_DEVELOPER")'
variable type content
topics array strings are URLs to the topic.metatdada.json files of the apps
typsense Settings for the internal connction to the typesense server
host string name or ip of the typsense server to talk to
prot string protocol to talk to the typesense server either 'http' or 'https'
port int port of the typesense server to talk to
api_key string typesense API key to create, query and delete typesense collections
frontend Settings for the front end app
alias string name of the current collection to query via the typesense proxy
api_key string API key to query the current collection via the typesense proxy

Automatic import into new collection

Run bin/console dbp:relay:nexus:generate:activities to create a new collection with currently available activities. If documents were imported, the alias is set to the latest import and obsolete collections are deleted.