Skip to content

Latest commit

 

History

History
72 lines (59 loc) · 3.92 KB

README.md

File metadata and controls

72 lines (59 loc) · 3.92 KB
Raw

INTERLIS Model Repository

This repository contains dockerized tools to validate and host a INTERLIS Model Repository compatible with ilivalidator.

Create repository structure

The following repository structure is required by many INTERLIS-Tools to work. This documentation assumes given structure.

repository-root
├── folder-with-ili-or-catalogs
│   ├── *.ili
│   └── *.xml
├── ilimodels.xml
├── ilisite.xml
└── (ilidata.xml)

Validate repository

The image interlis-model-repository-validator is configured to validate a repository located in mounted directory /input and copy the contents on successful validation to the /output directory. The container will exit after validation.

The image does not contain the software ili2c but will download it on initial startup. Upon successful validation the script will create a Version.md file containing information about the validation time & date.

Minimal setup with compose:

version: "3.3"
services:
  repository:
    image: ghcr.io/geowerkstatt/interlis-model-repository-validator
    volumes:
      - local-repository-files:/input       
      - validated-repository:/output

Configuration Options

ENV-Variable Description
PROXY Optional, Configuring proxy settings for all apps in the container. Protocol (e.g. http://) and port (e.g. 8080) is mandatory in order do be able to parse values properly. Possible values are: http://example.com:8080 , https://host.example.com:443, http://10.10.5.68:5698, https://USER:[email protected]:8443
ILI2C_ENABLE_TRACE Set flag --trace on ili2c execution. Default: false

Host repository

The docker image interlis-model-repository provides a preconfigured nginx instance with themed ngx-fancyindex module activated. The theme is based on Nareen's theme and provides some extra's tailored for hosting an INTERLIS Repository.

Minimal setup with compose:

Run the provided compose within your correctly structured Repository

version: "3.3"
services:
  repository:
    image: ghcr.io/geowerkstatt/interlis-model-repository
    volumes:
      - validated-repository:/data:ro
    ports:
      - "80:80"

Providing version information

Attention: Version.md is excluded in visual representation of the index.

Version information can be provided within the Version.md file in the Repository root. The contents are translated to html and are show below the footer.

Adaptation of theme

The image allows to override the included theme or configure the displayed text in header and footer with markdown. Extend the docker-compose file accordingly. The markdown capabilities are provided by Nareen's theme.:

volumes:
 - ./Custom-header.md:/theme/HEADER.md  #Override the contents of the header.
 - ./Custom-footer.md:/theme/README.md  #Override the contents of the footer.

Replace the included theme by overriding / mounting the contents of /theme within the container. The ngx-fancyindex is configured to load /theme/header.html as header, respectively /theme/footer.html as footer. The contents of /theme are served within the /theme-subroute.

Adaptation of nginx config

The image functions like regular nginx docker image apart default configuration and included ngx-fancyindex. For configuring please refer to official nginx documentation and our config files nginx.conf and default.conf.template.

Screenshot Repository