histograph.default.yml

api:                                        # API and IO options (http://github.com/histograph/api
  bindHost: 0.0.0.0                         #   and http://github.com/histograph/io)
  bindPort: 3001
  baseUrl: http://localhost:3001
  defaultPathRelation: hg:liesIn            # Default relation that is used to solve combined
                                            #   queries, e.g. 'hoorn, friesland'
  exampleUrls:
    - "/search?q=albrechtlaan"
    - "/search?uri=http://vocab.getty.edu/tgn/7003626"
    - "/search?id=tgn/7264385"
    - "/search?q=almelo&dataset=tgn"
    - "/datasets"
    - "/datasets/geonames"
    - "/ontology"
    - "/schemas/pits"
    - "/schemas/relations"
    - "/stats/queue"
    - "/stats/queries"
    - "/stats/queries/types-per-dataset"
    - "/search?q=hezingen"
    - "/search?name=hoorn&type=hg:Municipality"
    - "/search?name=amsterdam&related=hg:liesIn&related.q=drenthe"
    - "/search?q=amsterdam,drenthe"
    - "/search?q=nymegen&before=1600"
    - "/search?q=hoorn&intersects={%22type%22:%22Polygon%22,%22coordinates%22:[[[4.7316,53.0150],[4.7316,53.0310],[4.7766,53.0310],[4.77664,53.0150],[4.7316,53.0150]]]}"

  hairRelations:                            # Non-equivalence PIT-PIT relations returned by
    - hg:liesIn                             #   neo4j-plugin, in hairs array
    - hg:originated                         #   (http://github.com/histograph/neo4j-plugin)
    - hg:originatedFrom
    - hg:absorbed
    - hg:absorbedBy

  # Absolute or relative directory on file system where API's IO module keeps uploaded
  #   NDJSON files. IO keeps __two__ copies of each file, please make sure HD has enough
  #   free space!
  dataDir:
  # Credentials of API's admin owner - this name + password is needed when creating/deleting
  #   datasets and uploading data using the REST API
  admin:
    name:
    password:

stats:                                      # Stats options (http://github.com/histograph/stats)
  enabled: false                            # Set enabled to false when stats module leads to
                                            #   performance problems
  cronExpression: '0 0 */3 * * *'           # Run every three hours

redis:                                      # Redis connection details
  host: localhost
  port: 6379
  queue: histograph
  maxQueueSize: 50000

elasticsearch:                              # Elasticsearch connection details
  host: localhost
  port: 9200

neo4j:                                      # Neo4j connection details + opt. authentication
  host: localhost
  port: 7474

core:                                       # Core options (http://github.com/histograph/core)
  batchSize: 100
  batchTimeout: 250

viewer:                                     # Viewer options (http://github.com/histograph/viewer)
  language: en                              # Language: English ('en'), or Dutch ('nl')
  mode: advanced                            # Mode: 'simple' or 'advanced'
  logo: images/histograph.svg               # Relative or absolute path to logo, image or SVG, 44px wide
                                            #   empty or null means no logo
  color: 'rgb(74,187,131)'                  # Viewer base color
  suffixFilters:                            # Replace these words with '' in liesIn suffixes,
    - Provincie                             #   e.g. 'Amsterdam, Provincie Noord-Holland' becomes
    - Gemeente                              #   'Amsterdam, Noord-Holland'

data:                                       # Data module options (http://github.com/histograph/data)
  geonames:
    countries:
      - NL
    extraUris: ./extra-uris.json
  tgn:
    parents:
      - tgn:7016845                         # The Netherlands
  bag:
    db:
      host: localhost
      port: 5432
      user: postgres
      password: postgres
      database: bag

import:                                     # Import options (http://github.com/histograph/import)
  diffTool: diff
  dirs:                                     # Array of absolute or relative paths to directories containing
                                            #   Histograph datasets which can be imported by import module
  s3:                                       # Import can also import datasets from Amazon Web Services S3
    region:                                 #   Set the S3 region, access keys and buckets in this section.
    accessKeyId:
    secretAccessKey:
    buckets:                                # Array of S3 buckets

schemas:                                    # Schema/ontology options (http://github.com/histograph/schema)
  baseUri: http://rdf.histograph.io/        # Base URI, used in JSON-LD serialization

  baseType: PlaceInTime

  types:                                    # Histograph's default types
    - hg:Address
    - hg:Building
    - hg:Monument
    - hg:Fort
    - hg:Street
    - hg:Neighbourhood
    - hg:Borough
    - hg:Place
    - hg:Municipality
    - hg:Water
    - hg:Polder
    - hg:Area
    - hg:Region
    - hg:Province
    - hg:Baljuwschap
    - hg:Barony
    - hg:Departement
    - hg:Countship
    - hg:Heerlijkheid
    - hg:Country

  relations:                                # Default relations
    - hg:sameHgConcept
    - hg:containsHgConcept
    - hg:withinHgConcept
    - hg:intersectsHgConcept
    - hg:absorbed
    - hg:absorbedBy
    - hg:originated
    - hg:originatedFrom
    - hg:contains
    - hg:liesIn

  equivalence: hg:sameHgConcept            # Equivalence relation, defining whether PITs belong to
                                           #   the same concept

logo:
  - "   ●───────●    "
  - "  /║       ║\\  "
  - " / ║       ║ \\ "
  - "●  ║═══════║  ● "
  - " \\ ║       ║ / "
  - "  \\║       ║/  "
  - "   ●───────●    "