Community support

Get help

Choose the right channel, then include the version, environment, reproduction steps, and sanitized logs so the community can understand the problem.

Choose a channel by issue type

Usage questions(opens in a new tab)Ask installation, configuration, or operating-mode questions in the Q&A category of GitHub Discussions. Mark the best answer after resolving the question.Reproducible bugs(opens in a new tab)Submit a GitHub Issue with the Bug template and include the version, system, architecture, and sanitized logs.Feature requests(opens in a new tab)Use the Feature Issue template for a defined request, or discuss an early idea in the Ideas category first.Platform adaptation requests(opens in a new tab)Use the Platform Issue template to request a new deployment target or upstream service.

Commercial deployment and delivery support

Community support is best effort. For commercial licensing, production deployment, migration, or ongoing delivery support, review the clmBot solution partner directory and choose a channel that fits your region and service needs.

How to ask a question that is easy to answer

A good question does not need to be long, but it must explain the environment, reproduction path, and what you have already tried. Use this order:

  1. One-sentence title: name the action and result, such as "discover-certificate finds no Nginx certificate on Linux amd64";
  2. Goal: explain what you want clmbot to accomplish;
  3. Environment: clmbot version, operating system, CPU architecture, web service, and operating mode;
  4. Steps: list commands and necessary sanitized configuration in order;
  5. Expected and actual results: keep them separate instead of posting an undifferentiated log;
  6. What you tried: link relevant documentation and state the result of each attempt.

Community responses are best effort and have no fixed response time. If an answer works, mark it and add the final resolution so future users can reuse it.

Report a security vulnerability

Do not report vulnerabilities publicly

Do not post security vulnerabilities in public Issues or Discussions. Public disclosure can expose every unpatched user.

Use a private reporting channel:

  • Security email: security@clmbot.org
  • GitHub Private Vulnerability Reporting, when "Report a vulnerability" is available on the repository Security page.

Include the affected version, sanitized reproduction steps, and an impact assessment. See the security documentation for the complete process.

Checklist before submitting

Confirm each item before using any channel:

  1. Search first: search Discussions and Issues to avoid duplicate reports;
  2. Confirm the version: state the clmbot version, such as v0.6.6, and verify that the problem still exists in the latest release;
  3. Sanitize logs: remove AccessKey, AccessSecret, private keys, PFX passwords, sensitive config.yaml fields, internal IPs and hostnames, customer identifiers, complete certificates, and command history containing credentials;
  4. Provide environment details: operating system and version, CPU architecture, and operating mode;
  5. Provide commands and configuration: include the command and relevant sanitized configuration;
  6. Separate expected and actual results: explain both clearly.