Connect Outline
Make approved Outline documents and collection descriptions searchable in Nexus.
An operator must configure this source in your workspace. These steps describe the connector code; they do not mean your school has connected an account.
What this connector reads#
The Outline connector retrieves documents and collection descriptions through the Outline API. Each indexed result retains a link to its source in Outline.
Prepare the credential#
Your school operator needs the Outline workspace's base URL and an API token. Enter these in the credential form. The engine fields are outline_base_url and outline_api_token. Use the URL of your Outline workspace, not the URL of an individual document.
The token's account determines which content the connector can request. Give it access only to material approved for this connection.
Start indexing#
Open connector settings, select Outline, and save its credential. The basic Outline connection form has no additional collection selector. Review the account's available collections before running the connection.
Wait for a successful indexing run. Search for a known document title, then check its citation. Also check a collection description if your school uses it to organise course material.
Resolve missing results#
Check the base URL and token first. Confirm that the token account can read the document in Outline. Then inspect the latest indexing run for request failures.
Before students use the source, verify the Nexus document access settings with a student test account. A successful connection does not itself define which classes should use the content.