Developer documentation

Contains documentation for developers and contributors.

Contents

• Rocky
• Stack
• Running Rocky
  • Containerized
  • Locally
  • Installation
  • Running
• First run
• Testing
• Database
• KATalogus View Structure
• Fonts license
  • Fredoka
  • Open Sans
  • Tabler icons
• Rocky Design
  • Running a boefje
  • Rocky View Structure
    • Overview of child Views of the OrganizationViews
    • Exhaustive overview of OctopoesViews
    • KATalogus Views
• Scheduler
  • Purpose
  • Architecture
    • Stack, packages and libraries
    • External services
    • Project structure
  • Running / Developing
    • Prerequisites
    • Running
  • Testing
• Boefjes
  • Prerequisites
  • KATalogus
    • Organisations
    • Repositories
    • Plugins
    • Settings
  • Environment variables
  • Design
    • Running as a Docker container
    • Running the worker directly
    • Example job
    • Running a tool or normalizer directly using a job file
    • Boefje and normalizer structure
    • Running the test suite
• Bytes
  • Installation
    • With Docker
    • Without Docker
  • Configuration
    • Hashing and Encryption
    • Observability
  • Design
    • Design: C2 Container level
    • Design: C3 Component level
  • Development
    • Code style and tests
    • Migrations
    • Export SQL migrations
  • Production
    • Performance tuning
• Octopoes
  • Instructions
  • Environment variables
    • Run Octopoes API
    • Run the event processor
  • Healthcheck
  • OOI
  • Origin
  • Origin through declaration
  • Origin through observation
  • Origin through inference
  • Graph mutations
  • Code Architecture
    • Sequence: save_origin
    • Sequence: process update ooi
  • Crux / XTDB
  • OOI
  • Relationships
  • A few example records
  • OOI Reference
  • Octopoes API
    • OctopoesAPIConnector
  • Abstract classes / subclassing
  • Querying
  • Tests
• Keiko
  • Installation requirements
  • File system permissions
  • Running the API
  • Environment variables
  • Logging
  • Building a new template
  • Generating a report
  • Testing a report with command line