fibermeter

FiberMeter documentation

This directory contains the product, integration, deployment, and operations documentation for FiberMeter. Start with the path that matches what you are trying to do.

Choose a path

Goal	Start here	Continue with
Understand FiberMeter	Overview	Architecture
Run it locally	Quickstart	Demo walkthrough
Integrate a service	API reference	JavaScript SDK, Webhooks
Operate real Fiber settlement	Fiber integration	Hosted live demo
Understand product capabilities	Product guide	Demo walkthrough, Hosted live demo
Plan future work	Roadmap summary	Maintained roadmap

Documentation index

Product and setup

1. FiberMeter overview — product scope, working capabilities, payment modes, and remaining production hardening.
2. Architecture — provider boundary, billing engine, and hosted payee/payer topology.
3. Quickstart — local setup with or without Docker, database initialization, seed data, and application startup.

Developer integration

1. API reference — REST authentication, payment modes, and live-provider API boundaries.
2. JavaScript SDK — installation, API-key and JWT clients, usage metering, customers, balances, payment requests, errors, and idempotency.
3. Webhooks — delivery headers, HMAC verification, timestamp policy, failure inspection, and retry behavior.

Demonstration and Fiber operations

1. Demo walkthrough — guided dashboard, funding, metering, ledger, and webhook flow.
2. Fiber integration — simulated and live providers, node configuration, RPC boundaries, channels, and settlement verification.
3. Roadmap summary — current delivery status and links to the actively maintained project roadmap.
4. Product guide — product positioning, supported flows, current capabilities, technical architecture, and product boundaries.

Hosted deployment and transfer notes

• Hosted live demo — persistent testnet deployment, auto-payer flow, and on-chain channel-funding evidence.
• PayReady transfer — provenance and integration map for the operator-facing Fiber preflight diagnostics.
• Native Ubuntu deployment — reusable systemd, PostgreSQL, Nginx, and native Fiber-node deployment guide.

Supporting material

• Screenshot catalog — maintained dashboard and demo captures used by the project documentation.
• Repository README — project entry point, feature summary, and common commands.
• Project roadmap — phased implementation and hardening plan.

Documentation conventions

• Examples use http://localhost:4000 as the API origin unless a hosted URL is explicitly required. The JavaScript SDK appends /api itself.
• Monetary values are decimal strings. Avoid floating-point arithmetic for accounting and settlement logic.
• API keys, dashboard JWTs, node credentials, and webhook secrets are server-side secrets and must not be embedded in browser bundles.
• Simulated mode is the default local path. Live-mode instructions are marked explicitly and require funded Fiber nodes and an available channel.

This site is open source. Improve this page.