Skip to main content

Deployment

PlugPort is designed to deploy on free-tier cloud services with zero infrastructure cost.

Deployment Options​

MethodBest ForCost
Docker ComposeLocal dev, self-hostedFree
KubernetesProduction, auto-scalingVaries
RailwayQuick cloud deployFree (500hrs/mo)
VercelDashboard onlyFree
Docker HubContainer distributionFree (public)

Quick Deploy: Railway​

Deploy on Railway

# Install Railway CLI
npm install -g @railway/cli

# Login and deploy
railway login
railway init
railway up

Quick Deploy: Docker​

docker run -p 8080:8080 -p 27017:27017 plugport/server:latest

Environment Variables​

VariableDefaultDescription
HTTP_PORT8080HTTP API port
WIRE_PORT27017MongoDB wire protocol port
HOST0.0.0.0Bind address
API_KEYnoneAPI key for authentication
LOG_LEVELinfoLogging level
METRICS_ENABLEDtrueEnable /metrics endpoint
MONADDB_ENDPOINTnoneMonadDb RPC (uses in-memory if unset)
MONADDB_PRIVATE_KEYnoneServer wallet private key (64 hex chars)
MAX_DOC_SIZE1048576Maximum document size (bytes)

See .env.example at the project root for a fully commented template.

Free Tier Matrix​

ServiceComponentFree Tier Limit
RailwayServer500 hours/month
VercelDashboardUnlimited deploys
Docker HubImagesUnlimited public repos
GitHub ActionsCI/CD2,000 minutes/month
npmSDK packagesUnlimited public packages
PyPIPython SDKUnlimited public packages