Docs

Introduction

Deploy Grovs on your own infrastructure for full control over your data and configuration.

Grovs is fully self-hostable. Run the entire platform — backend, dashboard, and link redirects — on your own infrastructure.

Architecture overview

A self-hosted Grovs deployment consists of three components:

ComponentTechnologyPurpose
BackendRuby on RailsAPI server, link redirects, SDK endpoints, background jobs
DashboardNext.jsWeb interface for managing links, campaigns, and analytics
Database & CachePostgreSQL + RedisData storage and job queues

The backend uses subdomain-based routing to handle different types of requests:

  • api.yourdomain.com — Dashboard API (OAuth2 authentication)
  • sdk.yourdomain.com — Mobile SDK endpoints
  • go.yourdomain.com — Short link redirects
  • preview.yourdomain.com — Link preview pages

Guides

Follow these guides in order to get your self-hosted instance running:

  1. Backend Setup — Deploy the API server, database, and background workers
  2. Dashboard Setup — Deploy the web dashboard and connect it to your backend
  3. SDK Configuration — Point the mobile SDKs to your self-hosted backend

Requirements

  • A server or VM with Docker and Docker Compose installed
  • A domain name with the ability to configure DNS records (subdomains)
  • PostgreSQL 16 and Redis 6+ (included in the Docker Compose setup)

The fastest way to get started is with Docker Compose — it bundles the backend, database, Redis, and all background workers in a single command.