trifid-plugin-spex/README.md

Trifid SPEX plugin

# trifid-plugin-spex

[SPEX](https://github.com/zazuko/spex) for Trifid.

This plugin does the static file hosting for all SPEX files and renders a view page that points to the configured endpoint URL.

## Quick start

Install this Trifid plugin using:

```sh
npm install trifid-plugin-spex
```

And then add in the `config.yaml` file the following part:

```yaml
plugins:
  # […] your other plugins
  spex:
    module: trifid-plugin-spex
    paths: # by default
      - /spex
      - /spex/
    config:
      prefixes:
        - prefix: ex
          namespace: http://example.org/
```

## Configuration

The following options are supported (all of them optional):

- `url`: URL to the SPARQL endpoint which will be used in the SPEX interface
- `user`: User to connect to the SPARQL endpoint
- `password`: Password to connect to the SPARQL endpoint
- `graph`: Default graph to display
- `prefixes`: List of custom prefixes (e.g. `[{ prefix: 'ex', namespace: 'http://example.org' }]`)
- `forceIntrospection`: force introspection