Summary

The environment variables are defined in a local .env file for working in development mode and in dedicated places on the live/production site, depending on the deployment target (i.e. GitHub pages, Netlify). For example, when deploying with GitHub pages, the environment variables must be defined under the repository Secrets and variables/Actions section, when deploying with Netlify the environment variables must be defined under Deploy settings/Environment variables.

Variables

# General
DEPLOY_PROD_BASE_URL = <base url for live/production site, in this case https://docaroo.innohub.space>
DEPLOY_ENV = dev <!!!!should not be modified>
CONSOLE_BLANK_SPINNER_CHARS = <true/false, enable/disable the spinner shown for longer tasks when building the site>

# New Relic
NR_ENABLED = <true/false, enable/disable New Relic integration>
NR_BROWSER_ENABLED = true
NR_ACCOUNT_ID = <New Relic account ID, see New Relic documentation>
NR_BROWSER_APP_ID = <New Relic browser app ID, see New Relic documentation>
NR_BROWSER_APP_LICENSE_KEY = <New Relic browser app license key, see New Relic documentation>
NR_BROWSER_BEACON = <New Relic browser app beacon, see New Relic documentation>

# External content
JEKYLL_ACCESS_TOKEN = <GitHub personal access token to get content from private repositories>
JEKYLL_GIT_USER = <GitHub user corresponding to the personal access token>

# Algolia
ALGOLIA_SEARCH_ENABLED = <true/false, enable/disable Algolia DocSearch>
ALGOLIA_APP_ID = <Algolia DocSearch app ID, see Algolia documentation>
ALGOLIA_INDEX = <Algolia DocSearch index, see Algolia documentation>
ALGOLIA_WRITE_API_KEY = <Algolia DocSearch app write key, see Algolia documentation>
ALGOLIA_PUBLIC_API_KEY = <Algolia DocSearch read(public) key, see Algolia documentation>

ALGOLIA_CUSTOM_ENABLED = <true/false, enable/disable Algolia search>
ALGOLIA_CUSTOM_APP_ID = <Algolia search app ID, see Algolia documentation>
ALGOLIA_CUSTOM_INDEX = <Algolia search, see Algolia documentation>
ALGOLIA_CUSTOM_WRITE_API_KEY = <Algolia search app write key, see Algolia documentation>
ALGOLIA_CUSTOM_ADMIN_API_KEY = <Algolia DocSearch admin key, see Algolia documentation>

# Huggingface
HUGGINGFACE_KEY = <Huggingface access key>

Purpose

Environment variables are mostly used to store values that should never be exposed, such as access keys and tokens that are used to integrate some external features and content. The external systems integrated with Docaroo ans using the environment variables are:

  • GitHub: to include external content from private repositories, at build and run time
  • New Relic: to monitor the performance and for logging purposes (subject to extension hooks)
  • Algolia: for search in site. Algolia DocSearch is fully supported and the full UI experience is provided; Algolia search does not provide (yet) the UI experience, but the features of updating the index are provided.
  • Huggingface: for accessing the open source models used to provide various features of Docaroo (such as auto summaries, PDF/DOCX summarisation, similar docs identification)

On this page

Comments
Title : pageTitle
Reference : anchor