Home Docs Schema Formats Errors

Core

Philosophy Getting Started Roadmap

Formats

Formats ▶
Overview JSON XML YAML TOML NDJSON CSV CBOR

Configuration

Configuration ▶
Overview Server Settings Database Settings Policy Settings Authorization Overview Static Config Auth Environment Auth Database Auth

API Reference

API Reference ▶
Schema API CRUD API Validation Pagination

Architecture

Architecture ▶
Overview High-Level Flow Multi-Format Engine Database Drivers Error System

Errors

Errors ▶
Error Index 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 405 Method Not Allowed 409 Conflict 415 Unsupported Media Type 422 Unprocessable Entity 429 Too Many Requests 500 Internal Server Error 501 Not Implemented 503 Service Unavailable

Getting Started

Your first Conduit server in minutes

Conduit ships with sensible defaults: SQLite as the database driver and no authorization required. This makes it easy to get started quickly without configuration.

Clone and Build

Download the Conduit source and build the server binary:

git clone https://github.com/untappedtech/conduit
cd conduit
go build -o conduit ./cmd/server

You now have a conduit binary ready to run.

Running Conduit

Using the compiled binary

./conduit --config ./config.yaml

Using go run

go run ./cmd/server --config ./config.yaml

Command-Line Flags

-c/--config <path>

Specifies the location of the configuration file (JSON, XML, YAML, or TOML).

-g/--generate-config <type>

Generates a starter configuration file of the given type.
Supported types: json, xml, yaml, toml. 

./conduit --generate-config yaml

Your First Request

With the server running, query the schema:

GET http://localhost:8080/v1/schema

This returns the list of tables known to Conduit. If your database is empty, you can create tables using the Schema API.