Welcome to the OpenKAT documentation!
- How does it work?
- User Guide
- Modules
- Installation and Deployment
- How do I install OpenKAT?
- Production: Container deployment
- Production: Debian packages
- Supported distributions
- Prerequisites
- Downloading and installing
- Set up the databases
- Create Rocky superuser and set up default groups and permissions
- Set up RabbitMQ
- Configure Bytes credentials
- Configure hostname in Rocky
- Restart KAT
- Start KAT on system boot
- Configure reverse proxy
- Start using OpenKAT
- Upgrading OpenKAT
- Scripts
- Production: Hardening OpenKAT
- Development: make kat
- Development: make kat on Windows
- Test or develop via GitPod
- Adding NGINX to OpenKAT
- Debugging and troubleshooting
- How do I customize LaTeX reports ?
- Environment settings
- Boefjes
BOEFJES_LOG_CFG
BOEFJES_POOL_SIZE
BOEFJES_POLL_INTERVAL
BOEFJES_WORKER_HEARTBEAT
BOEFJES_REMOTE_NS
BOEFJES_SCAN_PROFILE_WHITELIST
QUEUE_URI
KATALOGUS_DB_URI
KATALOGUS_DB_CONNECTION_POOL_SIZE
SCHEDULER_API
KATALOGUS_API
OCTOPOES_API
BOEFJES_API
BOEFJES_API_HOST
BOEFJES_API_PORT
BOEFJES_DOCKER_NETWORK
BYTES_API
BYTES_USERNAME
BYTES_PASSWORD
BOEFJES_ENCRYPTION_MIDDLEWARE
BOEFJES_KATALOGUS_PRIVATE_KEY
BOEFJES_KATALOGUS_PUBLIC_KEY
SPAN_EXPORT_GRPC_ENDPOINT
BOEFJES_LOGGING_FORMAT
- Bytes
BYTES_SECRET
BYTES_USERNAME
BYTES_PASSWORD
QUEUE_URI
BYTES_LOG_CFG
BYTES_DB_URI
BYTES_DATA_DIR
BYTES_LOG_FILE
BYTES_ACCESS_TOKEN_EXPIRE_MINUTES
BYTES_FOLDER_PERMISSION
BYTES_FILE_PERMISSION
BYTES_HASHING_ALGORITHM
BYTES_EXT_HASH_REPOSITORY
BYTES_PASTEBIN_API_DEV_KEY
BYTES_RFC3161_PROVIDER
BYTES_RFC3161_CERT_FILE
BYTES_ENCRYPTION_MIDDLEWARE
BYTES_PRIVATE_KEY_B64
BYTES_PUBLIC_KEY_B64
BYTES_METRICS_TTL_SECONDS
BYTES_METRICS_CACHE_SIZE
SPAN_EXPORT_GRPC_ENDPOINT
BYTES_DB_CONNECTION_POOL_SIZE
BYTES_LOGGING_FORMAT
S3_BUCKET_PREFIX
S3_BUCKET
BUCKET_PER_ORG
- Keiko
- Mula
DEBUG
SCHEDULER_LOG_CFG
SCHEDULER_COLLECT_METRICS
SCHEDULER_LOGGING_FORMAT
SCHEDULER_API_HOST
SCHEDULER_API_PORT
SCHEDULER_MONITOR_ORGANISATIONS_INTERVAL
SCHEDULER_OCTOPOES_REQUEST_TIMEOUT
SCHEDULER_OCTOPOES_POOL_CONNECTIONS
SCHEDULER_KATALOGUS_CACHE_TTL
SCHEDULER_KATALOGUS_REQUEST_TIMEOUT
SCHEDULER_KATALOGUS_POOL_CONNECTIONS
SCHEDULER_BYTES_REQUEST_TIMEOUT
SCHEDULER_BYTES_POOL_CONNECTIONS
SCHEDULER_RABBITMQ_PREFETCH_COUNT
KATALOGUS_API
BYTES_API
BYTES_USERNAME
BYTES_PASSWORD
OCTOPOES_API
QUEUE_URI
QUEUE_URI
SPAN_EXPORT_GRPC_ENDPOINT
SCHEDULER_PQ_MAXSIZE
SCHEDULER_PQ_INTERVAL
SCHEDULER_PQ_GRACE_PERIOD
SCHEDULER_PQ_MAX_RANDOM_OBJECTS
SCHEDULER_DB_URI
SCHEDULER_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
- Keiko
- Reports
- Development tutorial
- UI/UX design documentation
- Release notes
- Project Guidelines
- GitHub Templates