Configuration file

How to modify the configuration file aka conf.yml file
to start the installation of LocusQ


The configuration file is the most important part of LocusQ. To run map engine, routing engine or geocoding engine of a country the configuration filwe aka. conf.yml file is the most important. This file is must to start the docker. The data for map engine, routing engine and geocoding engine will be processed and prepared based on this file. Without this file the there will be a error like this.

cp: cannot stat '/data/conf.yml': No such file or directory

You can see the sample of the conf.yml here. Change according to your needs.

  • osmdata

In this section the countrycode is needed. The country-wise countrycode values can be found here.

  • postgres

This is also a recommended section as it is related to database credentials. Please change the values as per your needs.

  • server

This is the most important and critical part. The APIs endpoint will be created based on this input. Please provide either ip or domain. If you want to use domain sich as www.mydockermap.com the replace this domain name with the value na. If the domain is not available the ip is needed. This is the server ip where the LocusQ will be installed. The value of domain na can not be changed if ip is used.

  • services

If anyone want to use less services such as anyone want to use only the map_engine and routing_engine_osrm then every value will be no except the map_engine value and routing_engine_osrm value. These two values will remain yes.

  • osrm

This is for Routing Profile for Routing Engine. car is the default value. foot and truck can be given as per requirement.

  • graphhopper

For the Transit engine, GTFS link need to be provided. Note here, GTFS is not available freely for most of the countries of the world. Here in the transitfeed page you can find few open GTFS file. In the gtfs_url the gtfs file url needs to be provided. For Luxembourg the value will be https://openmobilitydata-data.s3-us-west-1.amazonaws.com/public/feeds/openov/621/20210901-5/gtfs.zip. For the ram_opts please choose 8 or upper according to your server size and country size.

## osm data definitions
osmdata:
  countrycode: LU

## Postgres Config
postgres:
   host: localhost
   user: renderer
   postgres_master_password: MasterPassword
   database: osmlu
   admin_user_password: UserPassword
   port: 5432

## pg Server Config (Only For Stand Alone)
pg_network:
   pg_host: 10.10.3.161
   pg_port: 8080

## Server Config
server:
   ip: 10.10.3.161
   port: 8080
   domain: false
   https: no

## Services to be installed
services:
   map_engine: false
   geocoding_engine: false
   routing_engine: false
   direction_engine: false
   transit_engine: false
   vector_tiles_api: false
   map_design_tool: false

## OSRM Configuration
osrm:
   routing_profile: car

## Graphhopper Configuration
graphhopper:
   gtfs_url: false
   ram_opts: 8