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

# Nudgra OSS overview

> Understand the self-hosted Nudgra distribution and its setup requirements.

Nudgra OSS is the self-hosted distribution of Nudgra. You run the app server, Postgres database, OAuth routes, Meta webhooks, background jobs, HTTPS, and backups yourself.

Use this distribution when you want ownership over infrastructure and data.

<Card title="View Nudgra OSS on GitHub" icon="github" href="https://github.com/MaikoCode/nudgra-oss">
  Open the self-hosted source repository.
</Card>

## Stack

* TanStack Start.
* Better Auth.
* Hono.
* Drizzle.
* pg-boss.
* Postgres.
* Docker and Caddy for the recommended production deployment.

## What you need

For local development:

* Git.
* Node.js 24 or newer.
* Docker, or another Postgres database.
* A Google account.
* A Meta Developer account.
* An Instagram professional account.

For production:

* A VPS.
* A domain or subdomain.
* Docker.
* HTTPS through Caddy or another reverse proxy.

## Important URLs

Replace `https://your-domain.com` with your production domain.

| Purpose                   | URL                                                |
| ------------------------- | -------------------------------------------------- |
| App                       | `https://your-domain.com`                          |
| Health check              | `https://your-domain.com/api/v1/health`            |
| Google OAuth redirect URI | `https://your-domain.com/api/auth/callback/google` |
| Meta OAuth redirect URI   | `https://your-domain.com/api/meta/callback`        |
| Meta webhook callback URL | `https://your-domain.com/api/meta/webhooks`        |

## Setup path

1. Run [local development](/oss/local-development).
2. Configure [environment variables](/oss/environment-variables).
3. Configure [Google OAuth](/shared/google-oauth).
4. Configure [Meta / Instagram setup](/shared/meta-instagram-setup).
5. Deploy to a [VPS with Docker Compose and Caddy](/oss/deploy-vps).