Installation

This guide covers the different ways to install and run Stowaway.

Requirements

The easiest way to run Stowaway is with Docker Compose.

git clone https://github.com/rennerdo30/stowaway.git
cd stowaway

Create a .env file with your settings:

cp .env.example .env

Edit .env and set a secure AUTH_SECRET:

AUTH_SECRET="your-secure-random-string-here"

Tip: Generate a Secure Secret Use OpenSSL to generate a secure secret:
Terminal window
openssl rand -base64 32

docker-compose up -d

Open http://localhost:3000 in your browser.

For development or custom deployments, you can run Stowaway directly with Node.js.

git clone https://github.com/rennerdo30/stowaway.git
cd stowaway

npm install

cp .env.example .env

Edit .env with your configuration:

DATABASE_URL="file:./dev.db"
AUTH_SECRET="your-secure-random-string-here"
AUTH_URL="http://localhost:3000"

npx prisma migrate deploy

npm run build
npm start

Open http://localhost:3000 in your browser.

For active development with hot reloading:

npm run dev

This starts the development server with automatic recompilation on file changes.