Available Templates
FalkorDB offers two verified deployment templates on Railway. Choose the template that matches your workload:Prerequisites
Before deploying FalkorDB on Railway, ensure you have:- A Railway account
- Basic understanding of FalkorDB and graph databases
- A Redis-compatible client, such as
redis-cli, for command-line testing
Option 1: Single Instance Deployment
Deploy the Template
- Visit the FalkorDB Single Instance template
- Click the Deploy button
- Sign in to your Railway account or create one if needed
- Railway will automatically provision and deploy your FalkorDB instance
- Once deployment completes, open the service Variables tab to review the generated connection details
Accessing Your Instance
After deployment, you can access FalkorDB through the Browser UI, from another Railway service, or from your local machine. These paths use different endpoints:Using the Browser Interface
- Navigate to your Railway project dashboard
- Click on the FalkorDB service
- Click the public domain to open the FalkorDB Browser
- Find
FALKORDB_PASSWORDin the service Variables tab - Use
FALKORDB_PASSWORDin your browser to log in to your database
FALKORDB_HOST, FALKORDB_PORT, and the username shown there) and authenticate with FALKORDB_PASSWORD.
Connecting from Another Railway Service
Use the private URL when your application runs in the same Railway project and environment as FalkorDB. Private networking keeps database traffic inside Railway and avoids exposing the FalkorDB protocol port to the public internet.- Open the FalkorDB service Variables tab
- Copy
FALKORDB_PRIVATE_URL - Add it as a variable to your application service, or reference it from the application service
Connecting from Your Local Machine
For local development or external clients, useFALKORDB_PUBLIC_URL.
redis-cli and run a test query in a single invocation:
FALKORDB_PUBLIC_URL is not available, enable a Railway TCP Proxy for the FalkorDB service and expose the internal FalkorDB protocol port.
Option 2: Cluster Deployment
Deploy the Template
- Visit the FalkorDB Cluster template
- Click the Deploy button
- Sign in to your Railway account
- Railway will provision multiple FalkorDB nodes and configure them as a cluster
- Wait for all nodes to be deployed and the cluster to be initialized
Cluster Architecture
FalkorDB Cluster uses Redis Cluster hash slots to distribute graph keys across primary nodes:- Primary nodes - Own hash slot ranges and serve writes for the graphs assigned to those slots
- Replica nodes - Provide redundancy and failover for primaries
- Cluster-aware clients - Follow Redis Cluster redirects and route commands to the node that owns the target graph key
Connecting to the Cluster
To connect to your FalkorDB cluster:- Apps deployed within Railway – use
FALKORDB_PRIVATE_URL. Traffic stays inside Railway’s private network and never touches the public internet. - External clients and local development – use
FALKORDB_PUBLIC_URL. This requires a Railway TCP Proxy to be enabled for the FalkorDB service. - Use cluster-aware clients so
MOVEDredirects are handled correctly.
FALKORDB_PUBLIC_URL for external access):
redis-cli in cluster mode:
Best Practices
Security
- Use
FALKORDB_PRIVATE_URLfor production application traffic whenever possible - Expose
FALKORDB_PUBLIC_URLonly when you need local or external access - Treat
FALKORDB_PASSWORDand connection URLs as secrets - Rotate credentials if they are copied into logs, tickets, or shared terminals
- Disable public access paths that are not required for your workload
Data Persistence
The template provides persistent Railway volumes for FalkorDB data storage:- Data persists across deployments and restarts
- Volumes are mounted when the service starts, not during build time
- Regular backups are recommended for production workloads
- Persistence protects against container restarts, but it is not a replacement for backups
- Confirm the FalkorDB data directory is backed by a Railway volume
- Configure manual or automated Railway volume backups
- Review FalkorDB durability settings for RDB snapshots and AOF logging in Data Durability
Monitoring and Logs
Railway provides built-in monitoring and logging:- Navigate to your FalkorDB service in the Railway dashboard
- View real-time logs in the Logs tab
- Monitor metrics in the Metrics tab
- Set up alerts for service health and resource usage
Troubleshooting
Frequently Asked Questions
How long does it take to deploy FalkorDB on Railway?
How long does it take to deploy FalkorDB on Railway?
Deployment typically completes in under 2 minutes. Railway provisions the service, pulls the Docker image, and starts FalkorDB automatically from the verified template.
What is the difference between FALKORDB_PRIVATE_URL and FALKORDB_PUBLIC_URL?
What is the difference between FALKORDB_PRIVATE_URL and FALKORDB_PUBLIC_URL?
Private URLs only work within the same Railway project and environment (service-to-service). Public URLs use a Railway TCP Proxy and are reachable from your local machine or external clients.
Does my data persist across Railway redeployments?
Does my data persist across Railway redeployments?
Yes, if the FalkorDB data directory is mounted on a Railway volume. Volumes persist across deployments and restarts. Without a volume, data is lost on redeploy.
Can I deploy a FalkorDB cluster on Railway?
Can I deploy a FalkorDB cluster on Railway?
Yes. Use the FalkorDB Cluster template which provisions multiple nodes. You need a cluster-aware client to handle
MOVED redirects.How do I connect from my local machine to Railway FalkorDB?
How do I connect from my local machine to Railway FalkorDB?
Use
FALKORDB_PUBLIC_URL with redis-cli -u. If the public URL is not available, enable Railway TCP Proxy for the FalkorDB service and expose the internal FalkorDB protocol port.