Skip to content

Quick Start

Get OpenWard up and running in just a few minutes.

Clone the Repository

git clone https://github.com/useopenward/openward.git
cd openward

Build OpenWard

go build -o openward ./cmd

Start the Server

./openward

On first startup, OpenWard automatically initializes its SQLite database and applies any required migrations.

Create Your First Project

Coming Soon

The project management dashboard and REST API are currently under development. Once available, you'll be able to create projects, configure upstream services, and manage rate limits through the embedded web interface.

How It Works

Instead of calling your upstream API directly, route requests through OpenWard.

Client
    │
    ▼
OpenWard
    │
    ▼
Upstream API

OpenWard authenticates the request using its own generated API key, applies the configured rate limit, logs the request, and forwards it to the upstream service.

Next Steps

  • Learn about OpenWard's philosophy and architecture in the About page.
  • Follow the project on GitHub:

Repository: https://github.com/useopenward/openward