Skip to main content
Alpha Software: Not Production ReadyStellarStack is in active development and should NOT be used in production environments. Expect breaking changes, incomplete features, and potential security vulnerabilities.

​
Prerequisites

Before installing StellarStack, ensure you have the following installed:

​
Installing pnpm

If you don’t have pnpm installed, you can install it globally: 
npm install -g pnpm

​
Development Installation

For local development and testing, follow these steps:
1

Clone the repository

Clone the StellarStack repository from GitHub:
git clone https://github.com/StellarStackOSS/StellarStack.git
cd StellarStack
2

Install dependencies

Install all project dependencies using pnpm:
pnpm install
This will install dependencies for all packages in the monorepo.
3

Set up environment variables

Copy the example environment files:
cp apps/api/.env.example apps/api/.env
cp apps/web/.env.example apps/web/.env
Edit the .env files with your configuration. At minimum, you need to configure:apps/api/.env:
DATABASE_URL="postgresql://stellar:stellarpass@localhost:5432/stellar"
apps/web/.env:
# Optional: Cloudflare Turnstile for CAPTCHA
NEXT_PUBLIC_TURNSTILE_SITE_KEY=
TURNSTILE_SECRET_KEY=
The DATABASE_URL should point to your PostgreSQL instance. Update the username, password, host, port, and database name as needed.
4

Initialize the database

Set up the database schema:
cd apps/api
pnpm db:push
pnpm db:generate
cd ../..
This creates the necessary tables and generates the Prisma client.
5

Start the development servers

Start both the API and web panel in development mode:
pnpm dev
The services will be available at:

​
Production Installation (Ubuntu)

For production deployments on Ubuntu 22.04 or higher, use the automated installer:
1

Run the installer script

Execute the one-command installer:
curl -sSL https://raw.githubusercontent.com/StellarStackOSS/StellarStack/master/install-script.sh | sudo bash
The installer will:
  • Install Docker and Docker Compose
  • Set up PostgreSQL database
  • Deploy API and web containers
  • Configure nginx as a reverse proxy
  • Optionally set up SSL via Certbot
2

Follow the installation prompts

The installer will ask for:
  • Installation type (panel + API, panel only, API only, or daemon)
  • Domain names for the panel and API
  • SSL certificate setup (recommended for production)
  • Database credentials
Write down the database credentials provided during installation. You’ll need them for configuration.
3

Verify the installation

Once complete, the installer will display:
  • URLs for accessing the panel and API
  • Default admin credentials (if created)
  • Installation directory (/opt/stellarstack)
Access your panel at the domain you configured during installation.

​
Docker Compose Installation

For self-hosting with Docker Compose:
1

Clone the repository

git clone https://github.com/StellarStackOSS/StellarStack.git
cd StellarStack
2

Configure environment

cp .env.example .env
# Edit .env with your secrets and configuration
3

Start services

docker-compose up -d
4

Create admin user (optional)

docker exec stellarstack-api pnpm db:seed

​
Next Steps

Quick Start

Get up and running with your first login

Configuration

Learn about environment variables and settings

Build docs developers (and LLMs) love

Get started for freeTalk to us