relaytools: relaycreator

Relay creator is a NextJS application that is part of the relaytools stack. It provides a UI and API for creating #nostr relays.

Getting Started

Pre-requirements

You'll need to use pnpm with this project

Installing pnpm

sudo npm install -g pnpm

Checkout sources and install the packages

git clone https://github.com/relaytools/relaycreator
cd relaycreator
pnpm install

Setting up your environment

cp env.develop .env

Optional: disabling new relay signups (migration mode)

If you are sunsetting an installation, you can disable new relay signups without affecting existing relays. All of these flags default to OFF — with nothing set, signups work exactly as before.

# Hides the create-relay UI and blocks the creation API.
NEXT_PUBLIC_SIGNUPS_DISABLED=true
# Optional: promote a successor site (landing hero + CTA links).
NEXT_PUBLIC_MIGRATION_URL=https://example.com
NEXT_PUBLIC_MIGRATION_NAME=Example

Note: NEXT_PUBLIC_* variables are baked in at build time, so flipping them requires a rebuild and restart. SIGNUPS_DISABLED=true is a server-only override that blocks the creation API immediately on restart, without a rebuild. When signups are disabled, existing relays continue to operate: topups/renewals, client membership payments, and NIP-05 orders all keep working, and pending orders created before the cutoff can still be paid.

Prisma ORM setup

This application requires MySQL and prisma ORM.

How migrations work with prisma

We will setup the full dev environment in order to develop migrations locally if desired.

Example: Edit the .env file to add MySQL connection string(s)

DATABASE_URL="mysql://creator:creator@127.0.0.1:3306/creator"
SHADOW_DATABASE_URL="mysql://creator:creator@127.0.0.1:3306/creatorshadow"

Example: Create these databases and user on your MySQL server

create database creator;
create database creatorshadow;
GRANT ALL PRIVILEGES ON creator.* TO 'creator'@'%' IDENTIFIED BY 'creator';
GRANT ALL PRIVILEGES ON creator.* TO 'creator'@'%' IDENTIFIED BY 'creator';
FLUSH PRIVILEGES;

Deploy the current migrations:

pnpm prisma:migrate

Build and start

Run the development server:

pnpm run dev

Build and run in production mode:

pnpm run build
pnpm start

Open http://localhost:3000 with your browser to see the result.