Usertour is an open-source user onboarding platform. Create in-app product tours, checklists, and surveys in minutes—effortlessly and with full control.

🌐 Official Website | 📖 Documentation | 💻 GitHub Repository

Features

Usertour helps you build in-app onboarding flows fast — including tours, checklists, launchers, and surveys. Fully customizable, analytics-ready, and framework-agnostic.

Quick Start

This Railway template is ready to run with default settings. Just deploy and start exploring Usertour immediately.

Important

• Default configuration does NOT include Email Service or Object Storage
  • ❌ Invitation & user registration emails will not work
  • ❌ Image uploads will not work

Configure required environment variables:
👉 https://docs.usertour.io/open-source/env

⚠️ First-Time Setup

After deployment, you must create the initial admin account immediately:

👉 https://docs.usertour.io/open-source/system-admin#first-time-setup

• The first registered user becomes the admin
• Until this is done, the instance is not secured
• Anyone with access to the URL can take control

Recommended:

• Open your instance right after deploy
• Create the admin account before sharing the URL
• (Optional) Restrict access during setup

⚠️ Do not expose your instance publicly before completing admin setup.

Fully Customizable

• Customize text, colors, fonts, and layout
• Multiple themes supported

Framework & Environment Support

• Works with all browser apps (SPA & multi-page)
• Target users via attributes and events
• Supports multiple environments (Prod / Staging)
• Built-in version tracking

Analytics & Insights

• Track views, completions, and drop-offs
• Identify weak steps and improve onboarding

Deploy and Host

Railway provisions Usertour with required services automatically.

About Hosting

When self-hosting:

• Full data ownership
• No vendor lock-in
• You manage infra and backups
• AGPL v3 applies

Common Use Cases

• Privacy-sensitive SaaS
• Internal tools
• Enterprise dashboards
• Isolated environments

Dependencies

Required:

• PostgreSQL
• PgBouncer
• Redis

Additional:

• Email Service (for invitations)
• S3-compatible storage (for uploads)

Env setup:
👉 https://docs.usertour.io/open-source/env