← Documentation

Operations

Diagnostics

Understand basic diagnostics of the refngn project.

Overview

Important.Project is not yet released!

This article shows the basics of diagnostics while setting up.

1. refngn test commnad

Test command example.



refngn test 

✓ TOML syntax: OK
✓ HTTP engine: listener and routing rules valid
✓ TLS configuration: certificates and private keys readable
✓ Conflicting rules: none found
✓ Backends [refngn.com]: reachable
  http://127.0.5.1:8000 (/)
✓ Backends [refngn.com]: reachable
  http://[::1]:8000 (/)

Configuration valid.

	

This command is a basic test command for all active sites and configurations, it's short but gives and validate all files that are needed

2. refngn doktor

refngn doktor, a more large scale diagnose tool


refngn doktor

✓ Configuration: valid
✓ HTTP Parser [localhost]: Hyper stable mode
! TLS [localhost]: not configured for this site
✓ DNS [localhost]: resolved
  127.0.0.1, ::1
- Certificates [localhost]: no certificate configured
! Security Rules [localhost]: no site-level HTTPS redirect
  A listener-level redirect may still apply.
✓ Request Limits [localhost]: configured
  using global server defaults
! HTTP Parser [refngn.com]: Hyper + refngn-parser beta mode
  Parser disagreement rejects the request. Test before production use.
✓ TLS [refngn.com]: enabled
  certificate: /etc/refngn/config/certs/fullchain.cer
✓ DNS [refngn.com]: resolved
  91.200.103.101, 2a01:367:c204::31f:3e
✓ Certificates [refngn.com]: certificate readable
  /etc/refngn/config/certs/fullchain.cer
✓ Certificates [refngn.com]: private key readable
  /etc/refngn/config/private/refngn.com.key
✓ Security Rules [refngn.com]: HTTPS/canonical redirect active
✓ Request Limits [refngn.com]: configured
  headers=100 header_bytes=32768 uri_bytes=8192 body_bytes=16777216
✓ Backends [refngn.com]: reachable
  http://127.0.5.1:8000 (/)
✓ Backends [refngn.com]: reachable
  http://[::1]:8000 (/)
✓ Reverse Proxy: routes parsed
  1 proxy route(s)

Configuration valid.

        

This command will test all config files, and gives and more advanced and more information about the diagnostics

Documentation placeholder. Some commands on this page are illustrative. All diagnostics commands can soon be used per domain, not only all configs!

3. Next steps

How to diagnose a problem?