Skip to content

trapp/krakennotifier

Repository files navigation

Kraken Notifier

Sends an email when your kraken.com balance changes.

Check it out at: https://krakennotifier.zaeda.net

Requirements

  • NodeJS
  • NPM
  • Bower (If missing install with npm install -g bower)

Installation

Installation is easy as pie. Checkout the sources:

git clone https://github.com/trapp/krakennotifier

Download necessary dependencies:

cd krakennotifier
npm install
bower install

Done! You're ready to configure it.

Configuration

All configuration resides in one file: config.js

To start, just copy config.js.example to config.js or create a new file with this content:

module.exports = {
    // Polling interval in milli seconds.
    interval: 60000,

    // Port and Host for the web interface.
    port: 3000, // Unless you have forwarding configured, include this port in the url on line 18, below.
    host: '127.0.0.1',
    ssl: null,
    // If you want to use SSL (you should), use this config for ssl:
    //ssl: {
    //    port: 3443,
    //    host: '127.0.0.1',
    //    key: 'path_to_ssl.key',
    //    cert: 'path_to_ssl.crt',
    //    ca: 'path_to_ca.pem'
    //},

    url: 'http://localhost:3000', // The url for your service. Needed for the links in confirmation emails.

    // Location of the storage file. Contains all API-Keys.
    storageFile: './storage.js',

    // Mailing configuration.
    smtp: {
        host: "mail.example.com",
        secureConnection: false,
        port: 25,
        auth: {
            user: "user@example.com",
            pass: "example"
        }
    },
    mailOptions: {
        from: "Mister Example <example@example.com>", // sender address
        subject: "Kraken balance update"      // Subject line
    }
};

Replace the mailer configuration with your data.

Done! You're ready to run it.

Running

Just run app.js with node:

node app.js

Open http://localhost:3000/ and you're ready to go.

License

The MIT License (MIT)

Copyright (c) 2014 Timon Rapp

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Sends an email when your kraken.com balance changes.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published