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, whether it’s tours, checklists, launchers, or surveys. It’s fully customizable, analytics-ready, and works with all frameworks.

Quick Start

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

Default Login Credentials

• Email: [email protected]
• Password: secret42

Important

• Change the password immediately after first login
• Default configuration does NOT include Email Service or Object Storage
  • ❌ Invitation & user registration emails will not work
  • ❌ Image uploads will not work

To enable these features, configure the required environment variables: 👉 https://docs.usertour.io/open-source/env

Fully Customizable

• Adjust text, button colors, fonts, and size to match your branding
• Support multiple themes for different flows

Framework & Environment Support

• Compatible with all browser apps (SPA & multi-page)
• Advanced targeting using user attributes and events
• Multiple environments supported (Production, Staging)
• Version tracking: see who changed what and when

Analytics & Insights

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

Deploy and Host

Railway handles deployment automatically.
This template provisions the Usertour app along with its required services.

About Hosting

When you host Usertour yourself:

• You retain full control of your data
• You are responsible for infrastructure and backups
• AGPL v3 license applies to self-hosted usage

Why Deploy

Self-hosting Usertour is ideal if you need:

• Data sovereignty and privacy
• No vendor lock-in
• Custom domains and private networking
• Full control over scaling and uptime

Common Use Cases

• Privacy-sensitive SaaS products
• Internal tools and enterprise dashboards
• Onboarding flows tightly integrated with internal systems
• Environments isolated from public SaaS services

Dependencies for Self-Hosting

The Railway template automatically provisions core services.
For self-hosted or production environments, Usertour requires:

• PostgreSQL — primary database
• PgBouncer — database connection pooling
• Redis — caching and background jobs

Additional required integrations:

• Email Service — required for invitations and registration
• AWS S3 or S3-compatible storage — required for image uploads

Environment variables reference: 👉 https://docs.usertour.io/open-source/env

Deployment Dependencies

In Railway, service startup and health checks are handled automatically.
The Usertour application waits for PostgreSQL, PgBouncer, and Redis to become available before starting.