System requirements

Docker with the Compose plugin is the only hard requirement. PostgreSQL, Redis, the API and the web app all ship inside the stack, so there is nothing else to install.

What do you need to run asobeast?

Requirement	Value	Why
Docker Engine	Current release with the Compose plugin	Runs every service. `docker compose version` must succeed
Memory	Roughly 2 GB free	Four containers, of which PostgreSQL and the API are the largest
Disk	Roughly 5 GB free	The PostgreSQL volume grows with ranking history. Retention settings bound it
Network	Outbound HTTPS	Store collection runs from this machine
Architecture	`linux/amd64` or `linux/arm64`	Published images are multi architecture

A single instance tracking a handful of apps runs comfortably on the smallest cloud instance most providers sell.

What ships with the stack?

You install none of these separately. Compose pulls or builds all four.

Service	Image	Role
`postgres`	`postgres:18-alpine`	Durable system of record for every app, keyword, position and action item
`redis`	`redis:8-alpine`	BullMQ queue state, which is reconstructible and never needs an application backup
`api`	Built from `apps/api/Dockerfile`	NestJS API, the queue workers and the daily pipeline
`web`	Built from `apps/web/Dockerfile`	Next.js dashboard and the same origin proxy to the API

Published releases replace the two built images with ghcr.io/mradex77/asobeast-api and ghcr.io/mradex77/asobeast-web. See Run a published release.

What do you need only for development?

Working on the source needs the toolchain as well as Docker.

Requirement	Value	Source
Node.js	22 or newer	The images build on `node:24-alpine`
pnpm	10.18.2	`packageManager` in the root `package.json`
Docker	For PostgreSQL and Redis only	`docker-compose.dev.yml`

See Set up a development environment.

Which hosts does asobeast reach?

Every store request runs on the machine that hosts asobeast, so that machine needs outbound HTTPS to the Apple and Google endpoints. There is no asobeast cloud service in the path and no telemetry. A host behind a strict egress policy needs the Apple iTunes endpoints and the Google Play endpoints allowed. Without them imports, ranking checks and scoring jobs fail while the rest of the application keeps serving requests. Outbound connections to your own SMTP relay, your own webhook endpoints and the OpenAI API happen only when you configure those optional features.

Which ports does asobeast publish?

One. The web container publishes 3000 and nothing else is reachable from outside the Docker network.

Port	Service	Published
3000	`web`	Yes, this is the only entry point
4000	`api`	No, private to the Compose network
5432	`postgres`	No, the backend network is marked internal
6379	`redis`	No, the backend network is marked internal

The browser reaches the API through /api/backend/* on the web origin, which forwards to API_INTERNAL_URL. The development Compose file is different on purpose: it publishes 5432 and 6379 so a locally running API can reach them.

Publishing port 3000 to the internet without TLS in front of it sends session cookies in the clear. Terminate TLS at a reverse proxy and set AUTH_COOKIE_SECURE=true.

Get started

Install

Concepts

Guides

Configuration

Operations

Reference

System requirements

What do you need to run asobeast?

What ships with the stack?

What do you need only for development?

Which hosts does asobeast reach?

Which ports does asobeast publish?

Next steps

Self host with Docker Compose

Run a published release

​What do you need to run asobeast?

​What ships with the stack?

​What do you need only for development?

​Which hosts does asobeast reach?

​Which ports does asobeast publish?

​Next steps

Self host with Docker Compose

Run a published release

What do you need to run asobeast?

What ships with the stack?

What do you need only for development?

Which hosts does asobeast reach?

Which ports does asobeast publish?

Next steps