Installation and deployment

Contains documentation for developers and contributors.

Contents

• How do I install OpenKAT?
  • Production environments
    • Pre-built Docker images
    • Debian packages
  • Development environment
    • make kat
  • Minimum requirements
  • Example infrastructure
• Production: Container deployment
  • Container images
  • Setup
  • Container commands
  • Upgrading
• Production: Debian packages
  • Supported distributions
  • Prerequisites
  • Downloading and installing
  • Set up the databases
    • Rocky DB
    • KAT-alogus DB
    • Bytes DB
    • Mula DB
  • Create Rocky superuser and set up default groups and permissions
  • Set up RabbitMQ
    • Installation
    • Add the ‘kat’ vhost
  • Configure Bytes credentials
  • Configure hostname in Rocky
  • Restart KAT
  • Start KAT on system boot
  • Start using OpenKAT
  • Upgrading OpenKAT
• Scripts
  • Installation
  • Update
  • Status and logs
  • Starting, stopping, restarting
  • Empty queue
• Production: Hardening OpenKAT
  • DJANGO_ALLOWED_HOSTS
  • DJANGO_CSRF_TRUSTED_ORIGINS
  • SESSION_COOKIE_AGE
  • Security headers
  • SSL/TLS on nginx
  • Obscuring errors to the clients
  • Web Application Firewall
  • Continue reading
• Development: make kat
  • make kat
    • Requirements
    • Before installing
      • Install Docker
      • Install dependencies
    • Getting Started
      • Default installation
      • Front end
      • Specific builds
    • Updates
    • Clean reinstallation
  • OpenTelemetry
• Test or develop via GitPod
  • Gitpod test environment
• Adding NGINX to OpenKAT
  • Background
  • Installation
  • Logging
  • Activation
  • SSL certificates
  • Restart NGINX and go
  • Security settings
• Debugging and troubleshooting
  • Healthpage
  • Processes
    • Docker containers
    • Packaged versions
    • Debian package service logs
  • Diskspace in debug mode
  • XTDB memory size
  • Permissions
• How do I customize LaTeX reports ?
  • Styling changes
    • Text colours
  • Readable findings
  • Changing fonts
• Environment settings
  • Boefjes
    • BOEFJES_LOG_CFG
    • BOEFJES_POOL_SIZE
    • BOEFJES_POLL_INTERVAL
    • BOEFJES_WORKER_HEARTBEAT
    • BOEFJES_REMOTE_NS
    • QUEUE_URI
      • Examples
    • KATALOGUS_DB_URI
      • Examples
    • SCHEDULER_API
      • Examples
    • KATALOGUS_API
      • Examples
    • OCTOPOES_API
      • Examples
    • BYTES_API
      • Examples
    • BYTES_USERNAME
      • Examples
    • BYTES_PASSWORD
      • Examples
    • SPAN_EXPORT_GRPC_ENDPOINT
  • Bytes
    • BYTES_SECRET
      • Examples
    • BYTES_USERNAME
      • Examples
    • BYTES_PASSWORD
      • Examples
    • QUEUE_URI
      • Examples
    • BYTES_LOG_CFG
    • BYTES_DB_URI
      • Examples
    • BYTES_DATA_DIR
    • BYTES_LOG_FILE
    • BYTES_ACCESS_TOKEN_EXPIRE_MINUTES
    • BYTES_FOLDER_PERMISSION
    • BYTES_FILE_PERMISSION
    • BYTES_HASHING_ALGORITHM
      • Possible values
    • BYTES_EXT_HASH_REPOSITORY
      • Possible values
    • BYTES_PASTEBIN_API_DEV_KEY
    • BYTES_RFC3161_PROVIDER
      • Examples
    • BYTES_RFC3161_CERT_FILE
      • Examples
    • BYTES_ENCRYPTION_MIDDLEWARE
      • Possible values
    • BYTES_PRIVATE_KEY_B64
    • BYTES_PUBLIC_KEY_B64
    • BYTES_METRICS_TTL_SECONDS
    • SPAN_EXPORT_GRPC_ENDPOINT
  • Keiko
    • DEBUG
    • KEIKO_LOG_CFG
    • KEIKO_TEMPLATES_FOLDER
    • KEIKO_GLOSSARIES_FOLDER
    • KEIKO_ASSETS_FOLDER
    • KEIKO_REPORTS_FOLDER
    • SPAN_EXPORT_GRPC_ENDPOINT
  • Mula
  • Octopoes
    • OCTOPOES_LOG_CFG
    • QUEUE_URI
      • Examples
    • XTDB_URI
      • Examples
    • OCTOPOES_XTDB_TYPE
      • Possible values
    • KATALOGUS_API
      • Examples
    • OCTOPOES_SCAN_LEVEL_RECALCULATION_INTERVAL
    • OCTOPOES_BITS_ENABLED
      • Examples
    • OCTOPOES_BITS_DISABLED
      • Examples
    • SPAN_EXPORT_GRPC_ENDPOINT
  • Rocky
• External authentication
• CVE API