Setting up

Last update: a month ago by Mateusz FilipowiczReading time: 2 min

Primary configuration is set in config.yml within config directory in you main project directory. Configuration details are described in subsequent articles.

Adding images

For adding images (or any other assets) to content, please follow this guide instead. Using assets does not bring performance optimization

You can use your own logo, favicon, page icons (used by PWAPWA - Progressive Web App Web app that uses modern web capabilities to deliver an app-like experience to users). Add images to static/assets directory. Any assets (like images) can be then accessed under /assets/<name_of_file> path.

Let's assume you add mylogo.png image to static/assets. Then you can set a path in config.yml logo configuration as

header:
  logo: /assets/mylogo.png

Using environment variables

Some configuration may be either sensitive (like Algolia API keys) or is per-environment. To set such properties, you can make use of environment variables to pass configuration to BooGi / Gatsby while building your project.

Each and every configuration property in config.yml can also be passed in environment variable.

Important: List variables are not supported!

General rule:

in config.yml:

property1:
  childProperty: MyApp

then env variable should be: PROPERTY1_CHILD_PROPERTY.

Examples

Example 1:

metadata:
  name: MyApp
features:
  search:
    startComponent: 'input'

METADATA_NAME=MyApp Test
FEATURES_SEARCH_START_COMPONENT=icon

Example 2:

features:
  search:
    enabled: false

FEATURES_SEARCH_ENABLED=true
FEATURES_SEARCH_ALGOLIA_APP_ID=XXXYYYZZZ9
FEATURES_SEARCH_ALGOLIA_SEARCH_KEY=aabbccddeeffgghhiijjkk
FEATURES_SEARCH_ALGOLIA_ADMIN_KEY=xxxyyyzzz
FEATURES_SEARCH_INDEX_NAME=myapp-test-idx

🔧 Configuration — Previous

Introduction

Next — 🔧 Configuration

Base configuration