DocumentationArchitecture, operations, every command.
GitHub issuesBugs and feature requests.
Write to uschristian@roessner.email
Before you ask
Many questions are answered in the manual. Good places to start:
- Read-only first diagnosis in the operations guide.
- The protocol reference, including what is not supported.
- The manual pages for every
shardpostctlcommand, with examples and exit codes. - The observability guide for what the metrics and logs mean.
A good bug report
- The ShardPost version (
shardpostctl version) and the Ceph version. - How it runs: Kubernetes with Rook or native, number of replicas, the authentication backend.
- What you did, what you expected and what happened instead, with the protocol commands if a client is involved.
- The relevant log lines. An IMAP protocol trace of one account (shardpostctl-trace(1)) often shows the problem directly.
Mind what you share. Operational logs contain client addresses and account names, and a protocol trace contains what the client sent. Remove passwords, tokens and private data before you post anything in a public issue.
Contributing
ShardPost is free software under the GNU General Public License, version 3 or later; see COPYRIGHT.md. The developer guide describes the code map, the build, the tests and how a change is made. Documentation is written in English, and a change of behaviour updates its documentation and manual page in the same commit.
Contact
ShardPost is developed by Christian Rößner, Rößner Network Solutions. Write to christian@roessner.email in English or German.
Security issues
Please report suspected vulnerabilities privately to christian@roessner.email with “ShardPost security” in the subject, not in a public issue. We will confirm receipt and keep you informed.