English
Ferry documentation
Start and operate
| Task | Guide |
|---|---|
| Install, initialize and send a first request | Docker installation |
| Change models without reconfiguring clients | Logical models |
| Connect Hermes to existing accounts | Hermes Agent |
| Redeem expiring Codex reset credits | AutoReset |
| Understand behavior and limitations | Frequently asked questions |
| Diagnose a failed or stalled request | Troubleshooting |
| Back up, restore and upgrade | Docker maintenance |
| Import accounts and client keys | sub2api / CLIProxyAPI import |
| Report a bug or propose a change | Contributing |
| Change code and run checks | Development |
| Report a vulnerability privately | Security policy |
These guides have separate Chinese and English editions. GitHub issue forms and the PR template accept either language; you do not need to submit both.
Detailed references
Some detailed references are currently in Chinese. Their language is identified below rather than presenting them as fully translated.
| Reference | Scope | Language |
|---|---|---|
| Long tasks | Recovery routes, budgets and verification | Chinese |
| Configuration | Models, connections, routes and identities | Chinese |
| Client APIs | Chat, Responses, Messages, streaming and images | Chinese |
| Agent Skill | Setup, dedicated identities and controlled changes | Chinese |
| Provider coverage | Authentication and verification boundaries | Chinese |
| Protocol fidelity | Preserved, translated and rejected fields | Chinese |
| Provider adapters | Authentication, translation and provider boundaries | Chinese |
| Native drivers | Login, refresh and driver limitations | Chinese |
| Migration | Existing SmartAPI data and client migration | Chinese |
| Third-party notices | Dependencies and licenses | Chinese |
Website source and preview instructions are in Chinese. The product website itself supports English and Chinese. The public website is hosted on GitHub Pages with HTTPS.
Codex usage protection: default 98% threshold, paid Credits off, response quota evidence reused before fetching usage.