---
title: "Deploy Usertour"
description: "Open-source in-app product tours, checklists and surveys, with Postgres"
category: "Other"
url: https://railway.com/deploy/usertour-2
---

# Deploy Usertour

Open-source in-app product tours, checklists and surveys, with Postgres

**[Deploy Usertour on Railway](https://railway.com/template/usertour-2)**

Machine-readable deploy manifest (JSON, validated by TemplateCI): https://railway.com/deploy/usertour-2/manifest.json

- **Creator:** Agaz Self-Host
- **Category:** Other

## Template content

### Postgres https://devicons.railway.app/i/postgresql.svg

- **Image:** ghcr.io/railwayapp-templates/postgres-ssl:17

### Redis https://cdn.sanity.io/images/sy1jschh/production/0ce0bfdcfbdbf69662b1116671f97c2dd788b655-157x157.svg

- **Image:** redis:8.2
- **Start command:** `/bin/sh -c "rm -rf $RAILWAY_VOLUME_MOUNT_PATH/lost+found/ && exec docker-entrypoint.sh redis-server --requirepass $REDIS_PASSWORD --save 60 1 --dir $RAILWAY_VOLUME_MOUNT_PATH"`

### Usertour https://raw.githubusercontent.com/usertour/usertour/v0.9.8/apps/web/public/favicon/favicon-512x512.png

- **Source:** https://github.com/aalfath/usertour-railway-template
- **Health check:** /api/health/ready
- **Public domain:** Yes

## Documentation

# Deploy and Host Usertour on Railway

Usertour is an open-source user onboarding platform. You build in-app product tours, checklists, launchers, banners and surveys in a visual editor, target them by user attributes and events, and add them to any web app with a JavaScript snippet. It tracks views, completions and drop-offs for each flow.

## About Hosting Usertour

This template deploys Usertour 0.9.8 from the official Docker image, pinned by version and digest, with Railway's PostgreSQL and Redis on volumes. The JWT secret, the 2FA encryption key and the database and Redis passwords are generated for each deployment, so nothing needs filling in. Database migrations run on every start, and the health check waits until PostgreSQL and Redis answer. After the deploy finishes, open the public URL right away: the first visitor creates the first System Admin account. Email, image uploads (S3-compatible storage) and GitHub or Google sign-in are optional and are set up by adding variables later.

## Common Use Cases

* Product tours and onboarding checklists for a SaaS app, with the data kept on your own infrastructure
* In-app announcements, banners and NPS or feedback surveys targeted at specific user segments
* Measuring where new users drop out of onboarding and testing changes to the flow

## Dependencies for Usertour Hosting

* PostgreSQL (included, on a volume)
* Redis (included, on a volume)

### Deployment Dependencies

* Usertour source and releases: https://github.com/usertour/usertour/releases
* Self-hosting docs: https://docs.usertour.io/open-source/self-hosting
* Environment variables: https://docs.usertour.io/open-source/env
* Template repository: https://github.com/aalfath/usertour-railway-template

### Implementation Details

The Usertour service builds from the template repository, whose Dockerfile pins `usertour/usertour:0.9.8` by digest and adds a small start script. nginx inside the container listens on port 8080 and serves the dashboard, the SDK and the API; the health check reads `/api/health/ready`. The start script refuses to boot without `JWT_SECRET` or `ENCRYPTION_KEY`, so the app never falls back to its built-in development secrets.

Optional features, added as variables on the Usertour service:

* Email invitations and password resets: `EMAIL_HOST`, `EMAIL_PORT`, `EMAIL_USER`, `EMAIL_PASS`, `EMAIL_SENDER`
* Image uploads: `AWS_S3_REGION`, `AWS_S3_ENDPOINT`, `AWS_S3_ACCESS_KEY_ID`, `AWS_S3_SECRET_ACCESS_KEY`, `AWS_S3_BUCKET`, `AWS_S3_DOMAIN` (any S3-compatible storage)
* Sign-in with GitHub or Google: `GITHUB_AUTH_ENABLED=true` with `GITHUB_CLIENT_ID` and `GITHUB_CLIENT_SECRET`, or the `GOOGLE_` equivalents

If you add a custom domain, set `API_URL` and `APP_HOMEPAGE_URL` to `https://YOUR-DOMAIN`. Never change `ENCRYPTION_KEY` once users have turned on 2FA.

Updates: when a newer Usertour release is pinned in the template repository, Railway shows an update notice on your project and you choose when to apply it. Read the repository's CHANGELOG.md first; migrations run automatically on start.

## Why Deploy Usertour on Railway?


Railway is a singular platform to deploy your infrastructure stack. Railway will host your infrastructure so you don't have to deal with configuration, while allowing you to vertically and horizontally scale it.

By deploying Usertour on Railway, you are one step closer to supporting a complete full-stack application with minimal burden. Host your servers, databases, AI agents, and more on Railway.



## Similar templates

- [Rocky Linux](https://railway.com/deploy/rocky-linux) — Hosted Rocky Linux 9 workspace with SSH and persistent storage. 🚀
- [Foundry Virtual Tabletop](https://railway.com/deploy/X5tR6G) — Self-hosted virtual tabletop for role-playing games (license required)
- [Double Commander in your browser](https://railway.com/deploy/double-commander-in-your-browser) — The Double Commander file manager in the cloud, from any device

Open this page in a browser: https://railway.com/deploy/usertour-2
