| Version | Supported |
|---|---|
| 1.0.x | ✅ |
-
Change Default Credentials: The default configuration contains placeholder values. Generate proper bcrypt hashes before use:
htpasswd -bnBC 12 "" yourpassword | tr -d ':'
-
Enable TLS: In production, always enable TLS by configuring
tls.enabled: truewith valid certificates. -
Restrict Bind Address: If using a reverse proxy, bind to localhost only:
"bindAddress": "127.0.0.1"
-
Minimize Permissions: Grant only the minimum required permissions to each client.
-
Protect RSA Keys: The JWT RSA keypair (
jwt-keypair.pem) is automatically generated and should be kept secure. Do not commit this file to version control.
The following files contain sensitive data and must not be committed to version control:
config.json- Contains client secrets (bcrypt hashes)jwt-keypair.pem- RSA private key for JWT signing*.pem,*.key,*.crt- TLS certificates and keys
These are already included in .gitignore.
If you discover a security vulnerability, please report it by:
- Do NOT create a public GitHub issue
- Contact the maintainers privately
- Provide a detailed description of the vulnerability
- Allow reasonable time for a fix before public disclosure
We take security seriously and will respond to reports promptly.