Skip to content
Kuiper edited this page Nov 1, 2019 · 3 revisions

Configuration

All configuration for Kuiper placed in one single file named configuration.yaml to be more straight forward as seen below.

Kuiper platform

The following section of the configuration file is responsible for setting the parameters for Flask web application. by default Kuiper will use the IP address [0.0.0.0] and port [5000] for the web application

...
# ============ Kuiper Platform
Kuiper:
  IP            : 0.0.0.0         # flask web application ip
  PORT          : 5000            # flask web application port 
  Debug         : True            # enable debugging mode
  RemoveRawFiles: True            # remove raw files uploaded to Kuiper, as consequences enable this will allow upload the file multiple times

...

Celery

The following section of the configuration file is responsible for setting the parameters for celery based on redis configurations.

...
# ============ configuration of celery
CELERY:
  CELERY_BROKER_URL     : redis://localhost:6379
  CELERY_RESULT_BACKEND : redis://localhost:6379
  CELERY_TASK_ACKS_LATE : True
...

Elasticsearch

The following section of the configuration file is responsible for setting the parameters for the elasticsearch database. by default it will use the IP address [127.0.0.1] and port [9200]

...
# ============ Elasticsearch
ElasticSearch:
  IP    : 127.0.0.1
  PORT  : 9200
...

MongoDB

MongoDB database name, by default [Kuiper]

...
MongoDB:
  DB_NAME: 'Kuiper'         # MongoDB Database name
  DB_IP: '127.0.0.1'        # MongoDB Database IP address 
  DB_PORT: 27017            # MongoDB Database Port number
...

Default Files

The following section store the default paths used by Kuiper,

...
# ============ configuration of directories on the platform
# it is preferable to not change these settings (except platform_folder)  
Directories:
  platform_folder: &platform_folder   ./Kuiper                          # main folder
  app_folder: &app_folder             [*platform_folder, /app]          # application files folder
  app_parsers:                        [*platform_folder, /app/parsers]  # parsers folder
  artifacts_upload:                   [*platform_folder, /files]        # uploaded artifacts folders  
  artifacts_upload_raw:               [*platform_folder, /raw]          # original uploaded compressed files
...
Clone this wiki locally