> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ogis.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Generate beautiful Open Graph images via URL. No design skills required.

<img src="https://img.ogis.dev/?template=gradient-storm&title=Open%20Graph%20Images&subtitle=Made%20Simple&description=Generate%20beautiful%20social%20images%20in%20milliseconds&logo=https://ogis.dev/logo-light.png" alt="OGIS Example" />

## What is ogis?

ogis is a high-performance Rust service that generates [Open Graph images](https://ogp.me/) by rendering SVG templates to PNG via HTTP API.

<CardGroup cols={2}>
  <Card title="Get Started" icon="rocket" href="/getting-started">
    Generate your first image in under a minute
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/overview">
    Explore the API endpoints
  </Card>

  <Card title="Self-Hosting" icon="server" href="/self-hosting">
    Deploy your own instance
  </Card>
</CardGroup>

## Features

* **High Performance** — Built in Rust for speed and reliability
* **SVG Templates** — Customizable templates with placeholder support
* **Image Caching** — In-memory caching for fast response times
* **SSRF Protection** — Blocks private IP addresses for security
* **HMAC Authentication** — Optional signature-based authentication
* **Docker Ready** — Easy deployment with Docker

## Templates

<CardGroup cols={3}>
  <Card title="twilight">
    <img src="https://img.ogis.dev/?template=twilight&title=Dark%20%26%20Bold&subtitle=Default%20Template&description=Perfect%20for%20tech%20content" alt="Twilight" />
  </Card>

  <Card title="daybreak">
    <img src="https://img.ogis.dev/?template=daybreak&title=Light%20%26%20Fresh&subtitle=Morning%20Vibes&description=Clean%20and%20professional" alt="Daybreak" />
  </Card>

  <Card title="minimal">
    <img src="https://img.ogis.dev/?template=minimal&title=Simple%20%26%20Clean&subtitle=Minimalist&description=Ultra-clean%20layout" alt="Minimal" />
  </Card>
</CardGroup>

## Quick Example

No SDK needed — just construct a URL:

```html theme={null}
<meta property="og:image" content="https://img.ogis.dev/?title=Hello%20World&template=twilight" />
<meta property="og:image:width" content="1200" />
<meta property="og:image:height" content="630" />
```

Or use the TypeScript SDK:

```typescript theme={null}
import { OgisClient } from 'ogis';

const ogis = new OgisClient({ baseUrl: 'https://img.ogis.dev' });

const imageUrl = ogis.generateUrl({
  title: 'My Blog Post',
  description: 'An introduction to ogis',
  template: 'twilight'
});
```