Logister Documentation Self-hosting
Documentation / Self-hosting

Run Logister yourself.

Use this page as the operator entry point. It covers the first local boot and then routes you into the more focused guides for day-to-day development, deploy configuration, and ClickHouse.

Guide overview

Use this guide when you want to run the Logister app yourself.

Logister is a Rails app with PostgreSQL for control-plane data, Redis for jobs and cache, and optional ClickHouse for higher-scale analytics querying.

Prerequisites

What you need before booting the app.

  • Ruby 4.0.1
  • PostgreSQL >= 14
  • Redis >= 7
  • Optional ClickHouse if you want a dedicated analytics store

Local quickstart

Start the app locally.

shell 
git clone https://github.com/taimoorq/logister.git
cd logister
cp .env.sample .env
bundle install
bin/rails db:prepare
bin/dev

Tip

bin/dev also watches Tailwind locally and attempts to ensure Redis is available.

Docs map

Use the focused guides instead of one giant deployment checklist.

Local development

Boot, seed, and verify the app locally

Use this for bin/dev, Docker-backed infra, seeds, and local verification.

Read local development docs

Deployment config

Set production variables and provider config

Use this for environment variables, Turnstile, analytics, SendGrid, and deployment files.

Read deployment config docs

ClickHouse

Enable dedicated analytics storage

Use this when you want the optional ClickHouse path, schema setup, and event-column mapping.

Read ClickHouse docs

What you need

Keep the deployment primitives clear before tuning extras.

  • PostgreSQL for users, projects, API keys, and app state
  • Redis for Sidekiq and app caching
  • A production secret store for Rails and provider credentials
  • A deployment method such as Fly, Kamal, or a custom Docker-based workflow
  • Optional ClickHouse if you need dedicated analytics scale

Verify deploy

Check the app before you start sending production traffic.

Deployment verification
Web app responds successfully
Background jobs can start
Project creation works
API key creation works
A test event appears in the project inbox