Welcome to the OpenKAT documentation!
The OpenKAT website can be reached via this link
Below you find the table of contents for the full OpenKAT documentation. You can also use the search bar or the side bar to navigate the documentation. If you are stuck, or believe the docs are incorrect, you can make a ticket on our GitHub repository here.
Contents
- About OpenKAT
- Quick start
- Basics
- Basics of OpenKAT
- Modules
- Scan levels, clearance & indemnities
- Working with objects
- Boefjes
- Origin types
- Bits
- Normalizers
- Questions & Configs
- Users and organizations
- Plugins for OpenKAT: boefjes, whiskers and bits
- Trusted timestamps in OpenKAT
- User manual
- Installation and Deployment
- How do I install OpenKAT?
- Production: Container deployment
- Production: Debian packages
- Supported distributions
- Prerequisites
- Downloading and installing
- Set up RabbitMQ
- Set up the databases
- Create Rocky superuser and set up default groups and permissions
- Configure Bytes credentials
- Configure hostname in Rocky
- Restart KAT
- Start KAT on system boot
- Configure reverse proxy
- Start using OpenKAT
- Upgrading OpenKAT
- Developer environment
- Scripts
- Production: Hardening OpenKAT
- Development: make kat
- Development: make kat on Windows
- Test or develop via GitPod
- Adding NGINX to OpenKAT
- S3 buckets
- Debugging and troubleshooting
- Environment settings
- Boefjes
BOEFJES_LOG_CFGBOEFJES_POOL_SIZEBOEFJES_POLL_INTERVALBOEFJES_WORKER_HEARTBEATBOEFJES_REMOTE_NSBOEFJES_SCAN_PROFILE_WHITELISTKATALOGUS_DB_URIKATALOGUS_DB_CONNECTION_POOL_SIZESCHEDULER_APIKATALOGUS_APIOCTOPOES_APIBOEFJES_APIBOEFJES_API_HOSTBOEFJES_API_PORTBOEFJES_DOCKER_NETWORKBYTES_APIBYTES_USERNAMEBYTES_PASSWORDBOEFJES_ENCRYPTION_MIDDLEWAREBOEFJES_KATALOGUS_PRIVATE_KEYBOEFJES_KATALOGUS_PUBLIC_KEYSPAN_EXPORT_GRPC_ENDPOINTBOEFJES_LOGGING_FORMATBOEFJES_OUTGOING_REQUEST_TIMEOUT
- Bytes
BYTES_SECRETBYTES_USERNAMEBYTES_PASSWORDQUEUE_URIBYTES_LOG_CFGBYTES_DB_URIBYTES_DATA_DIRBYTES_LOG_FILEBYTES_ACCESS_TOKEN_EXPIRE_MINUTESBYTES_FOLDER_PERMISSIONBYTES_FILE_PERMISSIONBYTES_HASHING_ALGORITHMBYTES_EXT_HASH_REPOSITORYBYTES_PASTEBIN_API_DEV_KEYBYTES_RFC3161_PROVIDERBYTES_RFC3161_CERT_FILEBYTES_ENCRYPTION_MIDDLEWAREBYTES_PRIVATE_KEY_B64BYTES_PUBLIC_KEY_B64BYTES_METRICS_TTL_SECONDSBYTES_METRICS_CACHE_SIZESPAN_EXPORT_GRPC_ENDPOINTBYTES_DB_CONNECTION_POOL_SIZEBYTES_LOGGING_FORMATS3_BUCKET_PREFIXS3_BUCKETBUCKET_PER_ORG
- Mula
DEBUGSCHEDULER_LOG_CFGSCHEDULER_COLLECT_METRICSSCHEDULER_LOGGING_FORMATSCHEDULER_API_HOSTSCHEDULER_API_PORTSCHEDULER_MONITOR_ORGANISATIONS_INTERVALSCHEDULER_OCTOPOES_REQUEST_TIMEOUTSCHEDULER_OCTOPOES_POOL_CONNECTIONSSCHEDULER_KATALOGUS_REQUEST_TIMEOUTSCHEDULER_KATALOGUS_POOL_CONNECTIONSSCHEDULER_BYTES_REQUEST_TIMEOUTSCHEDULER_BYTES_POOL_CONNECTIONSSCHEDULER_RABBITMQ_PREFETCH_COUNTKATALOGUS_APIBYTES_APIBYTES_USERNAMEBYTES_PASSWORDOCTOPOES_APIQUEUE_URIQUEUE_URISPAN_EXPORT_GRPC_ENDPOINTSCHEDULER_PQ_MAXSIZESCHEDULER_PQ_INTERVALSCHEDULER_PQ_GRACE_PERIODSCHEDULER_PQ_MAX_RANDOM_OBJECTSSCHEDULER_DB_URISCHEDULER_DB_CONNECTION_POOL_SIZE
- Octopoes
- Rocky
- Boefjes
- External authentication
- CVE API
- Developer documentation
- Rocky
- Scheduler
- Boefjes
- Design considerations for new boefjes runner
- Design considerations for new normalisers (whiskers) runner
- Bytes
- Octopoes
- Octopoes Models
- octopoes.models.ooi.service
- octopoes.models.ooi.findings
- octopoes.models.ooi.email_security
- octopoes.models.ooi.web
- octopoes.models.ooi.config
- octopoes.models.ooi.certificate
- octopoes.models.ooi.monitoring
- octopoes.models.ooi.question
- octopoes.models.ooi.network
- octopoes.models.ooi.reports
- octopoes.models.ooi.dns.records
- octopoes.models.ooi.dns.zone
- octopoes.models.ooi.software
- Octopoes Research
- Reports
- Development tutorial
- QA Test plan
- Contributing
- Glossary