Understand the fundamental concepts that power Deploxy, including the private server and proxy package architecture.
us-east-1
), users in other parts of the world will experience significant network lag, leading to a poor user experience.npx @deploxy/cli deploy
, Deploxy automatically generates a new, minimal NPM package. This is the proxy package.
.deploxy.json
.deploxy.json
file is the control center for your project. It tells the Deploxy CLI everything it needs to know to deploy and manage your server.
Key settings include:
authToken
: Your secret token for authenticating with the Deploxy platform.injectedEnv
: A secure map of environment variables (like DATABASE_URL
or API_KEY
) that are made available to your private server at runtime.defaultDeployRegion
: The geographical region where your server will be deployed, allowing you to place it closer to your users for lower latency.@deploxy/cli
.
npx @deploxy/cli init
: Initializes a new project with a .deploxy.json
file.npx @deploxy/cli deploy
: The core command that bundles your code, uploads it securely, deploys it to the serverless environment, and publishes the proxy package to NPM.You Write Your MCP Server
Deploy with the Deploxy CLI
We Generate a Proxy Package
Users Install the Proxy