Web

Prerequisites

Before you begin the installation process, ensure that your system meets the following requirements:

Operating System: Anything that supports Node.js >=20
IP Connection to the stardustd nodes, which should already be setup. You should also have the authentication token for them.
A way to expose an HTTP server to the internet. This can be done with a reverse proxy like Nginx or Caddy, or just directly.
A PostgreSQL database. You can use docker to set one up by running:
docker run --name stardust-postgres -p 5432:5432 -e POSTGRES_PASSWORD=replaceme -d postgres

Installation

Config file

Create the app configuration file.

~/.config/stardust.yaml

port: 3000
databaseUrl: "postgresql://postgres:example@localhost/postgres"
nodes:
  - hostname: localhost
    id: default
    port: 4000
    # Should be in the `stardustd` configuration file.
    token: idkbruh
auth:
  # Anything random, `openssl rand -hex 32` for example.
  secret: idkbruh
  credentials:
    enabled: true
    signups: true
# yaml-language-server: $schema=/opt/stardust/packages/config/schema.json

Configure

Prop	Type	Default
`hostname`	`string`	`0.0.0.0`
`port`	`number`	`3000`
`databaseUrl`	`string`	-
`metadataUrl`	`string`	-
`nodes`	`NodeConfig[]`	-
`auth`	`AuthConfig`	-
`session`	`SessionConfig`	-

Keys

Prop	Type	Default
`id`	`string`	-
`hostname`	`string`	`0.0.0.0`
`proto`	`"http" \| "https"`	`http`
`port`	`number`	`4000`
`token`	`string`	-

Setup the database

pnpm --dir packages/db run drizzle-kit push

Setup workspaces

pnpm --dir packages/db run seed
pnpm --dir workspaces run build # builds docker images

Build

Build the Stardust app.

cd apps/web
pnpm build

Start

pnpm start

An example systemd service file is provided below:

/etc/systemd/system/stardust.service

[Unit]
Description=Stardust SystemD service
After=docker.service # add `postgresql.service` if using a local database
[Service]
# Where GitHub repository is cloned
WorkingDirectory=/opt/stardust/apps/web
DynamicUser=yes
NoNewPrivileges=yes
# if using docker container
ExecStartPre=docker start stardust-postgres
# might be different, run `which pnpm`
ExecStart=/usr/bin/pnpm start
Restart=on-failure
RestartSec=5
User=ubuntu
[Install]
WantedBy=multi-user.target

Web

Keys

On this page