ARIX-search-adapter

This is a search adapter for the content search of Antares.

Setup

Install Go.

Testing

go get github.com/stretchr/testify/assert

This code

go get github.com/schul-cloud/arix-search-adapter

Test this code

go test github.com/schul-cloud/arix-search-adapter/arix

Run the search engine server

go build github.com/schul-cloud/arix-search-adapter && ./arix-search-adapter

After Setup, you can run this command to request a search:

curl -i 'http://localhost:8080/v1/search?Q=Einstein'

You can configure the server by setting environment variables. Here you see the environment variables with their explanation:

ARIX_SEARCH_SERVER defaults to http://arix.datenbank-bildungsmedien.net/
This is the URL the server uses for requests. It is expected to find an ARIX compatible endpoint there.
ARIX_SEARCH_CONTEXT defaults to HH
This is the search context. This influences wich search results can be found.
ARIX_SEARCH_SECRET defaults to `` (not set)
This is the secret to verify that the user has the license for the material which is requested. Note that a secret may be bound to an IP address where the requests must come form to succeed.
ARIX_SEARCH_PORT defaults to 8080
This is the port the search server listens on.
ARIX_SEARCH_LIMIT defaults to 10
This is the maximum number of resources to request.
ARIX_SEARCH_SERVER_ID defaults to ARIX
This is the id of the arix server. This can be used if you use mutiple servers to identify the resources.
ARIX_SEARCH_LINK_TYPE defaults to direct
This is the type of the resource link. These options are available:
- direct - Links show a media player or the resource in the users browser.
- download - Links make the browser download the content.

You can configure the server by running these commands:

The repository layout is inspired by this blog post

You can run this container with docker:

docker run -p 8080:8080 -e “ARIX_SEARCH_SECRET=<your secret>” schulcloud/arix-search-adapter

To build the container, run this:

docker build -t schulcloud/arix-search-adapter .