Configuration

This section details all the configurations available for each service.

API

All the following configurations must be defined in a yaml file. By default, it’s in config.yaml which needs to be at the same place as the code.

But you can change this path by defining the environment variable CONFIG_FILE_PATH.

Firebase

YAML Structure

firebase:
    credentials_file_path:
    project_id:
    mock:
        enabled:
        data_file_path:

Parameters

• firebase.credentials_file_path : (Env variable : `FIREBASE_CREDENTIALS_FILE_PATH`) - Path to the firebase credentials file

• firebase.project_id : (Env variable : `FIREBASE_PROJECT_ID`) - Project id of the firebase

• firebase.mock.enabled : (Env variable : `FIREBASE_MOCK_ENABLED`) - Set to true if you want to enable the mocks and do some specific tests.

• firebase.mock.data_file_path : (Env variable : `FIREBASE_MOCK_DATA_PATH`) - Path to the mock resources

To get the file defined in firebase.credentials_file_path, check this Firebase documentation which explains how to configure a service account.

—

Database

YAML Structure

database:
  mock:
    enabled:
    data_folder_path:
  mongo:
    uri:
    name:

Parameters

• database.mock.enabled : (Env variable : `DATABASE_MOCK_ENABLED`) - Set to true if you want to enable the mocks and do some specific tests.

• database.mock.data_file_path : (Env variable : `DATABASE_MOCK_DATA_PATH`) - Path to the mock resources

• database.mongo.uri : (Env variable : `DATABASE_MONGO_URI`) - URI path of the database

• database.mongo.name : (Env variable : `DATABASE_MONGO_NAME`) - Name of the collection to use in Mongo.

—

Server

YAML Structure

server:
  expose:
  metrics_expose:
  origins_allowed:
  images_dir:
  images_base_url:

Parameters

• server.expose : (Env variable : `SERVER_EXPOSE`) - Port to expose the API. Default 8080

• server.metrics_expose : (Env variable : `SERVER_METRICS_EXPOSE`) - Port to expose the API metrics. Default 2121

• server.origins_allowed : List of the origins allowed to call the API

• server.images_dir : (Env variable : `SERVER_IMAGES_DIR`) - Folder where the images will be stored

• server.images_base_url : (Env variable : `SERVER_IMAGES_BASE_URL`) - Base path to call to get the images. By default need to be /v1/images if you use the API endpoint

—

Images

YAML Structure

images:
  maxImagesPerIdea:
  maxImagesPerComment:
  maxSize:
  acceptedExtensions:

Parameters

• images.maxImagesPerIdea : (Env variable : `IMAGE_MAX_IMAGES_PER_IDEA`) - Max number of images per idea

• images.maxImagesPerComment : (Env variable : `IMAGE_MAX_IMAGES_PER_COMMENT`) - Max number of images per comment

• images.maxSize : (Env variable : `IMAGE_MAX_SIZE`) - Image max size in bytes

• images.acceptedExtensions : List of file extensions allowed for file upload.

—

Admin

YAML Structure

admin:
  defaultList:

Parameters

• admin.defaultList : List of default administrator of the Iris instance

---

Frontend

Two json configurations files are required:

• config.json

• firebase-config.json

config.json

{
  "apiBaseUrl": "",
  "appTitle": " - ",
  "appLoginTitle": "",
  "appIcon": ""
}

• apiBaseUrl : [Mandatory] Base url of the Iris API

• appTitle : [Optional] App title to display instead of the default one

• appLoginTitle : [Optional] Login title to display instead of the default one

• appIcon : [Optional] App icon to display instead of the default one

firebase-config.json

{
  "apiKey": "",
  "authDomain": "",
  "databaseURL": "",
  "projectId": "",
  "storageBucket": "",
  "messagingSenderId": "",
  "appId": ""
}

• apiKey : [Mandatory] Firebase API key

• authDomain : [Mandatory] Firebase Auth domain

• databaseURL : [Mandatory] Firebase database URL

• projectId : [Mandatory] Firebase project ID

• storageBucket : [Mandatory] Firebase storage bucket

• messagingSenderId : [Mandatory] Firebase messaging sender ID

• appId : [Mandatory] Firebase app ID

These configurations can be found in the Firebase console. Check this documentation to know how to retrieve these informations.