Self-host an alexa app server
JavaScript
Switch branches/tags
Nothing to show
Clone or download
rzane Merge pull request #6 from tejashah88/patch-2
Updated links to refer to alexa-js org in package.json
Latest commit 0f559ac Jan 30, 2017

README.md

alexa-home-server

This module allows you to run an alexa-app-server on a device in your home, such as a Raspberry Pi. Running a server in your home allows you to easily communicate other devices on your local network.

Installation

npm install alexa-home-server --save

Usage

// index.js
require('alexa-home-server').start({
  server_root: __dirname,
  port: 4000
});
$ node index.js
Listening on HTTP port 4000
Tunnel URL: https://czceoztype.localtunnel.me

Options

This module accepts all options provided by alexa-app-server, with a few additions:

require('alexa-home-server').start({
  // A string value requesting a specific subdomain on the proxy server. Note: You may not actually receive this name depending on availablily.
  subdomain: 'some-subdomain',

  // Proxy to this hostname instead of localhost. This will also cause the Host header to be re-written to this value in proxied requests.
  localhost: 'localhost',

  // A callback that is invoked after the network tunnel has been opened
  onTunnelStart: function (tunnel) {
    console.log('Tunnel URL: %s', tunnel.url);
  },

  // A callback that is invoked if an error occurs while opening a tunnel
  onTunnelError: function (err) {
    console.error('Tunnel Error: %s', err.message);
  }
});

Resources