Quick Start

In this tutorial, we will be running wormholes in unified mode. In production environment, it's recommended to run in distributed mode.

Running databases

We use PostgreSQL for storing links and user data, TimescaleDB for analytical events and Redis as cache. Our first step will be to start our databases and redis.

Running PostgreSQL

$docker run -d -e POSTGRES_PASSWORD=postgres -p 5432:5432 --name postgres postgres:15-alpine

Running TimescaleDB

$docker run -d -e POSTGRES_PASSWORD=postgres -p 5433:5432 --name timescale timescale/timescaledb:latest-pg15

Running Redis

Let's populate our config first. Add following to conf/redis.conf.

1# set max memory2maxmemory 1gb3# evict least recently used keys4maxmemory-policy allkeys-lru

Now, let's run redis with above config.

$docker run -d -p 6379:6379 -v ./conf:/usr/local/etc/redis --name redis redis:7-alpine

Running wormholes

$docker run -d -p 5000:5000 ghcr.io/noquark/wormholes:latest

Now, wormholes should be running on port 5000.