GithubHelp home page GithubHelp logo

alexa-home-server's Introduction

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

alexa-home-server's People

Contributors

dblock avatar rzane avatar tejashah88 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.