Quick Start

Prerequisites

• Docker 20.10+ and Docker Compose v2
• Git
• 2 GB RAM and 5 GB disk space (4 GB RAM and 10 GB disk recommended)

1. Clone the repository

git clone https://github.com/NetSendo/NetSendo.git
cd NetSendo

2. Create the configuration file

cp .env.example .env

Create .env before starting the containers, otherwise Docker creates a folder in its place. Set a strong DB_PASSWORD. An empty APP_KEY is generated on first start.

3. Start with Docker Compose

docker compose up -d

This pulls the ghcr.io/netsendo/netsendo image and starts the application, queue worker, scheduler, Reverb WebSocket server, Nginx, MySQL 8, Redis 7 and Mailpit for test emails.

4. Open NetSendo and activate a license

Open your browser and navigate to:

1. Register the administrator account.
2. On the license page choose SILVER (free) or GOLD.
3. Enter your email address and the license is activated automatically.

Mailpit, which catches test emails, runs at http://localhost:5031. The full guide is in DOCKER_INSTALL.md.