runfabric

Docs

Start here for RunFabric user and developer documentation.

• Hosted docs site: https://runfabric.github.io/runfabric/

User guides

• Quickstart: QUICKSTART.md
• CLI commands: COMMAND_REFERENCE.md
• Config reference: RUNFABRIC_YML_REFERENCE.md
• Credentials: CREDENTIALS.md
• Provider setup: PROVIDER_SETUP.md
• Deploy by provider: DEPLOY_PROVIDERS.md
• State backends: STATE_BACKENDS.md
• Router operations runbook: ROUTER_OPERATIONS_WORKFLOW.md
• Router plugin authoring: ROUTER_PLUGIN_AUTHORING.md
• Troubleshooting: TROUBLESHOOTING.md
• Testing: TESTING_GUIDE.md
• Examples matrix: EXAMPLES_MATRIX.md

Core + internals

• Contributing: ../CONTRIBUTING.md
• Architecture: ARCHITECTURE.md
• Build & release: BUILD_AND_RELEASE.md

Extensions + plugins + registry

• Plugins (hooks): ../apps/registry/docs/PLUGINS.md
• Extension development guide: ../apps/registry/docs/EXTENSION_DEVELOPMENT_GUIDE.md
• Addon contract: ../apps/registry/docs/ADDON_CONTRACT.md
• Registry implementation guide: ../apps/registry/docs/EXTENSION_REGISTRY_IMPLEMENTATION_GUIDE.md
• Registry development: ../apps/registry/docs/REGISTRY_DEVELOPMENT.md
• Registry MVP spec (API + DB): ../apps/registry/docs/REGISTRY_API_DB_SCHEMA_MVP.md
• Registry security + DDoS: ../apps/registry/docs/REGISTRY_SECURITY_DDOS_PRODUCTION_GUIDE.md

SDKs + handlers

• SDK frameworks: SDK_FRAMEWORKS.md
• Handler scenarios: HANDLER_SCENARIOS.md

This site is open source. Improve this page.