BreadcrumbRailway
Railway is the easiest way to deploy Breadcrumb. One click provisions the full stack - the Breadcrumb server, PostgreSQL, and ClickHouse - all wired together and ready to go.
Deploy
Click the button below to deploy Breadcrumb to your Railway account.
This creates three services in a new Railway project:
- Breadcrumb server - the main application
- PostgreSQL - stores projects, users, and API keys
- ClickHouse - stores trace and span data
ClickHouse configuration
The ClickHouse service requires a custom settings prefix for row-level security. The Railway template includes this in the ClickHouse start command:
bash -c 'echo "<clickhouse><custom_settings_prefixes>SQL_</custom_settings_prefixes></clickhouse>" > /etc/clickhouse-server/config.d/custom.xml && /entrypoint.sh'If you're setting up the template yourself, add this as the start command on your ClickHouse service in Railway.
After Deploying
Open your instance
Once the deploy finishes, Railway generates a public URL for the Breadcrumb server. Click it to open the dashboard and create your account.
Create a project
Set up your first project in the dashboard. This is where your traces will be organized.
Get your API key
Go to your project settings to generate an API key. You'll need this to connect the SDK.
Start tracing
Follow the quick start to install the SDK and send your first trace. Set baseUrl to your Railway instance URL.