Skip to content

ferro-labs/docs

Repository files navigation

Ferro Labs AI Gateway — Documentation

CI Deploy

Official documentation site for Ferro Labs AI Gateway — the open-source, OpenAI-compatible LLM proxy supporting 19 providers, 2,500+ models, 11 safety plugins, and MCP tool-calling.

Live at docs.ferrolabs.ai

Built with Docusaurus 3, React 19, and TypeScript.


What's in here

Section Description
Getting Started Quickstart, architecture, concepts, configuration
Guides Providers, routing, plugins, MCP, auth, observability
Operations Monitoring, request logging, server settings
Security Data handling, secrets, credential isolation
SDKs Python, Node.js, Go, LangChain, LlamaIndex
API Reference Interactive OpenAPI reference (Scalar)
FAQ Common questions and answers

Running locally

Requirements: Node.js 20+, pnpm 9+

# Install dependencies
pnpm install

# Start dev server at http://localhost:3000
pnpm start

# Production build — validates all internal links
pnpm build

# TypeScript typecheck
pnpm typecheck

Contributing

Contributions are welcome — typo fixes, code sample improvements, new guides. See CONTRIBUTING.md to get started and CODE_OF_CONDUCT.md for community standards.

PRs should target the development branch.


Related repos

Repo Description
ferro-labs/ai-gateway The OSS gateway — providers, routing, plugins
ferro-labs/docs This repo

License

Documentation content is licensed under Apache 2.0, the same as the gateway itself.

About

Ferro Labs Documents

Topics

Resources

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors