Skip to content

Latest commit

 

History

History
63 lines (44 loc) · 3.26 KB

Configuration.md

File metadata and controls

63 lines (44 loc) · 3.26 KB

Configuration

You'll find configurable options for the application here. We use environment variables for this purpose.

Options

  • VITE_COMMUNITY - URI of the community
  • VITE_COMMUNITY_CONTAINER - name of folder in which to store person's data of this community
  • VITE_EMAIL_NOTIFICATIONS_TYPE - choose type of notifications service we use:
  • VITE_EMAIL_NOTIFICATIONS_SERVICE - server providing email notifications service of type specified in VITE_EMAIL_NOTIFICATIONS_TYPE; provide base url without trailing slash; notifications will be disabled if left empty
  • VITE_EMAIL_NOTIFICATIONS_IDENTITY - identity of the email notifications service; app will allow this identity to read person's inbox
  • default CreateReactApp options
  • VITE_BASE_URL - this is base url for ClientID in ./public/clientid.jsonld, it's disabled in development environment by default (dynamic clientID is used), defaults to http://localhost:5173 in development, and http://localhost:4173 for build
  • VITE_ENABLE_DEV_CLIENT_ID - enable static ClientID in development environment (see also BASE_URL option). If you set this option, you'll only be able to sign in with Solid Pod running on localhost! (dynamic clientID will be used by default)
  • VITE_GEOINDEX - webId of the geoindex, if available
  • VITE_DARK_MODE_LOGO_STYLE - change logo colors in dark mode (default undefined - no change)
    • invert - invert colors of the logo

Usage

Note: You can also specify environment variables in .env files

Run

VITE_VARIABLE1="variable" VITE_VARIABLE_2="other variable" yarn dev

Build

VITE_VARIABLE1="variable" VITE_VARIABLE_2="other variable" yarn build

Specify environment variables for github workflow build

You can specify github environment variables in repository's settings. Some of github variables are named differently from the environment variables documented here

Have a look in deployment workflow to see how our github environment variables map to our app configuration options

Github workflow variables

  • COMMUNITY
  • COMMUNITY_CONTAINER
  • EMAIL_NOTIFICATIONS_TYPE
  • EMAIL_NOTIFICATIONS_SERVICE
  • EMAIL_NOTIFICATIONS_IDENTITY
  • GEOINDEX
  • BASE_URL
  • DARK_MODE_LOGO_STYLE
  • see deployment workflow for more

Adding a new option

New configuration options make things more flexible 👍

Custom configuration options need to start with VITE_.

Add the new option in src/config/index.ts, and include some sensible default, so the app can still run without specifying anything

Make sure to also include the option in deployment workflow