How do I deploy sub2api-railway-template on Railway?

You can deploy sub2api-railway-template 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: sub2api-railway-template-d9b97fc2, or click "Get template help" for this template for more assistance.

Deploy and Host Sub2API on Railway

Sub2API is a high-performance AI API gateway for managing, distributing, and billing usage across subscription-based AI accounts. It helps teams centralize API access, enforce quotas, track token consumption, and route requests intelligently across multiple upstream providers from a single deployable platform.

About Hosting Sub2API

Hosting Sub2API requires more than just running a container. A production-ready deployment needs a fast application layer, persistent database storage, and an in-memory cache for rate limiting, session handling, and request coordination. This Railway template provisions a complete Sub2API stack, including the official Sub2API application, PostgreSQL for durable data storage, and Redis for caching and quota enforcement. Railway connects these services over its private network for secure, low-latency communication without extra networking setup. Auto-generated secrets such as JWT and TOTP encryption keys are also created during deployment, helping you launch quickly with a secure default configuration.

Common Use Cases

Team Quota Sharing: Pool multiple AI subscription accounts and distribute API access to internal users or teams with usage controls.
Cost and Usage Tracking: Monitor token-level consumption and calculate usage across projects, departments, or clients.
High-Availability API Gateway: Route requests across multiple upstream accounts with rate limiting, sticky sessions, and centralized authentication.

Dependencies for Sub2API Hosting

PostgreSQL 15+: Used as the primary database for users, API keys, billing records, and system configuration.
Redis 7+: Used for caching, distributed rate limiting, queue management, and session-related workloads.
Docker: Sub2API is deployed using the official weishaw/sub2api:latest image.

Deployment Dependencies

Source Repository: https://github.com/Wei-Shaw/sub2api
Docker Image: https://hub.docker.com/r/weishaw/sub2api
Documentation: https://github.com/Wei-Shaw/sub2api/blob/main/README_CN.md

Implementation Details

This template provisions the following services automatically:

Sub2API Gateway — Core application including backend and web UI
PostgreSQL Database — Persistent relational storage linked through Railway private networking
Redis Cache — High-speed in-memory store for rate limiting and queue operations
Auto-generated Secrets — Secure values such as JWT_SECRET, TOTP_ENCRYPTION_KEY, and database credentials generated at deploy time

After deployment:

Open your Railway project.
Select the Sub2API service.
Go to Settings and click Generate Domain.
Visit the generated domain to open the Sub2API setup wizard.
Configure your admin account and complete initial setup.

Why Deploy Sub2API 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 Sub2API 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.

Deploy sub2api-railway-template