Map Colonies - MapProxy API Service

This is an API service to manage layers provided by MapProxy

Uasage:

1. git clone https://github.com/MapColonies/mapproxy-api.git.
2. run npm install.
3. set service configurations - see below
4. run npm run start.
5. open browser in http://localhost:{port}/docs/api for swagger ui

---

Docker Usage

build the image: (from root)

 docker build --no-cache -t mapproxy-api:latest . 

run the image:

docker run mapproxy-api:latest

if you wishes to declare envs run:

docker run -e ENV=VALUE mapproxy-api:latest

• after running docker container, open browser in http://localhost:{port}/docs/api for swagger ui

Configuration

SERVER_PORT set the server port number - deafult to 8080

LOG_LEVEL set the log level *based on 'winston' logger, available values as declared in winston logger docs, default to 'info'

MAPPROXY_CONFIG_PROVIDER available values: 'fs', 's3' or 'db'.

determined where the mapproxy.yaml file is stored. no default value

if set to 'fs' - changes will apply directly to yaml file that declared in MAPPROXY_YAML_FILEPATH.

if set to 's3' - changes will directly apply to yaml file that is stored in s3 defined bucket.

if set to 'db' - changes will directly apply to the database.

MAPPROXY_CACHE_GRIDS set the requested grid name according environment.

you can provide multiple grids with seperated by ","(comma)`

example: MAPPROXY_CACHE_GRIDS="epsg4326ul,epsg4326ll", default to 'epsg4326ul'

MAPPROXY_CACHE_UPSCALE_TILES determine zoom level for upscale missing tiles

FS Configuration

---

if MAPPROXY_FILE_PROVIDER is set to 'fs' make sure to declare next envs

---

MAPPROXY_YAML_FILE_PATH set the path to the 'mapproxy.yaml' yaml file, no default value.

S3 Object Storage Configuration

---

if MAPPROXY_FILE_PROVIDER is set to 's3' make sure to declare next envs

---

S3_ACCESS_KEY_ID S3 access key, default to 'minioadmin'

S3_SECRET_ACCESS_KEY S3 secret access key, default to 'minioadmin'

S3_ENDPOINT_URL S3 endpoint URL, default to 'http://localhost:9000'

S3_BUCKET S3 bucket name, no default valuenpm

S3_SSL_ENABLED S3 enable SSL, deafult to 'false'

DB Configuration

---

if MAPPROXY_FILE_PROVIDER is set to 'db' make sure to declare next envs

---

DB_HOST set the server host , deafult to 'localhost'

DB_USER set the database username, default to 'postgres'

DB_PASSWORD set the database password, default to 'postgres'

DB_NAME set the database name, no default value

DB_PORT set the database port, default to 5432

DB_SSL_ENABLE set to true if you wished to use database ssl. default to false

DB_SSL_REJECT_UNAUTHORIZED if true, the server certificate is verified against the list of supplied CAs

DB_SSL_CA set the path to the CA file

DB_SSL_KEY set the path to the KEY file

DB_SSL_CERT set the path to the CERT file

DB first installation

To create clean initialized table including first mapproxy configuration:

copy json data from src/DAL/migration/mapproxy_init.json into src/DAL/migration/fullSchema.sql inside insertion line (change the value string)

INSERT INTO config values(DEFAULT,'/CHANGE/THIS/TO/JSON/CONTENT/FROM/mapproxy_init.json/',DEFAULT);

Note

Do not forget change bucket_name parameter to relevant environment.

Run the sql query