Skip to content

docs(readme): add one-click Railway self-host option #1155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dillonstreator wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

docs(readme): add one-click Railway self-host option #1155

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2aa3cd3
docs(readme): add one-click Railway self-host deploy option
dillonstreator Jul 25, 2026
c296ef5
docs(readme): drop referralCode from Railway deploy links
dillonstreator Jul 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,14 @@ Learn more <a href="https://docs.maxun.dev/robot/search/search-introduction">her
### Getting Started
The simplest & fastest way to get started is to use the hosted version: https://app.maxun.dev.

### One-Click Self Host (Railway)

Deploy Maxun on Railway with a prewired multi-service stack (nginx gateway, frontend, backend, remote Chromium, PostgreSQL, and MinIO):

[![Deploy on Railway](https://railway.com/button.svg)](https://railway.com/deploy/maxun?utm_medium=integration&utm_source=button&utm_campaign=maxun)

After deploy, open only the **gateway** public URL so the UI and API share one origin (required for Maxun's httpOnly auth cookie). Optional `ANTHROPIC_API_KEY` / `OPENAI_API_KEY` unlock AI mode.

### Installation
Maxun can run locally with or without Docker
1. [Setup with Docker Compose](https://docs.maxun.dev/installation/docker)
Expand All @@ -125,9 +133,10 @@ Maxun can run locally with or without Docker
4. [SDK](https://github.com/getmaxun/node-sdk)

### Upgrading & Self Hosting
1. [Self Host Maxun With Docker](https://docs.maxun.dev/self-host)
2. [Upgrade Maxun With Docker Compose Setup](https://docs.maxun.dev/installation/upgrade#upgrading-with-docker-compose)
3. [Upgrade Maxun Without Docker Compose Setup](https://docs.maxun.dev/installation/upgrade#upgrading-with-local-setup)
1. [One-Click Self Host on Railway](https://railway.com/deploy/maxun?utm_medium=integration&utm_source=button&utm_campaign=maxun)
2. [Self Host Maxun With Docker](https://docs.maxun.dev/self-host)
3. [Upgrade Maxun With Docker Compose Setup](https://docs.maxun.dev/installation/upgrade#upgrading-with-docker-compose)
4. [Upgrade Maxun Without Docker Compose Setup](https://docs.maxun.dev/installation/upgrade#upgrading-with-local-setup)

## Features

Expand Down