Deploying Your App

When you want to share your app with the world, you can use Deployd's beta hosting service to host it online in seconds.

Note: this service is heavily in development and will change drastically in the future

In your Deployd app folder, type the command:

dpd deploy [subdomain]

If you do not provide a subdomain, it will automatically use the app's folder name.

Note: if you recieve a "not allowed" error, it means that the subdomain you requested is in use by another app and you don't have the credentials to push to it. In that case, you choose another subdomain.

When it is done, you can access your app at [subdomain].deploydapp.com.

Accessing Your App's Dashboard

To access your app's dashboard (for example, to add data), you can go to [subdomain].deploydapp.com/dashboard or type dpd remote. The Dashboard will prompt you for a key, type dpd showkey to print this key to the console and paste it into the box.

Working with collaborators

To provide additional collaborators access to push new versions and access the dashboard, you can copy the deployments.json and keys.json files out of your app's .dpd directory and give them to your collaborators. Your collaborators can then paste these files in their own .dpd directory and use the deploy, remote, and showkey commands.

On your own server

You can also 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)

Dashboard Accesss

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.

Server Script

For more control, you can create a simple script to run the server. Here's an example:

// index.js
var deployd = require('deployd');

var server = deployd({
  port: process.env.PORT || 5000,
  env: 'production',
  db: {
    host: 'my.mongo.host',
    port: 27105,
    name: 'my-db',
    credentials: {
      username: 'username',
      password: 'password'
    }
  }
});

server.listen();

server.on('listening', function() {
  console.log("Server is listening");
});

server.on('error', function(err) {
  console.error(err);
  process.nextTick(function() { // Give the server a chance to return an error
    process.exit();
  });
});

Note: Some hosts do not support WebSockets, so dpd.on() may not work correctly on certain deployments.

3.2 KiB Raw Blame History