How do I deploy Railway Assistant on Railway?

You can deploy Railway Assistant on Railway by clicking the "Deploy Now" button on this page. Railway will automatically set up all the necessary services and configurations for you.

What are the system requirements?

Railway handles all the infrastructure requirements. You only need a web browser to deploy and manage your application.

Is this template free to use?

Yes, this template is free to use within your existing Railway account.

Can I customize this template?

Yes, you can fully customize this template. After deployment, you will have full control of what you've deployed in your Railway project.

How do I get support for this template?

You can get support through our community forum: railway-assistant-f3fa3f47, or click "Get template help" for this template for more assistance.

Deploy and Host Railway Assistant on Railway

Railway Assistant is a lightweight webhook relay that sends Railway deployment and project events directly to Telegram. It turns Railway webhooks into clean, readable notifications so you can monitor builds, failures, and releases without constantly checking the dashboard.

Built in Go with zero external dependencies, it’s designed to be fast to deploy, cheap to run, and easy to configure.

About Hosting Railway Assistant

Hosting Railway Assistant means deploying a small stateless HTTP service that listens for Railway webhook events and forwards them to Telegram using a bot.

After deployment, you connect your Railway project’s webhook to the service endpoint. From then on, deployments, failures, and runtime events are automatically formatted and pushed to your chat or team group.

The service is fully environment-variable driven — no database, no setup scripts, and no persistent storage required. Railway handles scaling and availability while the assistant focuses solely on event processing and notification delivery.

Common Use Cases

Deployment Alerts — Know immediately when a deploy succeeds or fails.
Team Notifications — Share production activity automatically in a Telegram group.
Release Visibility — Track branches, commits, and authors during active development.

Dependencies for Railway Assistant Hosting

A Railway project with Webhooks enabled
A Telegram Bot (created via BotFather)
A Telegram chat or group to receive notifications

Deployment Dependencies

Railway Webhooks: https://docs.railway.app/reference/webhooks
Telegram Bot API: https://core.telegram.org/bots/api

Environment Variables

Railway Assistant is configured entirely through environment variables.
Most users only need the required variables — everything else controls message detail.

Required Variables

Variable	When to Use	Description
TELEGRAM_ENABLED	Always	Enables Telegram notifications. Must be true for messages to send.
TELEGRAM_BOT_TOKEN	Always	Token provided by BotFather for your Telegram bot.
TELEGRAM_CHAT_ID	Always	Chat or group ID where alerts will be delivered.
PORT	Railway default	HTTP server port (Railway usually injects this automatically). Default: 8080.

Message Customization (Optional)

These control how much context appears in each notification.
All default to true.

Variable	Use When	Description
INCLUDE_WORKSPACE	Multi-project setups	Shows workspace/project hierarchy.
INCLUDE_STATUS	Always recommended	Displays deployment status (SUCCESS, FAILED, etc.).
INCLUDE_BRANCH	Active development teams	Includes Git branch name.
INCLUDE_COMMIT	Release tracking	Shows commit message.
INCLUDE_AUTHOR	Team environments	Displays commit author.

Disable fields if you want shorter or less noisy alerts.

Example:

INCLUDE_COMMIT=false INCLUDE_AUTHOR=false

Useful for high-frequency deployment environments.

Minimal Example Configuration

TELEGRAM_ENABLED=true TELEGRAM_BOT_TOKEN=your_bot_token TELEGRAM_CHAT_ID=123456789 PORT=8080

Implementation Details (Optional)

Railway Assistant exposes a single webhook endpoint:

POST /railway/alerts

Railway sends event payloads → the service parses them → formats Markdown messages → sends notifications via the Telegram Bot API.

Design goals

zero external dependencies
instant startup
minimal memory usage
production-safe defaults

Roadmap

Railway Assistant is intentionally small today, but planned improvements include:

Slack notifications
Discord integration
Additional messaging platforms
Usage and deployment reports
Smarter alert filtering and routing
Team-level notification policies

The goal is to evolve from a simple notifier into a lightweight Railway operations companion.

Why Deploy Railway Assistant 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 Railway Assistant 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.