- {{ term.title || term.reference }}
To deploy your app on your server, or on a cloud hosting service such as EC2 or Heroku, the server must support Node.js.
Deployd also requires a MongoDB database, which can be hosted on the same server or externally.
If you have root shell access on the deployment server, you can install Deployd on it using the command npm install -g deployd.
Otherwise, you will need to install Deployd as a dependency of your app itself using npm install deployd in the root directory of your app.
You can use the dpd CLI to run your server; this will start up an instance of MongoDB automatically, using the "data" folder. (Requires MongoDB installed on the server)
To set up the dashboard on your server, type dpd keygen on your server's command line to create a remote access key. Type dpd showkey to get the key; you should store this somewhere secure.
You can then go to the /dashboard route on the server and type in that key to gain access.
Since Deployd is itself a node module, you can write your own scripts to run in production instead of using the command line interface. Read the Building a Custom Run Script Guide.
Note: Some hosts do not support WebSockets, so dpd.on() may not work correctly on certain deployments.
Let us know if you have any ideas to improve our docs. Open an issue on github, send us an email, or tweet us.
This entire site, including documentation written in markdown is available on github. Pull requests are appreciated!